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.

{{< alert type=”warning” >}}

Fields that are deprecated are marked with {{< icon name=”warning-solid” >}}. Items (fields, enums, etc) that have been removed according to our deprecation process can be found in Removed Items.

{{< /alert >}}

Query type

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

Query.abuseReport

Find an abuse report.

{{< details >}} Introduced in GitLab 16.3. Status: Experiment. {{< /details >}}

Returns AbuseReport.

Arguments

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

Query.abuseReportLabels

Abuse report labels.

{{< details >}} Introduced in GitLab 16.3. Status: Experiment. {{< /details >}}

Returns AbuseReportLabelConnection.

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

Arguments

Name Type Description
searchTerm String Search term to find labels with.

Query.addOnPurchases

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

Returns [AddOnPurchase!].

Arguments

Name Type Description
namespaceId NamespaceID ID 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.

{{< details >}} Introduced in GitLab 17.10. Status: Experiment. {{< /details >}}

Returns AdminMemberRole.

Arguments

Name Type Description
id MemberRoleID Global ID of the member role to look up.
ids [MemberRoleID!] Global IDs of the member role to look up.
orderBy MemberRolesOrderBy Ordering column. Default is NAME.
sort SortDirectionEnum Ordering column. Default is ASC.

Query.adminMemberRolePermissions

List of all admin customizable permissions.

{{< details >}} Introduced in GitLab 17.9. Status: Experiment. {{< /details >}}

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.

{{< details >}} Introduced in GitLab 17.10. Status: Experiment. {{< /details >}}

Returns AdminMemberRoleConnection.

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

Arguments

Name Type Description
id MemberRoleID Global ID of the member role to look up.
ids [MemberRoleID!] Global IDs of the member role to look up.
orderBy MemberRolesOrderBy Ordering column. Default is NAME.
sort SortDirectionEnum Ordering column. Default is ASC.

Query.aiChatContextPresets

Get available GitLab Duo Chat context presets for the current user for a specific URL.

Returns ContextPreset.

Arguments

Name Type Description
projectId ProjectID Global ID of the project the user is acting on.
questionCount Int Number of questions for the default screen.
resourceId AiModelID Global ID of the resource from the current page.
url String URL of the page the user is currently on.

Query.aiConversationThreads

List conversation threads of AI features.

{{< details >}} Introduced in GitLab 17.9. Status: Experiment. {{< /details >}}

Returns AiConversationsThreadConnection!.

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

Arguments

Name Type Description
conversationType AiConversationsThreadsConversationType Conversation type of the thread.
id AiConversationThreadID Id of the thread.

Query.aiFeatureSettings

List of configurable AI features.

{{< details >}} Introduced in GitLab 17.4. Status: Experiment. {{< /details >}}

Returns AiFeatureSettingConnection.

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

Arguments

Name Type Description
selfHostedModelId AiSelfHostedModelID Global ID of the self-hosted model.

Query.aiMessages

Find GitLab Duo Chat messages.

{{< details >}} Introduced in GitLab 16.1. Status: Experiment. {{< /details >}}

Returns AiMessageConnection!.

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

Arguments

Name Type Description
agentVersionId AiAgentVersionID Global ID of the agent to answer the chat.
conversationType AiConversationsThreadsConversationType Conversation type of the thread.
requestIds [ID!] Array of request IDs to fetch.
roles [AiMessageRole!] Array of roles to fetch.
threadId AiConversationThreadID Global 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.

{{< details >}} Introduced in GitLab 17.1. Status: Experiment. {{< /details >}}

Returns AiSelfHostedModelConnection.

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

Arguments

Name Type Description
id AiSelfHostedModelID Global ID of a self-hosted model.

Query.aiSlashCommands

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

Returns [SlashCommand!].

Arguments

Name Type Description
url String! 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.

{{< details >}} Introduced in GitLab 16.11. Status: Experiment. {{< /details >}}

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.

{{< details >}} Introduced in GitLab 17.2. Status: Experiment. {{< /details >}}

Returns BlobSearch.

Arguments

Name Type Description
chunkCount {{< icon name=”warning-solid” >}} Int Introduced in GitLab 17.2. Status: Experiment. Maximum chunks per file.
excludeForks {{< icon name=”warning-solid” >}} Boolean Introduced in GitLab 17.11. Status: Experiment. Excludes forked projects in the search. Always false for project search.
groupId {{< icon name=”warning-solid” >}} GroupID Introduced in GitLab 17.2. Status: Experiment. Group to search in.
includeArchived {{< icon name=”warning-solid” >}} Boolean Introduced in GitLab 17.7. Status: Experiment. Includes archived projects in the search. Always true for project search. Default is false.
includeForked {{< icon name=”warning-solid” >}} Boolean Introduced in GitLab 17.7. Status: Experiment. Includes forked projects in the search. Always true for project search. Not available for global search.
page {{< icon name=”warning-solid” >}} Int Introduced in GitLab 17.2. Status: Experiment. Page number to fetch the results.
perPage {{< icon name=”warning-solid” >}} Int Introduced in GitLab 17.2. Status: Experiment. Number of results per page.
projectId {{< icon name=”warning-solid” >}} ProjectID Introduced in GitLab 17.2. Status: Experiment. Project to search in.
regex {{< icon name=”warning-solid” >}} Boolean Introduced in GitLab 17.3. Status: Experiment. Uses the regular expression search mode. Default is false.
repositoryRef {{< icon name=”warning-solid” >}} String Introduced in GitLab 17.2. Status: Experiment. Repository reference to search in.
search String! Searched term.

Query.boardList

Find an issue board list.

Returns BoardList.

Arguments

Name Type Description
id ListID! Global ID of the list.
issueFilters BoardIssueInput Filters applied when getting issue metadata in the board list.

Query.ciApplicationSettings

CI related settings that apply to the entire instance.

Returns CiApplicationSettings.

Query.ciCatalogResource

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

{{< details >}} Introduced in GitLab 16.1. Status: Experiment. {{< /details >}}

Returns CiCatalogResource.

Arguments

Name Type Description
fullPath ID CI/CD Catalog resource full path.
id CiCatalogResourceID CI/CD Catalog resource global ID.

Query.ciCatalogResources

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

{{< details >}} Introduced in GitLab 15.11. Status: Experiment. {{< /details >}}

Returns CiCatalogResourceConnection.

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

Arguments

Name Type Description
scope CiCatalogResourceScope Scope of the returned catalog resources.
search String Search term to filter the catalog resources by name or description.
sort CiCatalogResourceSort Sort catalog resources by given criteria.
topics [String!] Filter catalog resources by project topic names.
verificationLevel CiCatalogResourceVerificationLevel Filter 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

Name Type Description
content String! Contents of .gitlab-ci.yml.
dryRun Boolean Run pipeline creation simulation, or only do static check.
projectPath ID! Project of the CI config.
sha String Sha for the pipeline.
skipVerifyProjectSha {{< icon name=”warning-solid” >}} Boolean Introduced 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.ciDedicatedHostedRunnerFilters

Returns available filters for GitLab Dedicated runner usage data.

Returns CiDedicatedHostedRunnerFilters.

Query.ciDedicatedHostedRunnerUsage

Compute usage data for runners across namespaces on GitLab Dedicated. Defaults to the current year if no year or billing month is specified. Ultimate only.

Returns CiDedicatedHostedRunnerUsageConnection.

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

Arguments

Name Type Description
billingMonth Date First day of the month to retrieve data for.
grouping GroupingEnum Groups usage data by instance aggregate or root namespace.
runnerId CiRunnerID Runner ID to retrieve data for.
year Int Year to retrieve data for.

Query.ciMinutesUsage

Compute usage data for a namespace.

Returns CiMinutesNamespaceMonthlyUsageConnection.

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

Arguments

Name Type Description
date Date Date for which to retrieve the usage data, should be the first day of a month.
namespaceId NamespaceID Global ID of the Namespace for the monthly compute usage.

Query.ciPipelineStage

Stage belonging to a CI pipeline.

Returns CiStage.

Arguments

Name Type Description
id CiStageID! Global ID of the CI stage.

Query.ciQueueingHistory

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

{{< details >}} Introduced in GitLab 16.4. Status: Experiment. {{< /details >}}

Returns QueueingDelayHistory.

Arguments

Name Type Description
fromTime Time Start of the requested time. Defaults to three hours ago.
runnerType CiRunnerType Filter jobs by the type of runner that executed them.
toTime Time End 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

Name Type Description
sort CiVariableSort Sort order of results.

Query.cloudConnectorStatus

Run a series of status checks for Cloud Connector features.

{{< details >}} Introduced in GitLab 17.3. Status: Experiment. {{< /details >}}

Returns CloudConnectorStatus.

Query.complianceRequirementControls

Get the list of all the compliance requirement controls.

Returns ComplianceRequirementControl.

Query.containerRepository

Find a container repository.

Returns ContainerRepositoryDetails.

Arguments

Name Type Description
id ContainerRepositoryID! Global ID of the container repository.

Query.currentLicense

Fields related to the current license.

Returns CurrentLicense.

Query.currentUser

Get information about current user.

Returns CurrentUser.

Query.customField

Find a custom field by its ID.

{{< details >}} Introduced in GitLab 17.10. Status: Experiment. {{< /details >}}

Returns CustomField.

Arguments

Name Type Description
id IssuablesCustomFieldID! Global ID of the custom field.

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

Name Type Description
displayNamespaceId NamespaceID Filter by display namespace.

Query.duoSettings

Get GitLab Duo settings.

{{< details >}} Introduced in GitLab 17.9. Status: Experiment. {{< /details >}}

Returns DuoSettings.

Query.duoWorkflowEvents

List the events for a Duo Workflow.

{{< details >}} Introduced in GitLab 17.2. Status: Experiment. {{< /details >}}

Returns DuoWorkflowEventConnection!.

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

Arguments

Name Type Description
workflowId AiDuoWorkflowsWorkflowID! Array of request IDs to fetch.

Query.duoWorkflowWorkflows

List the workflows owned by the current user.

{{< details >}} Introduced in GitLab 17.2. Status: Experiment. {{< /details >}}

Returns DuoWorkflowConnection!.

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

Arguments

Name Type Description
projectPath ID Full path of the project containing the workflows.

Query.echo

Testing endpoint to validate the API with.

Returns String!.

Arguments

Name Type Description
text String! Text to echo back.

Query.epicBoardList

Returns EpicList.

Arguments

Name Type Description
epicFilters EpicFilters Filters applied when getting epic metadata in the epic board list.
id BoardsEpicListID! Global ID of the list.

Query.featureFlagEnabled

Check if a feature flag is enabled.

{{< details >}} Deprecated in GitLab 17.4. Replaced with metadata.featureFlags. {{< /details >}}

Returns Boolean!.

Arguments

Name Type Description
name String! 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

Name Type Description
name String Name of the Geo node. Defaults to the current Geo node name.

Query.gitpodEnabled

Whether Gitpod is enabled in application settings.

Returns Boolean.

Query.googleCloudArtifactRegistryRepositoryArtifact

Details about an artifact in the Google Artifact Registry.

{{< details >}} Introduced in GitLab 16.10. Status: Experiment. {{< /details >}}

Returns GoogleCloudArtifactRegistryArtifactDetails.

Arguments

Name Type Description
googleCloudProjectId String! ID of the Google Cloud project.
image String! Name of the image in the Google Artifact Registry.
location String! Location of the Artifact Registry repository.
projectPath ID! Full project path.
repository String! Repository on the Google Artifact Registry.

Query.group

Find a group.

Returns Group.

Arguments

Name Type Description
fullPath ID! 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

Name Type Description
allAvailable Boolean When true, returns all accessible groups. When false, returns only groups where the user is a member. Unauthenticated requests always return all public groups. The owned_only argument takes precedence.
ids [ID!] Filter groups by IDs.
markedForDeletionOn Date Date when the group was marked for deletion.
ownedOnly Boolean Only include groups where the current user has an owner role.
parentPath ID Full path of the parent group.
search String Search query for group name or group full path.
sort String Sort order of results. Format: <field_name>_<sort_direction>, for example: id_desc or name_asc.
topLevelOnly Boolean Only 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

{{< details >}} Introduced in GitLab 17.0. Status: Experiment. {{< /details >}}

Returns IntegrationExclusionConnection.

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

Arguments

Name Type Description
integrationName IntegrationType! Type of integration.

Query.issue

Find an issue.

Returns Issue.

Arguments

Name Type Description
id IssueID! Global ID of the issue.

Query.issues

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

{{< details >}} Introduced in GitLab 15.6. Status: Experiment. {{< /details >}}

Returns IssueConnection.

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

Arguments

Name Type Description
assigneeId String ID of a user assigned to the issues. Wildcard values “NONE” and “ANY” are supported.
assigneeUsername {{< icon name=”warning-solid” >}} String Deprecated in GitLab 13.11. Use assigneeUsernames.
assigneeUsernames [String!] Usernames of users assigned to the issue.
assigneeWildcardId AssigneeWildcardId Filter by assignee wildcard. Incompatible with assigneeUsername and assigneeUsernames.
authorUsername String Username of the author of the issue.
closedAfter Time Issues closed after the date.
closedBefore Time Issues closed before the date.
confidential Boolean Filter for confidential issues. If “false”, excludes confidential issues. If “true”, returns only confidential issues.
createdAfter Time Issues created after the date.
createdBefore Time Issues created before the date.
crmContactId String ID of a contact assigned to the issues.
crmOrganizationId String ID of an organization assigned to the issues.
customField {{< icon name=”warning-solid” >}} [WorkItemWidgetCustomFieldFilterInputType!] Introduced in GitLab 17.10. Status: Experiment. Filter by custom fields.
dueAfter Time Return issues due on or after the given time.
dueBefore Time Return issues due on or before the given time.
epicId String ID of an epic associated with the issues, “none” and “any” values are supported.
epicWildcardId EpicWildcardId Filter by epic ID wildcard. Incompatible with epicId.
healthStatusFilter HealthStatusFilter Health status of the issue, “none” and “any” values are supported.
iid String IID of the issue. For example, “1”.
iids [String!] List of IIDs of issues. For example, ["1", "2"].
in [IssuableSearchableField!] Specify the fields to perform the search in. Defaults to [TITLE, DESCRIPTION]. Requires the search argument.’.
includeArchived Boolean Whether to include issues from archived projects. Defaults to false.
includeSubepics Boolean Whether to include subepics when filtering issues by epicId.
iterationCadenceId [IterationsCadenceID!] Filter by a list of iteration cadence IDs.
iterationId [ID] List of iteration Global IDs applied to the issue.
iterationTitle String Filter by iteration title.
iterationWildcardId IterationWildcardId Filter by iteration ID wildcard.
labelName [String] Labels applied to the issue.
milestoneTitle [String] Milestone applied to the issue.
milestoneWildcardId MilestoneWildcardId Filter issues by milestone ID wildcard.
myReactionEmoji String Filter by reaction emoji applied by the current user. Wildcard values “NONE” and “ANY” are supported.
not NegatedIssueFilterInput Negated arguments.
or UnionedIssueFilterInput List of arguments with inclusive OR.
search String Search query for title or description.
sort IssueSort Sort issues by the criteria.
state IssuableState Current state of the issue.
subscribed SubscriptionStatus Issues the current user is subscribed to.
types [IssueType!] Filter issues by the given issue types.
updatedAfter Time Issues updated after the date.
updatedBefore Time Issues updated before the date.
weight String Weight applied to the issue, “none” and “any” values are supported.
weightWildcardId WeightWildcardId Filter by weight ID wildcard. Incompatible with weight.

Query.iteration

Find an iteration.

Returns Iteration.

Arguments

Name Type Description
id IterationID! Find an iteration by its ID.

Query.jobs

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

Returns CiJobInterfaceConnection.

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

Arguments

Name Type Description
failureReason {{< icon name=”warning-solid” >}} CiJobFailureReason Introduced in GitLab 16.4. Status: Experiment. Filter jobs by failure reason. Currently only RUNNER_SYSTEM_FAILURE together with runnerTypes: INSTANCE_TYPE is supported.
runnerTypes {{< icon name=”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.

LDAP admin links. Available only for GitLab Self-Managed.

{{< details >}} Introduced in GitLab 17.11. Status: Experiment. {{< /details >}}

Returns LdapAdminRoleLinkConnection.

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

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.

{{< details >}} Introduced in GitLab 16.6. Status: Experiment. {{< /details >}}

Returns MemberRole.

Arguments

Name Type Description
id MemberRoleID Global ID of the member role to look up.
ids [MemberRoleID!] Global IDs of the member role to look up.
orderBy MemberRolesOrderBy Ordering column. Default is NAME.
sort SortDirectionEnum Ordering column. Default is ASC.

Query.memberRolePermissions

List of all standard customizable permissions.

{{< details >}} Introduced in GitLab 16.4. Status: Experiment. {{< /details >}}

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.

{{< details >}} Introduced in GitLab 16.7. Status: Experiment. {{< /details >}}

Returns MemberRoleConnection.

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

Arguments

Name Type Description
id MemberRoleID Global ID of the member role to look up.
ids [MemberRoleID!] Global IDs of the member role to look up.
orderBy MemberRolesOrderBy Ordering column. Default is NAME.
sort SortDirectionEnum Ordering column. Default is ASC.

Query.mergeRequest

Find a merge request.

Returns MergeRequest.

Arguments

Name Type Description
id MergeRequestID! Global ID of the merge request.

Query.metadata

Metadata about GitLab.

Returns Metadata.

Query.milestone

Find a milestone.

Returns Milestone.

Arguments

Name Type Description
id MilestoneID! Find a milestone by its ID.

Query.mlExperiment

Find a machine learning experiment.

Returns MlExperiment.

Arguments

Name Type Description
id MlExperimentID! ID of the experiment.

Query.mlModel

Find machine learning models.

{{< details >}} Introduced in GitLab 16.7. Status: Experiment. {{< /details >}}

Returns MlModel.

Arguments

Name Type Description
id MlModelID! ID of the model.

Query.namespace

Find a namespace.

Returns Namespace.

Arguments

Name Type Description
fullPath ID! Full path of the namespace. For example, gitlab-org/gitlab-foss.

Query.note

Find a note.

{{< details >}} Introduced in GitLab 15.9. Status: Experiment. {{< /details >}}

Returns Note.

Arguments

Name Type Description
id NoteID! Global ID of the note.

Query.organization

Find an organization.

{{< details >}} Introduced in GitLab 16.4. Status: Experiment. {{< /details >}}

Returns Organization.

Arguments

Name Type Description
id OrganizationsOrganizationID! ID of the organization.

Query.organizations

List organizations.

{{< details >}} Introduced in GitLab 16.8. Status: Experiment. {{< /details >}}

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

Name Type Description
id PackagesPackageID! Global ID of the package.

Query.project

Find a project.

Returns Project.

Arguments

Name Type Description
fullPath ID! Full path of the project. For example, gitlab-org/gitlab-foss.

Query.projectSecret

View a specific project secret.

{{< details >}} Introduced in GitLab 17.9. Status: Experiment. {{< /details >}}

Returns ProjectSecret.

Arguments

Name Type Description
name String! Name of the project secret to view.
projectPath ID! Project the secrets belong to.

Query.projectSecrets

List project secrets.

{{< details >}} Introduced in GitLab 17.8. Status: Experiment. {{< /details >}}

Returns ProjectSecretConnection.

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

Arguments

Name Type Description
projectPath ID! Project the secrets belong to.

Query.projectSecretsManager

Find a project secrets manager.

{{< details >}} Introduced in GitLab 17.4. Status: Experiment. {{< /details >}}

Returns ProjectSecretsManager.

Arguments

Name Type Description
projectPath ID! 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

Name Type Description
aimedForDeletion Boolean Return only projects marked for deletion.
archived ProjectArchived Filter 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.
includeHidden Boolean Include hidden projects.
markedForDeletionOn Date Date when the project was marked for deletion.
membership Boolean Return only projects that the current user is a member of.
minAccessLevel AccessLevelEnum Return only projects where current user has at least the specified access level.
notAimedForDeletion Boolean Exclude projects that are marked for deletion.
personal Boolean Return only personal projects.
programmingLanguageName String Filter projects by programming language name (case insensitive). For example: “css” or “ruby”.
search String Search query, which can be for the project name, a path, or a description.
searchNamespaces Boolean Include namespace in project search.
sort String Sort order of results. Format: <field_name>_<sort_direction>, for example: id_desc or name_asc.
topics [String!] Filter projects by topics.
trending Boolean Return only projects that are trending.
withIssuesEnabled Boolean Return only projects with issues enabled.
withMergeRequestsEnabled Boolean Return only projects with merge requests enabled.

Query.queryComplexity

Information about the complexity of the GraphQL query.

Returns QueryComplexity.

Query.runner

Find a runner.

Returns CiRunner.

Arguments

Name Type Description
id CiRunnerID! Runner ID.

Query.runnerPlatforms

Supported runner platforms.

{{< details >}} Deprecated in GitLab 15.9. No longer used, use gitlab-runner documentation to learn about supported platforms. {{< /details >}}

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.

{{< details >}} Deprecated in GitLab 15.9. No longer used, use gitlab-runner documentation to learn about runner registration commands. {{< /details >}}

Returns RunnerSetup.

Arguments

Name Type Description
architecture String! Architecture to generate the instructions for.
groupId {{< icon name=”warning-solid” >}} GroupID Deprecated in GitLab 13.11. No longer used.
platform String! Platform to generate the instructions for.
projectId {{< icon name=”warning-solid” >}} ProjectID Deprecated 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

Name Type Description
fromDate Date Start of the requested date frame. Defaults to the start of the previous calendar month.
fullPath ID Filter 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.
runnerType CiRunnerType Filter runners by the type.
runnersLimit Int Maximum number of runners to return. Other runners will be aggregated to a runner: null entry. Defaults to 5 if unspecified. Maximum of 500.
toDate Date End 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

Name Type Description
fromDate Date Start of the requested date frame. Defaults to the start of the previous calendar month.
fullPath ID Filter 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.
projectsLimit Int Maximum number of projects to return. Other projects will be aggregated to a project: null entry. Defaults to 5 if unspecified. Maximum of 500.
runnerType CiRunnerType Filter jobs by the type of runner that executed them.
toDate Date End 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

Name Type Description
active {{< icon name=”warning-solid” >}} Boolean Deprecated in GitLab 14.8. This was renamed. Use: paused.
creatorId UserID Filter runners by creator ID.
creatorUsername {{< icon name=”warning-solid” >}} String Introduced in GitLab 16.7. Status: Experiment. Filter runners by creator username.
ownerFullPath {{< icon name=”warning-solid” >}} String Introduced in GitLab 17.8. Status: Experiment. Filter runners by owning project or group.
paused Boolean Filter runners by paused (true) or active (false) status.
search String Filter by full token or partial text in description field.
sort CiRunnerSort Sort order of results.
status CiRunnerStatus Filter runners by status.
tagList [String!] Filter by tags associated with the runner (comma-separated or array).
type CiRunnerType Filter runners by type.
upgradeStatus CiRunnerUpgradeStatus Filter by upgrade status.
versionPrefix {{< icon name=”warning-solid” >}} String Introduced 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.secretPermissions

List secret permissions.

{{< details >}} Introduced in GitLab 17.10. Status: Experiment. {{< /details >}}

Returns SecretPermissionConnection.

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

Arguments

Name Type Description
projectPath ID! Project the secret permission belong to.

Query.selfManagedAddOnEligibleUsers

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

{{< details >}} Introduced in GitLab 16.7. Status: Experiment. {{< /details >}}

Returns AddOnUserConnection.

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

Arguments

Name Type Description
addOnPurchaseIds [GitlabSubscriptionsAddOnPurchaseID!]! Global IDs of the add on purchases to find assignments for.
addOnType GitlabSubscriptionsAddOnType! Type of add on to filter the eligible users by.
filterByAssignedSeat String Filter users list by assigned seat.
search String Search the user list.
sort GitlabSubscriptionsUserSort Sort the user list.

Query.selfManagedUsersQueuedForRolePromotion

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

{{< details >}} Introduced in GitLab 17.1. Status: Experiment. {{< /details >}}

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

Name Type Description
authorId UserID ID of an author.
explore Boolean Explore personal snippets.
ids [SnippetID!] Array of global snippet IDs. For example, gid://gitlab/ProjectSnippet/1.
projectId ProjectID ID of a project.
type TypeEnum Type of snippet.
visibility VisibilityScopesEnum Visibility of the snippet.

Query.standardRole

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

{{< details >}} Introduced in GitLab 17.6. Status: Experiment. {{< /details >}}

Returns StandardRole.

Arguments

Name Type Description
accessLevel [MemberAccessLevel!] Access level or levels to filter by.

Query.standardRoles

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

{{< details >}} Introduced in GitLab 17.3. Status: Experiment. {{< /details >}}

Returns StandardRoleConnection.

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

Arguments

Name Type Description
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.

{{< details >}} Introduced in GitLab 15.9. Status: Experiment. {{< /details >}}

Returns Note.

Arguments

Name Type Description
noteableId NoteableID! Global ID of the resource to search synthetic note on.
sha String! Global ID of the note.

Query.timelogs

Find timelogs visible to the current user.

Returns TimelogConnection.

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

Arguments

Name Type Description
endDate Time List timelogs within a date range where the logged date is equal to or before endDate.
endTime Time List timelogs within a time range where the logged time is equal to or before endTime.
groupId GroupID List timelogs for a group.
projectId ProjectID List timelogs for a project.
sort TimelogSort List timelogs in a particular order.
startDate Time List timelogs within a date range where the logged date is equal to or after startDate.
startTime Time List timelogs within a time range where the logged time is equal to or after startTime.
username String List timelogs for a user.

Query.todo

Retrieve a single to-do item.

Returns Todo.

Arguments

Name Type Description
id TodoID! ID of the to-do item.

Query.topics

Find project topics.

Returns TopicConnection.

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

Arguments

Name Type Description
organizationId {{< icon name=”warning-solid” >}} OrganizationsOrganizationID Introduced in GitLab 17.7. Status: Experiment. Global ID of the organization.
search String Search query for topic name.

Query.usageTrendsMeasurements

Get statistics on the instance.

Returns UsageTrendsMeasurementConnection.

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

Arguments

Name Type Description
identifier MeasurementIdentifier! Type of measurement or statistics to retrieve.
recordedAfter Time Measurement recorded after the date.
recordedBefore Time Measurement recorded before the date.

Query.user

Find a user.

Returns UserCore.

Arguments

Name Type Description
id UserID ID of the User.
username String Username of the User.

Query.users

Find users.

Returns UserCoreConnection.

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

Arguments

Name Type Description
active Boolean Filter by active users. When true, returns active users. When false, returns non-active users.
admins Boolean Return only admin users.
groupId GroupID Return users member of a given group.
humans Boolean Filter 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.
search String Query to search users by name, username, or primary email.
sort Sort Sort 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

Name Type Description
clusterAgentId [ClustersAgentID!] Filter vulnerabilities by cluster_agent_id. Vulnerabilities with a reportType of cluster_image_scanning are only included with this filter.
clusterId [ClustersClusterID!] Filter vulnerabilities by cluster_id. Vulnerabilities with a reportType of cluster_image_scanning are only included with this filter.
dismissalReason [VulnerabilityDismissalReason!] Filter by dismissal reason. Only dismissed Vulnerabilities will be included with the filter.
hasAiResolution {{< icon name=”warning-solid” >}} Boolean Introduced 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.
hasIssues Boolean Returns only the vulnerabilities which have linked issues.
hasMergeRequest Boolean Returns only the vulnerabilities which have linked merge requests.
hasRemediations Boolean Returns only the vulnerabilities which have remediations.
hasResolution Boolean Returns only the vulnerabilities which have been resolved on default branch.
identifierName String Filter vulnerabilities by identifier name. Ignored when applied on instance security dashboard queries.
image [String!] Filter vulnerabilities by location image. When this filter is present, the response only matches entries for a reportType that includes container_scanning, cluster_image_scanning.
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.
sort VulnerabilitySort List vulnerabilities by sort order.
state [VulnerabilityState!] Filter vulnerabilities by state.

Query.vulnerabilitiesCountByDay

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

Returns VulnerabilitiesCountByDayConnection.

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

Arguments

Name Type Description
endDate ISO8601Date! Last day for which to fetch vulnerability history.
startDate ISO8601Date! First day for which to fetch vulnerability history.

Query.vulnerability

Find a vulnerability.

Returns Vulnerability.

Arguments

Name Type Description
id VulnerabilityID! Global ID of the Vulnerability.

Query.wikiPage

Find a wiki page.

{{< details >}} Introduced in GitLab 17.6. Status: Experiment. {{< /details >}}

Returns WikiPage.

Arguments

Name Type Description
namespaceId NamespaceID Wiki page namespace ID.
projectId ProjectID Wiki page project ID.
slug String Wiki page slug.

Query.workItem

Find a work item.

{{< details >}} Introduced in GitLab 15.1. Status: Experiment. {{< /details >}}

Returns WorkItem.

Arguments

Name Type Description
id WorkItemID! Global ID of the work item.

Query.workItemDescriptionTemplateContent

Find a work item description template.

{{< details >}} Introduced in GitLab 17.9. Status: Experiment. {{< /details >}}

Returns WorkItemDescriptionTemplate.

Arguments

Name Type Description
templateContentInput WorkItemDescriptionTemplateContentInput! Input for fetching a specific description template.

Query.workItemsByReference

Find work items by their reference.

{{< details >}} Introduced in GitLab 16.7. Status: Experiment. {{< /details >}}

Returns WorkItemConnection.

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

Arguments

Name Type Description
contextNamespacePath ID Full path of the context namespace (project or group).
refs [String!]! Work item references. Can be either a short reference or URL.

Query.workspace

Find a workspace.

Returns Workspace.

Arguments

Name Type Description
id RemoteDevelopmentWorkspaceID! Find a workspace by its ID.

Query.workspaces

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

Returns WorkspaceConnection.

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

Arguments

Name Type Description
actualStates [String!] Filter workspaces by actual states.
agentIds [ClustersAgentID!] Filter workspaces by agent GlobalIDs.
ids [RemoteDevelopmentWorkspaceID!] Filter workspaces by workspace GlobalIDs. For example, ["gid://gitlab/RemoteDevelopment::Workspace/1"].
includeActualStates {{< icon name=”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

{{< details >}} Introduced in GitLab 16.4. Status: Experiment. {{< /details >}}

Input type: AbuseReportLabelCreateInput

Arguments

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
color String The color of the label given in 6-digit hex notation with leading ‘#’ sign (for example, #FFAABB) or one of the CSS color names.
title String! Title of the label.

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.
label AbuseReportLabel Label after mutation.

Mutation.achievementsAward

{{< details >}} Introduced in GitLab 15.10. Status: Experiment. {{< /details >}}

Input type: AchievementsAwardInput

Arguments

Name Type Description
achievementId AchievementsAchievementID! Global ID of the achievement being awarded.
clientMutationId String A unique identifier for the client performing the mutation.
userId UserID! Global ID of the user being awarded the achievement.

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.
userAchievement UserAchievement Achievement award.

Mutation.achievementsCreate

{{< details >}} Introduced in GitLab 15.8. Status: Experiment. {{< /details >}}

Input type: AchievementsCreateInput

Arguments

Name Type Description
avatar Upload Avatar for the achievement.
clientMutationId String A unique identifier for the client performing the mutation.
description String Description of or notes for the achievement.
name String! Name for the achievement.
namespaceId NamespaceID! Namespace for the achievement.

Fields

Name Type Description
achievement Achievement Achievement created.
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.

Mutation.achievementsDelete

{{< details >}} Introduced in GitLab 15.11. Status: Experiment. {{< /details >}}

Input type: AchievementsDeleteInput

Arguments

Name Type Description
achievementId AchievementsAchievementID! Global ID of the achievement being deleted.
clientMutationId String A unique identifier for the client performing the mutation.

Fields

Name Type Description
achievement Achievement Achievement.
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.

Mutation.achievementsRevoke

{{< details >}} Introduced in GitLab 15.10. Status: Experiment. {{< /details >}}

Input type: AchievementsRevokeInput

Arguments

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
userAchievementId AchievementsUserAchievementID! Global ID of the user achievement being revoked.

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.
userAchievement UserAchievement Achievement award.

Mutation.achievementsUpdate

{{< details >}} Introduced in GitLab 15.11. Status: Experiment. {{< /details >}}

Input type: AchievementsUpdateInput

Arguments

Name Type Description
achievementId AchievementsAchievementID! Global ID of the achievement being updated.
avatar Upload Avatar for the achievement.
clientMutationId String A unique identifier for the client performing the mutation.
description String Description of or notes for the achievement.
name String Name for the achievement.

Fields

Name Type Description
achievement Achievement Achievement.
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.

Mutation.addProjectToSecurityDashboard

Input type: AddProjectToSecurityDashboardInput

Arguments

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
id ProjectID! ID of the project to be added to Instance Security Dashboard.

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.
project Project Project that was added to the Instance Security Dashboard.

Mutation.adminRolesLdapSync

{{< details >}} Introduced in GitLab 18.0. Status: Experiment. {{< /details >}}

Input type: AdminRolesLdapSyncInput

Arguments

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!] Errors encountered during operation.
success Boolean Whether the sync was successfully enqueued.

Mutation.adminSidekiqQueuesDeleteJobs

Input type: AdminSidekiqQueuesDeleteJobsInput

Arguments

Name Type Description
aiResource String Delete jobs matching ai_resource in the context metadata.
artifactSize String Delete jobs matching artifact_size in the context metadata.
artifactUsedCdn String Delete jobs matching artifact_used_cdn in the context metadata.
artifactsDependenciesCount String Delete jobs matching artifacts_dependencies_count in the context metadata.
artifactsDependenciesSize String Delete jobs matching artifacts_dependencies_size in the context metadata.
bulkImportEntityId String Delete jobs matching bulk_import_entity_id in the context metadata.
callerId String Delete jobs matching caller_id in the context metadata.
clientId String Delete jobs matching client_id in the context metadata.
clientMutationId String A unique identifier for the client performing the mutation.
featureCategory String Delete jobs matching feature_category in the context metadata.
jobId String Delete jobs matching job_id in the context metadata.
mergeActionStatus String Delete jobs matching merge_action_status in the context metadata.
organizationId String Delete jobs matching organization_id in the context metadata.
pipelineId String Delete jobs matching pipeline_id in the context metadata.
project String Delete jobs matching project in the context metadata.
queueName String! Name of the queue to delete jobs from.
relatedClass String Delete jobs matching related_class in the context metadata.
remoteIp String Delete jobs matching remote_ip in the context metadata.
rootCallerId String Delete jobs matching root_caller_id in the context metadata.
rootNamespace String Delete jobs matching root_namespace in the context metadata.
scopedUser String Delete jobs matching scoped_user in the context metadata.
scopedUserId String Delete jobs matching scoped_user_id in the context metadata.
sidekiqDestinationShardRedis String Delete jobs matching sidekiq_destination_shard_redis in the context metadata.
subscriptionPlan String Delete jobs matching subscription_plan in the context metadata.
user String Delete jobs matching user in the context metadata.
userId String Delete jobs matching user_id in the context metadata.
workerClass String Delete jobs with the given worker class.

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.
result DeleteJobsResponse Information about the status of the deletion request.

Mutation.aiAction

{{< details >}} Introduced in GitLab 15.11. Status: Experiment. {{< /details >}}

Input type: AiActionInput

Arguments

Name Type Description
chat AiChatInput Input for chat AI action.
clientMutationId String A unique identifier for the client performing the mutation.
clientSubscriptionId String Client generated ID that can be subscribed to, to receive a response for the mutation.
conversationType AiConversationsThreadsConversationType Conversation type of the thread.
descriptionComposer AiDescriptionComposerInput Input for description_composer AI action.
explainVulnerability AiExplainVulnerabilityInput Input for explain_vulnerability AI action.
generateCommitMessage AiGenerateCommitMessageInput Input for generate_commit_message AI action.
generateCubeQuery AiGenerateCubeQueryInput Input for generate_cube_query AI action.
generateDescription AiGenerateDescriptionInput Input for generate_description AI action.
measureCommentTemperature AiMeasureCommentTemperatureInput Input for measure_comment_temperature AI action.
platformOrigin String Specifies the origin platform of the request.
projectId ProjectID Global ID of the project the user is acting on.
resolveVulnerability AiResolveVulnerabilityInput Input for resolve_vulnerability AI action.
summarizeComments AiSummarizeCommentsInput Input for summarize_comments AI action.
summarizeNewMergeRequest AiSummarizeNewMergeRequestInput Input for summarize_new_merge_request AI action.
summarizeReview AiSummarizeReviewInput Input for summarize_review AI action.
threadId AiConversationThreadID Global 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

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.
requestId String ID of the request.
threadId AiConversationThreadID Global Id of the thread.

Mutation.aiAgentCreate

{{< details >}} Introduced in GitLab 16.8. Status: Experiment. {{< /details >}}

Input type: AiAgentCreateInput

Arguments

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
name String! Name of the agent.
projectPath ID! Project to which the agent belongs.
prompt String! Prompt for the agent.

Fields

Name Type Description
agent AiAgent Agent after mutation.
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.

Mutation.aiAgentDestroy

{{< details >}} Introduced in GitLab 16.11. Status: Experiment. {{< /details >}}

Input type: AiAgentDestroyInput

Arguments

Name Type Description
agentId AiAgentID! Global ID of the AI Agent to be deleted.
clientMutationId String A unique identifier for the client performing the mutation.
projectPath ID! Project to which the agent belongs.

Fields

Name Type Description
agent AiAgent Agent after mutation.
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.
message String AI Agent deletion result message.

Mutation.aiAgentUpdate

{{< details >}} Introduced in GitLab 16.10. Status: Experiment. {{< /details >}}

Input type: AiAgentUpdateInput

Arguments

Name Type Description
agentId AiAgentID! ID of the agent.
clientMutationId String A unique identifier for the client performing the mutation.
name String Name of the agent.
projectPath ID! Project to which the agent belongs.
prompt String Prompt for the agent.

Fields

Name Type Description
agent AiAgent Agent after mutation.
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.

Mutation.aiFeatureSettingUpdate

Updates or creates settings for AI features.

{{< details >}} Introduced in GitLab 17.4. Status: Experiment. {{< /details >}}

Input type: AiFeatureSettingUpdateInput

Arguments

Name Type Description
aiSelfHostedModelId AiSelfHostedModelID Global ID of the self-hosted model providing the AI setting.
clientMutationId String A unique identifier for the client performing the mutation.
features [AiFeatures!]! Array of AI features being configured (for single or batch update).
provider AiFeatureProviders! Provider for AI setting.

Fields

Name Type Description
aiFeatureSettings [AiFeatureSetting!]! List of AI feature settings after mutation.
clientMutationId String A 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.

{{< details >}} Introduced in GitLab 17.7. Status: Experiment. {{< /details >}}

Input type: AiSelfHostedModelConnectionCheckInput

Arguments

Name Type Description
apiToken String API token to access the self-hosted model, if any.
clientMutationId String A unique identifier for the client performing the mutation.
endpoint String! Endpoint of the self-hosted model.
identifier String Identifier for 3rd party model provider.
model AiAcceptedSelfHostedModels! AI model deployed.
name String! Deployment name of the self-hosted model.

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.
result CloudConnectorProbeResult Self-hosted hosted connection check result.

Mutation.aiSelfHostedModelCreate

{{< details >}} Introduced in GitLab 17.1. Status: Experiment. {{< /details >}}

Input type: AiSelfHostedModelCreateInput

Arguments

Name Type Description
apiToken String API token to access the self-hosted model, if any.
clientMutationId String A unique identifier for the client performing the mutation.
endpoint String! Endpoint of the self-hosted model.
identifier String Identifier for 3rd party model provider.
model AiAcceptedSelfHostedModels! AI model deployed.
name String! Deployment name of the self-hosted model.

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.
selfHostedModel AiSelfHostedModel Self-hosted model after mutation.

Mutation.aiSelfHostedModelDelete

Deletes a self-hosted model.

{{< details >}} Introduced in GitLab 17.2. Status: Experiment. {{< /details >}}

Input type: AiSelfHostedModelDeleteInput

Arguments

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
id AiSelfHostedModelID! Global ID of the self-hosted model to delete.

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.

Mutation.aiSelfHostedModelUpdate

Updates a self-hosted model.

{{< details >}} Introduced in GitLab 17.2. Status: Experiment. {{< /details >}}

Input type: AiSelfHostedModelUpdateInput

Arguments

Name Type Description
apiToken String API token to access the self-hosted model, if any.
clientMutationId String A unique identifier for the client performing the mutation.
endpoint String! Endpoint of the self-hosted model.
id AiSelfHostedModelID! Global ID of the self-hosted model to update.
identifier String Identifier for 3rd party model provider.
model AiAcceptedSelfHostedModels! AI model deployed.
name String! Deployment name of the self-hosted model.

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.
selfHostedModel AiSelfHostedModel Self-hosted model after mutation.

Mutation.alertSetAssignees

Input type: AlertSetAssigneesInput

Arguments

Name Type Description
assigneeUsernames [String!]! Usernames to assign to the alert. Replaces existing assignees by default.
clientMutationId String A unique identifier for the client performing the mutation.
iid String! IID of the alert to mutate.
operationMode MutationOperationMode Operation to perform. Defaults to REPLACE.
projectPath ID! Project the alert to mutate is in.

Fields

Name Type Description
alert AlertManagementAlert Alert after mutation.
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.
issue Issue Issue created after mutation.
todo Todo To-do item after mutation.

Mutation.alertTodoCreate

Input type: AlertTodoCreateInput

Arguments

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
iid String! IID of the alert to mutate.
projectPath ID! Project the alert to mutate is in.

Fields

Name Type Description
alert AlertManagementAlert Alert after mutation.
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.
issue Issue Issue created after mutation.
todo Todo To-do item after mutation.

Mutation.approvalProjectRuleDelete

{{< details >}} Introduced in GitLab 16.10. Status: Experiment. {{< /details >}}

Input type: approvalProjectRuleDeleteInput

Arguments

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
id ApprovalProjectRuleID! Global ID of the approval project rule to delete.

Fields

Name Type Description
approvalRule ApprovalProjectRule Deleted approval rule.
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.

Mutation.approvalProjectRuleUpdate

{{< details >}} Introduced in GitLab 16.10. Status: Experiment. {{< /details >}}

Input type: approvalProjectRuleUpdateInput

Arguments

Name Type Description
approvalsRequired Int! How many approvals are required to satify rule.
clientMutationId String A unique identifier for the client performing the mutation.
groupIds [ID!] List of IDs of Groups that can approval rule.
id ApprovalProjectRuleID! Global ID of the approval rule to destroy.
name String! Name of the approval rule.
userIds [ID!] List of IDs of Users that can approval rule.

Fields

Name Type Description
approvalRule ApprovalProjectRule Approval rule after mutation.
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.

Mutation.approveDeployment

Input type: ApproveDeploymentInput

Arguments

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
comment String Comment to go with the approval.
id DeploymentID! ID of the deployment.
representedAs String Name of the User/Group/Role to use for the approval, when the user belongs to multiple approval rules.
status DeploymentsApprovalStatus! Status of the approval (either APPROVED or REJECTED).

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
deploymentApproval DeploymentApproval DeploymentApproval after mutation.
errors [String!]! Errors encountered during execution of the mutation.

Mutation.artifactDestroy

Input type: ArtifactDestroyInput

Arguments

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
id CiJobArtifactID! ID of the artifact to delete.

Fields

Name Type Description
artifact CiJobArtifact Deleted artifact.
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.

Mutation.auditEventsAmazonS3ConfigurationCreate

Input type: AuditEventsAmazonS3ConfigurationCreateInput

Arguments

Name Type Description
accessKeyXid String! Access key ID of the Amazon S3 account.
awsRegion String! AWS region where the bucket is created.
bucketName String! Name of the bucket where the audit events would be logged.
clientMutationId String A unique identifier for the client performing the mutation.
groupPath ID! Group path.
name String Destination name.
secretAccessKey String! Secret access key of the Amazon S3 account.

Fields

Name Type Description
amazonS3Configuration AmazonS3ConfigurationType configuration created.
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.

Mutation.auditEventsAmazonS3ConfigurationDelete

Input type: AuditEventsAmazonS3ConfigurationDeleteInput

Arguments

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
id AuditEventsAmazonS3ConfigurationID! ID of the Amazon S3 configuration to destroy.

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.

Mutation.auditEventsAmazonS3ConfigurationUpdate

Input type: AuditEventsAmazonS3ConfigurationUpdateInput

Arguments

Name Type Description
accessKeyXid String Access key ID of the Amazon S3 account.
awsRegion String AWS region where the bucket is created.
bucketName String Name of the bucket where the audit events would be logged.
clientMutationId String A unique identifier for the client performing the mutation.
id AuditEventsAmazonS3ConfigurationID! ID of the Amazon S3 configuration to update.
name String Destination name.
secretAccessKey String Secret access key of the Amazon S3 account.

Fields

Name Type Description
amazonS3Configuration AmazonS3ConfigurationType Updated Amazon S3 configuration.
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.

Mutation.auditEventsGroupDestinationEventsAdd

{{< details >}} Introduced in GitLab 17.0. Status: Experiment. {{< /details >}}

Input type: AuditEventsGroupDestinationEventsAddInput

Arguments

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
destinationId AuditEventsGroupExternalStreamingDestinationID! Destination id.
eventTypeFilters [String!]! List of event type filters to add for streaming.

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.
eventTypeFilters [String!] List of event type filters for the audit event external destination.

Mutation.auditEventsGroupDestinationEventsDelete

{{< details >}} Introduced in GitLab 17.0. Status: Experiment. {{< /details >}}

Input type: AuditEventsGroupDestinationEventsDeleteInput

Arguments

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
destinationId AuditEventsGroupExternalStreamingDestinationID! Destination id.
eventTypeFilters [String!]! List of event type filters to remove from streaming.

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.

Mutation.auditEventsGroupDestinationNamespaceFilterCreate

{{< details >}} Introduced in GitLab 17.0. Status: Experiment. {{< /details >}}

Input type: AuditEventsGroupDestinationNamespaceFilterCreateInput

Arguments

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
destinationId AuditEventsGroupExternalStreamingDestinationID! Destination ID.
namespacePath String Full path of the namespace(only project or group).

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.
namespaceFilter GroupAuditEventNamespaceFilter Namespace filter created.

Mutation.auditEventsGroupDestinationNamespaceFilterDelete

{{< details >}} Introduced in GitLab 17.0. Status: Experiment. {{< /details >}}

Input type: AuditEventsGroupDestinationNamespaceFilterDeleteInput

Arguments

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
namespaceFilterId AuditEventsGroupNamespaceFilterID! Namespace filter ID.

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.

Mutation.auditEventsInstanceAmazonS3ConfigurationCreate

Input type: AuditEventsInstanceAmazonS3ConfigurationCreateInput

Arguments

Name Type Description
accessKeyXid String! Access key ID of the Amazon S3 account.
awsRegion String! AWS region where the bucket is created.
bucketName String! Name of the bucket where the audit events would be logged.
clientMutationId String A unique identifier for the client performing the mutation.
name String Destination name.
secretAccessKey String! Secret access key of the Amazon S3 account.

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.
instanceAmazonS3Configuration InstanceAmazonS3ConfigurationType Created instance Amazon S3 configuration.

Mutation.auditEventsInstanceAmazonS3ConfigurationDelete

Input type: AuditEventsInstanceAmazonS3ConfigurationDeleteInput

Arguments

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
id AuditEventsInstanceAmazonS3ConfigurationID! ID of the instance-level Amazon S3 configuration to delete.

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.

Mutation.auditEventsInstanceAmazonS3ConfigurationUpdate

Input type: AuditEventsInstanceAmazonS3ConfigurationUpdateInput

Arguments

Name Type Description
accessKeyXid String Access key ID of the Amazon S3 account.
awsRegion String AWS region where the bucket is created.
bucketName String Name of the bucket where the audit events would be logged.
clientMutationId String A unique identifier for the client performing the mutation.
id AuditEventsInstanceAmazonS3ConfigurationID! ID of the instance-level Amazon S3 configuration to update.
name String Destination name.
secretAccessKey String Secret access key of the Amazon S3 account.

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.
instanceAmazonS3Configuration InstanceAmazonS3ConfigurationType Updated instance-level Amazon S3 configuration.

Mutation.auditEventsInstanceDestinationEventsAdd

{{< details >}} Introduced in GitLab 17.0. Status: Experiment. {{< /details >}}

Input type: AuditEventsInstanceDestinationEventsAddInput

Arguments

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
destinationId AuditEventsInstanceExternalStreamingDestinationID! Destination id.
eventTypeFilters [String!]! List of event type filters to add for streaming.

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.
eventTypeFilters [String!] List of event type filters for the audit event external destination.

Mutation.auditEventsInstanceDestinationEventsDelete

{{< details >}} Introduced in GitLab 17.0. Status: Experiment. {{< /details >}}

Input type: AuditEventsInstanceDestinationEventsDeleteInput

Arguments

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
destinationId AuditEventsInstanceExternalStreamingDestinationID! Destination id.
eventTypeFilters [String!]! List of event type filters to remove from streaming.

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.

Mutation.auditEventsInstanceDestinationNamespaceFilterCreate

{{< details >}} Introduced in GitLab 17.2. Status: Experiment. {{< /details >}}

Input type: AuditEventsInstanceDestinationNamespaceFilterCreateInput

Arguments

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
destinationId AuditEventsInstanceExternalStreamingDestinationID! Destination ID.
namespacePath String Full path of the namespace. Project or group namespaces only.

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.
namespaceFilter InstanceAuditEventNamespaceFilter Namespace filter to be created.

Mutation.auditEventsInstanceDestinationNamespaceFilterDelete

{{< details >}} Introduced in GitLab 17.2. Status: Experiment. {{< /details >}}

Input type: AuditEventsInstanceDestinationNamespaceFilterDeleteInput

Arguments

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
namespaceFilterId AuditEventsInstanceNamespaceFilterID! Namespace filter ID.

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.

Mutation.auditEventsStreamingDestinationEventsAdd

Input type: AuditEventsStreamingDestinationEventsAddInput

Arguments

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
destinationId AuditEventsExternalAuditEventDestinationID! Destination id.
eventTypeFilters [String!]! List of event type filters to add for streaming.

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.
eventTypeFilters [String!] List of event type filters for the audit event external destination.

Mutation.auditEventsStreamingDestinationEventsRemove

Input type: AuditEventsStreamingDestinationEventsRemoveInput

Arguments

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
destinationId AuditEventsExternalAuditEventDestinationID! Destination id.
eventTypeFilters [String!]! List of event type filters to remove from streaming.

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.

Mutation.auditEventsStreamingDestinationInstanceEventsAdd

Input type: AuditEventsStreamingDestinationInstanceEventsAddInput

Arguments

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
destinationId AuditEventsInstanceExternalAuditEventDestinationID! Destination id.
eventTypeFilters [String!]! List of event type filters to add for streaming.

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.
eventTypeFilters [String!] List of event type filters for the audit event external destination.

Mutation.auditEventsStreamingDestinationInstanceEventsRemove

Input type: AuditEventsStreamingDestinationInstanceEventsRemoveInput

Arguments

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
destinationId AuditEventsInstanceExternalAuditEventDestinationID! Destination id.
eventTypeFilters [String!]! List of event type filters to remove from streaming.

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.

Mutation.auditEventsStreamingHeadersCreate

Input type: AuditEventsStreamingHeadersCreateInput

Arguments

Name Type Description
active Boolean Boolean option determining whether header is active or not.
clientMutationId String A unique identifier for the client performing the mutation.
destinationId AuditEventsExternalAuditEventDestinationID! Destination to associate header with.
key String! Header key.
value String! Header value.

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.
header AuditEventStreamingHeader Created header.

Mutation.auditEventsStreamingHeadersDestroy

Input type: AuditEventsStreamingHeadersDestroyInput

Arguments

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
headerId AuditEventsStreamingHeaderID! Header to delete.

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.

Mutation.auditEventsStreamingHeadersUpdate

Input type: AuditEventsStreamingHeadersUpdateInput

Arguments

Name Type Description
active Boolean Boolean option determining whether header is active or not.
clientMutationId String A unique identifier for the client performing the mutation.
headerId AuditEventsStreamingHeaderID! Header to update.
key String Header key.
value String Header value.

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.
header AuditEventStreamingHeader Updates header.

Mutation.auditEventsStreamingHttpNamespaceFiltersAdd

Input type: AuditEventsStreamingHTTPNamespaceFiltersAddInput

Arguments

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
destinationId AuditEventsExternalAuditEventDestinationID! Destination ID.
groupPath ID Full path of the group.
projectPath ID Full path of the project.

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.
namespaceFilter AuditEventStreamingHTTPNamespaceFilter Namespace filter created.

Mutation.auditEventsStreamingHttpNamespaceFiltersDelete

Input type: AuditEventsStreamingHTTPNamespaceFiltersDeleteInput

Arguments

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
namespaceFilterId AuditEventsStreamingHTTPNamespaceFilterID! Namespace filter ID.

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.

Mutation.auditEventsStreamingInstanceHeadersCreate

Input type: AuditEventsStreamingInstanceHeadersCreateInput

Arguments

Name Type Description
active Boolean Boolean option determining whether header is active or not.
clientMutationId String A unique identifier for the client performing the mutation.
destinationId AuditEventsInstanceExternalAuditEventDestinationID! Instance level external destination to associate header with.
key String! Header key.
value String! Header value.

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.
header AuditEventsStreamingInstanceHeader Created header.

Mutation.auditEventsStreamingInstanceHeadersDestroy

Input type: AuditEventsStreamingInstanceHeadersDestroyInput

Arguments

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
headerId AuditEventsStreamingInstanceHeaderID! Header to delete.

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.

Mutation.auditEventsStreamingInstanceHeadersUpdate

Input type: AuditEventsStreamingInstanceHeadersUpdateInput

Arguments

Name Type Description
active Boolean Boolean option determining whether header is active or not.
clientMutationId String A unique identifier for the client performing the mutation.
headerId AuditEventsStreamingInstanceHeaderID! Header to update.
key String Header key.
value String Header value.

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.
header AuditEventsStreamingInstanceHeader Updates header.

Mutation.awardEmojiAdd

Input type: AwardEmojiAddInput

Arguments

Name Type Description
awardableId AwardableID! Global ID of the awardable resource.
clientMutationId String A unique identifier for the client performing the mutation.
name String! Emoji name.

Fields

Name Type Description
awardEmoji AwardEmoji Emoji reactions after mutation.
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.

Mutation.awardEmojiRemove

Input type: AwardEmojiRemoveInput

Arguments

Name Type Description
awardableId AwardableID! Global ID of the awardable resource.
clientMutationId String A unique identifier for the client performing the mutation.
name String! Emoji name.

Fields

Name Type Description
awardEmoji AwardEmoji Emoji reactions after mutation.
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.

Mutation.awardEmojiToggle

Input type: AwardEmojiToggleInput

Arguments

Name Type Description
awardableId AwardableID! Global ID of the awardable resource.
clientMutationId String A unique identifier for the client performing the mutation.
name String! Emoji name.

Fields

Name Type Description
awardEmoji AwardEmoji Emoji reactions after mutation.
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.
toggledOn Boolean! Indicates the status of the emoji. True if the toggle awarded the emoji, and false if the toggle removed the emoji.

Mutation.boardEpicCreate

{{< details >}} Deprecated in GitLab 17.5. Replaced by WorkItem type. {{< /details >}}

Input type: BoardEpicCreateInput

Arguments

Name Type Description
boardId BoardsEpicBoardID! Global ID of the board that the epic is in.
clientMutationId String A unique identifier for the client performing the mutation.
groupPath ID! Group the epic to create is in.
listId BoardsEpicListID! Global ID of the epic board list in which epic will be created.
title String! Title of the epic.

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
epic Epic Epic after creation.
errors [String!]! Errors encountered during execution of the mutation.

Mutation.boardListCreate

Input type: BoardListCreateInput

Arguments

Name Type Description
assigneeId UserID Global ID of an existing user.
backlog Boolean Create the backlog list.
boardId BoardID! Global ID of the issue board to mutate.
clientMutationId String A unique identifier for the client performing the mutation.
iterationId IterationID Global ID of an existing iteration.
labelId LabelID Global ID of an existing label.
milestoneId MilestoneID Global ID of an existing milestone.
position Int Position of the list.
statusId {{< icon name=”warning-solid” >}} WorkItemsStatusesStatusID Deprecated: Status: Experiment. Introduced in GitLab 18.0.

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.
list BoardList Issue list in the issue board.

Mutation.boardListUpdateLimitMetrics

Input type: BoardListUpdateLimitMetricsInput

Arguments

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
limitMetric ListLimitMetric New limit metric type for the list.
listId ListID! Global ID of the list.
maxIssueCount Int New maximum issue count limit.
maxIssueWeight Int New maximum issue weight limit.

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.
list BoardList Updated list.

Mutation.branchDelete

Input type: BranchDeleteInput

Arguments

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
name String! Name of the branch.
projectPath ID! Project full path the branch is associated with.

Fields

Name Type Description
branch Branch Branch after mutation.
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.

Mutation.branchRuleApprovalProjectRuleCreate

{{< details >}} Introduced in GitLab 16.10. Status: Experiment. {{< /details >}}

Input type: branchRuleApprovalProjectRuleCreateInput

Arguments

Name Type Description
approvalsRequired Int! How many approvals are required to satify rule.
branchRuleId ProjectsBranchRuleID! Global ID of the branch rule to destroy.
clientMutationId String A unique identifier for the client performing the mutation.
groupIds [ID!] List of IDs of Groups that can approval rule.
name String! Name of the approval rule.
userIds [ID!] List of IDs of Users that can approval rule.

Fields

Name Type Description
approvalRule ApprovalProjectRule Approval rule after mutation.
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.

Mutation.branchRuleCreate

{{< details >}} Introduced in GitLab 16.7. Status: Experiment. {{< /details >}}

Input type: BranchRuleCreateInput

Arguments

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
name String! Branch name, with wildcards, for the branch rules.
projectPath ID! Full path to the project that the branch is associated with.

Fields

Name Type Description
branchRule BranchRule Branch rule after mutation.
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.

Mutation.branchRuleDelete

{{< details >}} Introduced in GitLab 16.9. Status: Experiment. {{< /details >}}

Input type: BranchRuleDeleteInput

Arguments

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
id ProjectsBranchRuleID! Global ID of the branch rule to destroy.

Fields

Name Type Description
branchRule BranchRule Branch rule after mutation.
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.

Mutation.branchRuleExternalStatusCheckCreate

Create a new external status check from a branch rule.

{{< details >}} Introduced in GitLab 16.11. Status: Experiment. {{< /details >}}

Input type: BranchRuleExternalStatusCheckCreateInput

Arguments

Name Type Description
branchRuleId ProjectsBranchRuleID! Global ID of the branch rule to update.
clientMutationId String A unique identifier for the client performing the mutation.
externalUrl String! URL of external status check resource.
name String! Name of the external status check.

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.
externalStatusCheck ExternalStatusCheck New status check after mutation.

Mutation.branchRuleExternalStatusCheckDestroy

Destroy an external status check from a branch rule.

{{< details >}} Introduced in GitLab 17.0. Status: Experiment. {{< /details >}}

Input type: BranchRuleExternalStatusCheckDestroyInput

Arguments

Name Type Description
branchRuleId ProjectsBranchRuleID! Global ID of the branch rule.
clientMutationId String A unique identifier for the client performing the mutation.
id MergeRequestsExternalStatusCheckID! Global ID of the external status check to destroy.

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.

Mutation.branchRuleExternalStatusCheckUpdate

Update an external status check from a branch rule.

{{< details >}} Introduced in GitLab 17.0. Status: Experiment. {{< /details >}}

Input type: BranchRuleExternalStatusCheckUpdateInput

Arguments

Name Type Description
branchRuleId ProjectsBranchRuleID! Global ID of the branch rule.
clientMutationId String A unique identifier for the client performing the mutation.
externalUrl String! External URL of the external status check.
id MergeRequestsExternalStatusCheckID! Global ID of the external status check to update.
name String! Name of the external status check.

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.
externalStatusCheck ExternalStatusCheck Updated external status check after mutation.

Mutation.branchRuleSquashOptionDelete

Delete a squash option for a branch rule.

{{< details >}} Introduced in GitLab 17.9. Status: Experiment. {{< /details >}}

Input type: BranchRuleSquashOptionDeleteInput

Arguments

Name Type Description
branchRuleId ProjectsBranchRuleID! Global ID of the branch rule.
clientMutationId String A unique identifier for the client performing the mutation.

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.

Mutation.branchRuleSquashOptionUpdate

Update a squash option for a branch rule.

{{< details >}} Introduced in GitLab 17.9. Status: Experiment. {{< /details >}}

Input type: BranchRuleSquashOptionUpdateInput

Arguments

Name Type Description
branchRuleId ProjectsBranchRuleID! Global ID of the branch rule.
clientMutationId String A unique identifier for the client performing the mutation.
squashOption SquashOptionSetting! Squash option after mutation.

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.
squashOption SquashOption Updated squash option after mutation.

Mutation.branchRuleUpdate

{{< details >}} Introduced in GitLab 16.7. Status: Experiment. {{< /details >}}

Input type: BranchRuleUpdateInput

Arguments

Name Type Description
branchProtection BranchProtectionInput Branch protections configured for the branch rule.
clientMutationId String A unique identifier for the client performing the mutation.
id ProjectsBranchRuleID! Global ID of the branch rule to update.
name String! Branch name, with wildcards, for the branch rules.

Fields

Name Type Description
branchRule BranchRule Branch rule after mutation.
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.

Mutation.bulkDestroyJobArtifacts

{{< details >}} Introduced in GitLab 15.10. Status: Experiment. {{< /details >}}

Input type: BulkDestroyJobArtifactsInput

Arguments

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
ids [CiJobArtifactID!]! Global IDs of the job artifacts to destroy.
projectId ProjectID! Global Project ID of the job artifacts to destroy. Incompatible with projectPath.

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
destroyedCount Int Number of job artifacts deleted.
destroyedIds [CiJobArtifactID!] IDs of job artifacts that were deleted.
errors [String!]! Errors encountered during execution of the mutation.

Mutation.bulkEnableDevopsAdoptionNamespaces

Status: Beta.

Input type: BulkEnableDevopsAdoptionNamespacesInput

Arguments

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
displayNamespaceId NamespaceID Display namespace ID.
namespaceIds [NamespaceID!]! List of Namespace IDs.

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
enabledNamespaces [DevopsAdoptionEnabledNamespace!] Enabled namespaces after mutation.
errors [String!]! Errors encountered during execution of the mutation.

Mutation.bulkRunnerDelete

{{< details >}} Introduced in GitLab 15.3. Status: Experiment. {{< /details >}}

Input type: BulkRunnerDeleteInput

Arguments

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
ids [CiRunnerID!] IDs of the runners to delete.

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
deletedCount Int Number of records effectively deleted. Only present if operation was performed synchronously.
deletedIds [CiRunnerID!] IDs of records effectively deleted. Only present if operation was performed synchronously.
errors [String!]! Errors encountered during execution of the mutation.

Mutation.catalogResourcesCreate

{{< details >}} Introduced in GitLab 15.11. Status: Experiment. {{< /details >}}

Input type: CatalogResourcesCreateInput

Arguments

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
projectPath ID! Project path belonging to the catalog resource.

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.

Mutation.catalogResourcesDestroy

{{< details >}} Introduced in GitLab 16.6. Status: Experiment. {{< /details >}}

Input type: CatalogResourcesDestroyInput

Arguments

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
projectPath ID! Project path belonging to the catalog resource.

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.

Mutation.ciJobTokenScopeAddGroupOrProject

Input type: CiJobTokenScopeAddGroupOrProjectInput

Arguments

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
defaultPermissions {{< icon name=”warning-solid” >}} Boolean Deprecated: Status: Experiment. Introduced in GitLab 17.8.
jobTokenPolicies {{< icon name=”warning-solid” >}} [CiJobTokenScopePolicies!] Deprecated: Status: Experiment. Introduced in GitLab 17.5.
projectPath ID! Project that the CI job token scope belongs to.
targetPath ID! Group or project to be added to the CI job token scope.

Fields

Name Type Description
ciJobTokenScope CiJobTokenScopeType CI job token’s access scope.
ciJobTokenScopeAllowlistEntry {{< icon name=”warning-solid” >}} CiJobTokenScopeAllowlistEntry Deprecated: Status: Experiment. Introduced in GitLab 17.6.
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.

Mutation.ciJobTokenScopeAddProject

Input type: CiJobTokenScopeAddProjectInput

Arguments

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
direction {{< icon name=”warning-solid” >}} CiJobTokenScopeDirection Deprecated: Outbound job token scope is being removed. This field can now only be set to INBOUND. Deprecated in GitLab 16.0.
projectPath ID! Project that the CI job token scope belongs to.
targetProjectPath ID! Project to be added to the CI job token scope.

Fields

Name Type Description
ciJobTokenScope CiJobTokenScopeType CI job token’s access scope.
ciJobTokenScopeAllowlistEntry {{< icon name=”warning-solid” >}} CiJobTokenScopeAllowlistEntry Deprecated: Status: Experiment. Introduced in GitLab 17.6.
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.

Mutation.ciJobTokenScopeAutopopulateAllowlist

{{< details >}} Introduced in GitLab 17.9. Status: Experiment. {{< /details >}}

Input type: CiJobTokenScopeAutopopulateAllowlistInput

Arguments

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
projectPath ID! Project in which to autopopulate the allowlist.

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.
status String! Status of the autopopulation process.

Mutation.ciJobTokenScopeClearAllowlistAutopopulations

{{< details >}} Introduced in GitLab 17.9. Status: Experiment. {{< /details >}}

Input type: CiJobTokenScopeClearAllowlistAutopopulationsInput

Arguments

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
projectPath ID! Project in which to autopopulate the allowlist.

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.
status String! Status of the autopopulation process.

Mutation.ciJobTokenScopeRemoveGroup

Input type: CiJobTokenScopeRemoveGroupInput

Arguments

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
projectPath ID! Project that the CI job token scope belongs to.
targetGroupPath ID! Group to be removed from the CI job token scope.

Fields

Name Type Description
ciJobTokenScope CiJobTokenScopeType CI job token’s access scope.
ciJobTokenScopeAllowlistEntry {{< icon name=”warning-solid” >}} CiJobTokenScopeAllowlistEntry Deprecated: Status: Experiment. Introduced in GitLab 17.6.
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.

Mutation.ciJobTokenScopeRemoveProject

Input type: CiJobTokenScopeRemoveProjectInput

Arguments

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
direction {{< icon name=”warning-solid” >}} CiJobTokenScopeDirection Deprecated: Outbound job token scope is being removed. This field can now only be set to INBOUND. Deprecated in GitLab 16.9.
projectPath ID! Project that the CI job token scope belongs to.
targetProjectPath ID! Project to be removed from the CI job token scope.

Fields

Name Type Description
ciJobTokenScope CiJobTokenScopeType CI job token’s access scope.
ciJobTokenScopeAllowlistEntry {{< icon name=”warning-solid” >}} CiJobTokenScopeAllowlistEntry Deprecated: Status: Experiment. Introduced in GitLab 17.6.
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.

Mutation.ciJobTokenScopeUpdatePolicies

{{< details >}} Introduced in GitLab 17.6. Status: Experiment. {{< /details >}}

Input type: CiJobTokenScopeUpdatePoliciesInput

Arguments

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
defaultPermissions Boolean! 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.
projectPath ID! Project that the CI job token scope belongs to.
targetPath ID! Group or project that the CI job token targets.

Fields

Name Type Description
ciJobTokenScopeAllowlistEntry {{< icon name=”warning-solid” >}} CiJobTokenScopeAllowlistEntry Deprecated: Status: Experiment. Introduced in GitLab 17.6.
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.

Mutation.clusterAgentDelete

Input type: ClusterAgentDeleteInput

Arguments

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
id ClustersAgentID! Global ID of the cluster agent that will be deleted.

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.

Mutation.clusterAgentTokenCreate

Input type: ClusterAgentTokenCreateInput

Arguments

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

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.
secret String Token secret value. Make sure you save it - you won’t be able to access it again.
token ClusterAgentToken Token created after mutation.

Mutation.clusterAgentTokenRevoke

Input type: ClusterAgentTokenRevokeInput

Arguments

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
id ClustersAgentTokenID! Global ID of the agent token that will be revoked.

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.

Mutation.clusterAgentUrlConfigurationCreate

Input type: ClusterAgentUrlConfigurationCreateInput

Arguments

Name Type Description
caCert String Base64-encoded CA certificate in PEM format to verify the agent endpoint.
clientCert String Base64-encoded client certificate in PEM format if mTLS authentication should be used. Must be provided with client_key.
clientKey String Base64-encoded client key in PEM format if mTLS authentication should be used. Must be provided with client_cert.
clientMutationId String A unique identifier for the client performing the mutation.
clusterAgentId ClustersAgentID! Global ID of the cluster agent that will be associated with the new URL configuration.
tlsHost String TLS host name to verify the server name in agent endpoint certificate.
url String! URL for the new URL configuration.

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.
urlConfiguration ClusterAgentUrlConfiguration URL configuration created after mutation.

Mutation.clusterAgentUrlConfigurationDelete

Input type: ClusterAgentUrlConfigurationDeleteInput

Arguments

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
id ClustersAgentsUrlConfigurationID! Global ID of the agent URL configuration that will be deleted.

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.

Mutation.commitCreate

Input type: CommitCreateInput

Arguments

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

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
commit Commit Commit after mutation.
commitPipelinePath String ETag path for the commit’s pipeline.
content [String!] Contents of the commit.
errors [String!]! Errors encountered during execution of the mutation.

Mutation.configureContainerScanning

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

Input type: ConfigureContainerScanningInput

Arguments

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
projectPath ID! Full path of the project.

Fields

Name Type Description
branch String Branch that has the new/modified .gitlab-ci.yml file.
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.
successPath String Redirect path to use when the response is successful.

Mutation.configureDependencyScanning

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

Input type: ConfigureDependencyScanningInput

Arguments

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
projectPath ID! Full path of the project.

Fields

Name Type Description
branch String Branch that has the new/modified .gitlab-ci.yml file.
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.
successPath String Redirect path to use when the response is successful.

Mutation.configureSast

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

Input type: ConfigureSastInput

Arguments

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
configuration SastCiConfigurationInput! SAST CI configuration for the project.
projectPath ID! Full path of the project.

Fields

Name Type Description
branch String Branch that has the new/modified .gitlab-ci.yml file.
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.
successPath String Redirect path to use when the response is successful.

Mutation.configureSastIac

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

Input type: ConfigureSastIacInput

Arguments

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
projectPath ID! Full path of the project.

Fields

Name Type Description
branch String Branch that has the new/modified .gitlab-ci.yml file.
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.
successPath String Redirect path to use when the response is successful.

Mutation.configureSecretDetection

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

Input type: ConfigureSecretDetectionInput

Arguments

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
projectPath ID! Full path of the project.

Fields

Name Type Description
branch String Branch that has the new/modified .gitlab-ci.yml file.
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.
successPath String Redirect path to use when the response is successful.

Mutation.corpusCreate

Input type: CorpusCreateInput

Arguments

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
fullPath ID! Project the corpus belongs to.
packageId PackagesPackageID! ID of the corpus package.

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.

Mutation.createAbuseReportNote

Creates an abuse report Note.

Input type: CreateAbuseReportNoteInput

Arguments

Name Type Description
abuseReportId AbuseReportID! ID of the abuse report.
body String! Content of the note.
clientMutationId String A unique identifier for the client performing the mutation.
discussionId DiscussionID Global ID of the abuse report discussion the note is in reply to.

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.
note AbuseReportNote Abuse report note after mutation.

Mutation.createAlertIssue

Input type: CreateAlertIssueInput

Arguments

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
iid String! IID of the alert to mutate.
projectPath ID! Project the alert to mutate is in.

Fields

Name Type Description
alert AlertManagementAlert Alert after mutation.
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.
issue Issue Issue created after mutation.
todo Todo To-do item after mutation.

Mutation.createAnnotation

{{< details >}} Deprecated in GitLab 16.0. Underlying feature was removed in 16.0. {{< /details >}}

Input type: CreateAnnotationInput

Arguments

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
clusterId ClustersClusterID Global ID of the cluster to add an annotation to.
dashboardPath String! Path to a file defining the dashboard on which the annotation should be added.
description String! Description of the annotation.
endingAt Time Timestamp indicating ending moment to which the annotation relates.
environmentId EnvironmentID Global ID of the environment to add an annotation to.
startingAt Time! Timestamp indicating starting moment to which the annotation relates.

Fields

Name Type Description
annotation MetricsDashboardAnnotation Created annotation.
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.

Mutation.createBoard

Input type: CreateBoardInput

Arguments

Name Type Description
assigneeId UserID ID of user to be assigned to the board.
clientMutationId String A unique identifier for the client performing the mutation.
groupPath ID Full path of the group with which the resource is associated.
hideBacklogList Boolean Whether or not backlog list is hidden.
hideClosedList Boolean Whether or not closed list is hidden.
iterationCadenceId IterationsCadenceID ID of iteration cadence to be assigned to the board.
iterationId IterationID ID of iteration to be assigned to the board.
labelIds [LabelID!] IDs of labels to be added to the board.
labels [String!] Labels of the issue.
milestoneId MilestoneID ID of milestone to be assigned to the board.
name String Board name.
projectPath ID Full path of the project with which the resource is associated.
weight Int Weight value to be assigned to the board.

Fields

Name Type Description
board Board Board after mutation.
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.

Mutation.createBranch

Input type: CreateBranchInput

Arguments

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

Fields

Name Type Description
branch Branch Branch after mutation.
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.

Mutation.createClusterAgent

Input type: CreateClusterAgentInput

Arguments

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

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
clusterAgent ClusterAgent Cluster agent created after mutation.
errors [String!]! Errors encountered during execution of the mutation.

Mutation.createComplianceFramework

Input type: CreateComplianceFrameworkInput

Arguments

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
namespacePath ID! Full path of the namespace to add the compliance framework to.
params ComplianceFrameworkInput! Parameters to update the compliance framework with.

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.
framework ComplianceFramework Created compliance framework.

Mutation.createComplianceRequirement

{{< details >}} Introduced in GitLab 17.6. Status: Experiment. {{< /details >}}

Input type: CreateComplianceRequirementInput

Arguments

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
complianceFrameworkId ComplianceManagementFrameworkID! Global ID of the compliance framework of the new requirement.
controls [ComplianceRequirementsControlInput!] Controls to add to the compliance requirement.
params ComplianceRequirementInput! Parameters to update the compliance requirement with.

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.
requirement ComplianceRequirement Created compliance requirement.

Mutation.createComplianceRequirementsControl

{{< details >}} Introduced in GitLab 17.9. Status: Experiment. {{< /details >}}

Input type: CreateComplianceRequirementsControlInput

Arguments

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
complianceRequirementId ComplianceManagementComplianceFrameworkComplianceRequirementID! Global ID of the compliance requirement of the new control.
params ComplianceRequirementsControlInput! Parameters to create the compliance requirement control.

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.
requirementsControl ComplianceRequirementsControl Created compliance requirements control.

Mutation.createContainerProtectionRepositoryRule

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

Input type: CreateContainerProtectionRepositoryRuleInput

Arguments

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
minimumAccessLevelForDelete ContainerProtectionRepositoryRuleAccessLevel Minimum GitLab access level required to delete container images from the container repository. Valid values include MAINTAINER, OWNER, or ADMIN. If the value is nil, the default minimum access level is DEVELOPER.
minimumAccessLevelForPush ContainerProtectionRepositoryRuleAccessLevel Minimum GitLab access level required to push container images to the container repository. Valid values include MAINTAINER, OWNER, or ADMIN. If the value is nil, the default minimum access level is DEVELOPER.
projectPath ID! Full path of the project where a protection rule is located.
repositoryPathPattern String! Container repository path pattern protected by the protection rule. Must start with the project’s full path. For example: my-project/*-prod-*. Wildcard character * is allowed anywhere after the project’s full path.

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
containerProtectionRepositoryRule ContainerProtectionRepositoryRule Container 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.

{{< details >}} Introduced in GitLab 17.8. Status: Experiment. {{< /details >}}

Input type: createContainerProtectionTagRuleInput

Arguments

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
minimumAccessLevelForDelete ContainerProtectionTagRuleAccessLevel Minimum GitLab access level required to delete container image tags from the container repository. Valid values include MAINTAINER, OWNER, or ADMIN. If the value is nil, no access level can delete tags. Introduced in GitLab 17.8: Status: Experiment.
minimumAccessLevelForPush ContainerProtectionTagRuleAccessLevel Minimum GitLab access level required to push container image tags to the container repository. Valid values include MAINTAINER, OWNER, or ADMIN. If the value is nil, no access level can push tags. Introduced in GitLab 17.8: Status: Experiment.
projectPath ID! Full path of the project containing the container image tags.
tagNamePattern String! The pattern that matches container image tags to protect. For example, v1.*. Wildcard character * allowed. Introduced in GitLab 17.8: Status: Experiment.

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
containerProtectionTagRule {{< icon name=”warning-solid” >}} ContainerProtectionTagRule Deprecated: Status: Experiment. Introduced in GitLab 17.8.
errors [String!]! Errors encountered during execution of the mutation.

Mutation.createCustomEmoji

Input type: CreateCustomEmojiInput

Arguments

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

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
customEmoji CustomEmoji New custom emoji.
errors [String!]! Errors encountered during execution of the mutation.

Mutation.createDiffNote

Input type: CreateDiffNoteInput

Arguments

Name Type Description
body String! Content of the note.
clientMutationId String A unique identifier for the client performing the mutation.
internal Boolean Internal flag for a note. Default is false.
noteableId NoteableID! Global ID of the resource to add a note to.
position DiffPositionInput! Position of the note on a diff.

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.
note Note Note after mutation.
quickActionsStatus QuickActionsStatus Status of quick actions after mutation.

Mutation.createDiscussion

Input type: CreateDiscussionInput

Arguments

Name Type Description
body String! Content of the note.
clientMutationId String A unique identifier for the client performing the mutation.
internal Boolean Internal flag for a note. Default is false.
noteableId NoteableID! Global ID of the resource to add a note to.

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.
note Note Note after mutation.
quickActionsStatus QuickActionsStatus Status of quick actions after mutation.

Mutation.createEpic

{{< details >}} Deprecated in GitLab 17.5. Replaced by WorkItem type. {{< /details >}}

Input type: CreateEpicInput

Arguments

Name Type Description
addLabelIds [ID!] IDs of labels to be added to the epic.
addLabels [String!] Array of labels to be added to the epic.
clientMutationId String A unique identifier for the client performing the mutation.
color Color Color of the epic.
confidential Boolean Indicates if the epic is confidential.
description String Description of the epic.
dueDateFixed String End date of the epic.
dueDateIsFixed Boolean Indicates end date should be sourced from due_date_fixed field not the issue milestones.
groupPath ID! Group the epic to mutate is in.
removeLabelIds [ID!] IDs of labels to be removed from the epic.
startDateFixed String Start date of the epic.
startDateIsFixed Boolean Indicates start date should be sourced from start_date_fixed field not the issue milestones.
title String Title of the epic.

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
epic Epic Created epic.
errors [String!]! Errors encountered during execution of the mutation.

Mutation.createImageDiffNote

Input type: CreateImageDiffNoteInput

Arguments

Name Type Description
body String! Content of the note.
clientMutationId String A unique identifier for the client performing the mutation.
internal Boolean Internal flag for a note. Default is false.
noteableId NoteableID! Global ID of the resource to add a note to.
position DiffImagePositionInput! Position of the note on a diff.

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.
note Note Note after mutation.
quickActionsStatus QuickActionsStatus Status of quick actions after mutation.

Mutation.createIssue

Input type: CreateIssueInput

Arguments

Name Type Description
assigneeIds [UserID!] Array of user IDs to assign to the issue.
clientMutationId String A unique identifier for the client performing the mutation.
confidential Boolean Indicates the issue is confidential.
createdAt Time Timestamp when the issue was created. Available only for admins and project owners.
description String Description of the issue.
discussionToResolve String ID of a discussion to resolve. Also pass merge_request_to_resolve_discussions_of.
dueDate ISO8601Date Due date of the issue.
epicId {{< icon name=”warning-solid” >}} EpicID Deprecated: This will be replaced by WorkItem hierarchyWidget. Deprecated in GitLab 17.5.
healthStatus HealthStatus Desired health status.
iid Int IID (internal ID) of a project issue. Only admins and project owners can modify.
iterationCadenceId IterationsCadenceID Global iteration cadence ID. Required when iterationWildcardId is provided.
iterationId IterationID Global iteration ID. Mutually exlusive argument with iterationWildcardId.
iterationWildcardId IssueCreationIterationWildcardId Iteration wildcard ID. Supported values are: CURRENT. Mutually exclusive argument with iterationId. iterationCadenceId also required when this argument is provided.
labelIds [LabelID!] IDs of labels to be added to the issue.
labels [String!] Labels of the issue.
locked Boolean Indicates discussion is locked on the issue.
mergeRequestToResolveDiscussionsOf MergeRequestID IID of a merge request for which to resolve discussions.
milestoneId MilestoneID ID of the milestone to assign to the issue. On update milestone will be removed if set to null.
moveAfterId IssueID Global ID of issue that should be placed after the current issue.
moveBeforeId IssueID Global ID of issue that should be placed before the current issue.
projectPath ID! Project full path the issue is associated with.
title String! Title of the issue.
type IssueType Type of the issue.
weight Int Weight of the issue.

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.
issue Issue Issue after mutation.

Mutation.createIteration

{{< details >}} Deprecated in GitLab 14.0. Use iterationCreate. {{< /details >}}

Input type: CreateIterationInput

Arguments

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
description String Description of the iteration.
dueDate String End date of the iteration.
groupPath ID Full path of the group with which the resource is associated.
iterationsCadenceId IterationsCadenceID Global ID of the iteration cadence to be assigned to the new iteration.
projectPath ID Full path of the project with which the resource is associated.
startDate String Start date of the iteration.
title String Title of the iteration.

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.
iteration Iteration Created iteration.

Mutation.createNote

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

Input type: CreateNoteInput

Arguments

Name Type Description
body String! Content of the note.
clientMutationId String A unique identifier for the client performing the mutation.
discussionId DiscussionID Global ID of the discussion the note is in reply to.
internal Boolean Internal flag for a note. Default is false.
mergeRequestDiffHeadSha String SHA of the head commit which is used to ensure that the merge request has not been updated since the request was sent.
noteableId NoteableID! Global ID of the resource to add a note to.

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.
note Note Note after mutation.
quickActionsStatus QuickActionsStatus Status of quick actions after mutation.

Mutation.createPackagesProtectionRule

Creates a protection rule to restrict access to project packages.

Input type: CreatePackagesProtectionRuleInput

Arguments

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
minimumAccessLevelForDelete {{< icon name=”warning-solid” >}} PackagesProtectionRuleAccessLevelForDelete Deprecated: Status: Experiment. Introduced in GitLab 17.10.
minimumAccessLevelForPush PackagesProtectionRuleAccessLevel Minimum GitLab access required to push packages to the package registry. Valid values include MAINTAINER, OWNER, or ADMIN. If the value is nil, the default minimum access level is DEVELOPER.
packageNamePattern String! Package name protected by the protection rule. For example, @my-scope/my-package-*. Wildcard character * allowed.
packageType PackagesProtectionRulePackageType! Package type protected by the protection rule. For example, NPM, PYPI.
projectPath ID! Full path of the project where a protection rule is located.

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.
packageProtectionRule PackagesProtectionRule Packages protection rule after mutation.

Mutation.createRequirement

Input type: CreateRequirementInput

Arguments

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
description String Description of the requirement.
projectPath ID! Full project path the requirement is associated with.
title String Title of the requirement.

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.
requirement Requirement Requirement after mutation.

Mutation.createSnippet

Input type: CreateSnippetInput

Arguments

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

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.
snippet Snippet Snippet after mutation.

Mutation.createTestCase

Input type: CreateTestCaseInput

Arguments

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
confidential Boolean Sets the test case confidentiality.
description String Test case description.
labelIds [ID!] IDs of labels to be added to the test case.
projectPath ID! Project full path to create the test case in.
title String! Test case title.

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.
testCase Issue Test case created.

Mutation.customFieldArchive

{{< details >}} Introduced in GitLab 17.9. Status: Experiment. {{< /details >}}

Input type: CustomFieldArchiveInput

Arguments

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
id IssuablesCustomFieldID! Global ID of the custom field.

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
customField CustomField Archived custom field.
errors [String!]! Errors encountered during execution of the mutation.

Mutation.customFieldCreate

{{< details >}} Introduced in GitLab 17.6. Status: Experiment. {{< /details >}}

Input type: CustomFieldCreateInput

Arguments

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
fieldType CustomFieldType! Type of custom field.
groupPath ID! Group path where the custom field is created.
name String! 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

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
customField CustomField Created custom field.
errors [String!]! Errors encountered during execution of the mutation.

Mutation.customFieldUnarchive

{{< details >}} Introduced in GitLab 17.9. Status: Experiment. {{< /details >}}

Input type: CustomFieldUnarchiveInput

Arguments

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
id IssuablesCustomFieldID! Global ID of the custom field.

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
customField CustomField Unarchived custom field.
errors [String!]! Errors encountered during execution of the mutation.

Mutation.customFieldUpdate

{{< details >}} Introduced in GitLab 17.6. Status: Experiment. {{< /details >}}

Input type: CustomFieldUpdateInput

Arguments

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
id IssuablesCustomFieldID! Global ID of the custom field.
name String 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

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
customField CustomField Updated custom field.
errors [String!]! Errors encountered during execution of the mutation.

Mutation.customerRelationsContactCreate

Input type: CustomerRelationsContactCreateInput

Arguments

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
description String Description of or notes for the contact.
email String Email address of the contact.
firstName String! First name of the contact.
groupId GroupID! Group for the contact.
lastName String! Last name of the contact.
organizationId CustomerRelationsOrganizationID Organization for the contact.
phone String Phone number of the contact.

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
contact CustomerRelationsContact Contact after the mutation.
errors [String!]! Errors encountered during execution of the mutation.

Mutation.customerRelationsContactUpdate

Input type: CustomerRelationsContactUpdateInput

Arguments

Name Type Description
active Boolean State of the contact.
clientMutationId String A unique identifier for the client performing the mutation.
description String Description of or notes for the contact.
email String Email address of the contact.
firstName String First name of the contact.
id CustomerRelationsContactID! Global ID of the contact.
lastName String Last name of the contact.
organizationId CustomerRelationsOrganizationID Organization of the contact.
phone String Phone number of the contact.

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
contact CustomerRelationsContact Contact after the mutation.
errors [String!]! Errors encountered during execution of the mutation.

Mutation.customerRelationsOrganizationCreate

Input type: CustomerRelationsOrganizationCreateInput

Arguments

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
defaultRate Float Standard billing rate for the organization.
description String Description of or notes for the organization.
groupId GroupID! Group for the organization.
name String! Name of the organization.

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.
organization CustomerRelationsOrganization Organization after the mutation.

Mutation.customerRelationsOrganizationUpdate

Input type: CustomerRelationsOrganizationUpdateInput

Arguments

Name Type Description
active Boolean State of the organization.
clientMutationId String A unique identifier for the client performing the mutation.
defaultRate Float Standard billing rate for the organization.
description String Description of or notes for the organization.
id CustomerRelationsOrganizationID! Global ID of the organization.
name String Name of the organization.

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.
organization CustomerRelationsOrganization! Organization after the mutation.

Mutation.dastOnDemandScanCreate

Input type: DastOnDemandScanCreateInput

Arguments

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
dastScannerProfileId DastScannerProfileID ID of the scanner profile to be used for the scan.
dastSiteProfileId DastSiteProfileID! ID of the site profile to be used for the scan.
fullPath ID! Project the site profile belongs to.

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.
pipelineUrl String URL of the pipeline that was created.

Mutation.dastProfileCreate

Input type: DastProfileCreateInput

Arguments

Name Type Description
branchName String Associated branch.
clientMutationId String A unique identifier for the client performing the mutation.
dastProfileSchedule DastProfileScheduleInput Represents a DAST Profile Schedule.
dastScannerProfileId DastScannerProfileID! ID of the scanner profile to be associated.
dastSiteProfileId DastSiteProfileID! ID of the site profile to be associated.
description String Description of the profile. Defaults to an empty string.
fullPath ID! Project the profile belongs to.
name String! Name of the profile.
runAfterCreate Boolean Run scan using profile after creation. Defaults to false.
tagList [String!] Indicates the runner tags associated with the profile.

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
dastProfile DastProfile Created profile.
errors [String!]! Errors encountered during execution of the mutation.
pipelineUrl String URL of the pipeline that was created. Requires runAfterCreate to be set to true.

Mutation.dastProfileDelete

Input type: DastProfileDeleteInput

Arguments

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
id DastProfileID! ID of the profile to be deleted.

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.

Mutation.dastProfileRun

Input type: DastProfileRunInput

Arguments

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
fullPath {{< icon name=”warning-solid” >}} ID Deprecated: Full path not required to qualify Global ID. Deprecated in GitLab 14.5.
id DastProfileID! ID of the profile to be used for the scan.

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.
pipelineUrl String URL of the pipeline that was created.

Mutation.dastProfileUpdate

Input type: DastProfileUpdateInput

Arguments

Name Type Description
branchName String Associated branch.
clientMutationId String A unique identifier for the client performing the mutation.
dastProfileSchedule DastProfileScheduleInput Represents a DAST profile schedule.
dastScannerProfileId DastScannerProfileID ID of the scanner profile to be associated.
dastSiteProfileId DastSiteProfileID ID of the site profile to be associated.
description String Description of the profile. Defaults to an empty string.
fullPath {{< icon name=”warning-solid” >}} ID Deprecated: Full path not required to qualify Global ID. Deprecated in GitLab 14.5.
id DastProfileID! ID of the profile to be deleted.
name String Name of the profile.
runAfterUpdate Boolean Run scan using profile after update. Defaults to false.
tagList [String!] Indicates the runner tags associated with the profile.

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
dastProfile DastProfile Updated profile.
errors [String!]! Errors encountered during execution of the mutation.
pipelineUrl String The URL of the pipeline that was created. Requires the input argument runAfterUpdate to be set to true when calling the mutation, otherwise no pipeline will be created.

Mutation.dastScannerProfileCreate

Input type: DastScannerProfileCreateInput

Arguments

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
fullPath ID! Project the scanner profile belongs to.
profileName String! Name of the scanner profile.
scanType DastScanTypeEnum Indicates the type of DAST scan that will run. Either a Passive Scan or an Active Scan.
showDebugMessages Boolean Indicates if debug messages should be included in DAST console output. True to include the debug messages.
spiderTimeout Int Maximum number of minutes allowed for the spider to traverse the site.
tagList {{< icon name=”warning-solid” >}} [String!] Deprecated: Moved to DastProfile. Deprecated in GitLab 15.8.
targetTimeout Int Maximum number of seconds allowed for the site under test to respond to a request.
useAjaxSpider Boolean Indicates if the AJAX spider should be used to crawl the target site. True to run the AJAX spider in addition to the traditional spider, and false to run only the traditional spider.

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
dastScannerProfile DastScannerProfile Created scanner profile.
errors [String!]! Errors encountered during execution of the mutation.
id {{< icon name=”warning-solid” >}} DastScannerProfileID Deprecated: use dastScannerProfile field. Deprecated in GitLab 14.10.

Mutation.dastScannerProfileDelete

Input type: DastScannerProfileDeleteInput

Arguments

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
fullPath {{< icon name=”warning-solid” >}} ID Deprecated: Full path not required to qualify Global ID. Deprecated in GitLab 14.5.
id DastScannerProfileID! ID of the scanner profile to be deleted.

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.

Mutation.dastScannerProfileUpdate

Input type: DastScannerProfileUpdateInput

Arguments

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

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
dastScannerProfile DastScannerProfile Updated scanner profile.
errors [String!]! Errors encountered during execution of the mutation.
id {{< icon name=”warning-solid” >}} DastScannerProfileID Deprecated: use dastScannerProfile field. Deprecated in GitLab 14.10.

Mutation.dastSiteProfileCreate

Input type: DastSiteProfileCreateInput

Arguments

Name Type Description
auth DastSiteProfileAuthInput Parameters for authentication.
clientMutationId String A unique identifier for the client performing the mutation.
excludedUrls [String!] URLs to skip during an authenticated scan. Defaults to [].
fullPath ID! Project the site profile belongs to.
optionalVariables [JSON!] Optional variables that can be configured for DAST scans.
profileName String! Name of the site profile.
requestHeaders String Comma-separated list of request header names and values to be added to every request made by DAST.
scanFilePath String File Path or URL used as input for the scan method.
scanMethod DastScanMethodType Scan method by the scanner.
targetType DastTargetTypeEnum Type of target to be scanned.
targetUrl String URL of the target to be scanned.

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
dastSiteProfile DastSiteProfile Site Profile object.
errors [String!]! Errors encountered during execution of the mutation.
id {{< icon name=”warning-solid” >}} DastSiteProfileID Deprecated: use dastSiteProfile.id field. Deprecated in GitLab 14.10.

Mutation.dastSiteProfileDelete

Input type: DastSiteProfileDeleteInput

Arguments

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
fullPath {{< icon name=”warning-solid” >}} ID Deprecated: Full path not required to qualify Global ID. Deprecated in GitLab 14.5.
id DastSiteProfileID! ID of the site profile to be deleted.

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.

Mutation.dastSiteProfileUpdate

Input type: DastSiteProfileUpdateInput

Arguments

Name Type Description
auth DastSiteProfileAuthInput Parameters for authentication.
clientMutationId String A unique identifier for the client performing the mutation.
excludedUrls [String!] URLs to skip during an authenticated scan.
fullPath {{< icon name=”warning-solid” >}} ID Deprecated: Full path not required to qualify Global ID. Deprecated in GitLab 14.5.
id DastSiteProfileID! ID of the site profile to be updated.
optionalVariables [JSON!] Optional variables that can be configured for DAST scans.
profileName String! Name of the site profile.
requestHeaders String Comma-separated list of request header names and values to be added to every request made by DAST.
scanFilePath String File Path or URL used as input for the scan method.
scanMethod DastScanMethodType Scan method by the scanner.
targetType DastTargetTypeEnum Type of target to be scanned.
targetUrl String URL of the target to be scanned.

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
dastSiteProfile DastSiteProfile Site profile object.
errors [String!]! Errors encountered during execution of the mutation.
id {{< icon name=”warning-solid” >}} DastSiteProfileID Deprecated: use dastSiteProfile.id field. Deprecated in GitLab 14.10.

Mutation.dastSiteTokenCreate

Input type: DastSiteTokenCreateInput

Arguments

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
fullPath ID! Project the site token belongs to.
targetUrl String URL of the target to be validated.

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.
id DastSiteTokenID ID of the site token.
status DastSiteProfileValidationStatusEnum Current validation status of the target.
token String Token string.

Mutation.dastSiteValidationCreate

Input type: DastSiteValidationCreateInput

Arguments

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
dastSiteTokenId DastSiteTokenID! ID of the site token.
fullPath ID! Project the site profile belongs to.
strategy DastSiteValidationStrategyEnum Validation strategy to be used.
validationPath String! Path to be requested during validation.

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.
id DastSiteValidationID ID of the site validation.
status DastSiteProfileValidationStatusEnum Current validation status.

Mutation.dastSiteValidationRevoke

Input type: DastSiteValidationRevokeInput

Arguments

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

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.

Mutation.deleteAnnotation

{{< details >}} Deprecated in GitLab 16.0. Underlying feature was removed in 16.0. {{< /details >}}

Input type: DeleteAnnotationInput

Arguments

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
id String! Global ID of the annotation to delete.

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.

Mutation.deleteContainerProtectionRepositoryRule

Deletes a container repository protection rule.

Input type: DeleteContainerProtectionRepositoryRuleInput

Arguments

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
id ContainerRegistryProtectionRuleID! Global ID of the container repository protection rule to delete.

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
containerProtectionRepositoryRule ContainerProtectionRepositoryRule Container 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.

{{< details >}} Introduced in GitLab 17.8. Status: Experiment. {{< /details >}}

Input type: DeleteContainerProtectionTagRuleInput

Arguments

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
id ContainerRegistryProtectionTagRuleID! Global ID of the tag protection rule to delete.

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
containerProtectionTagRule {{< icon name=”warning-solid” >}} ContainerProtectionTagRule Deprecated: Status: Experiment. Introduced in GitLab 17.8.
errors [String!]! Errors encountered during execution of the mutation.

Mutation.deleteConversationThread

{{< details >}} Introduced in GitLab 17.9. Status: Experiment. {{< /details >}}

Input type: DeleteConversationThreadInput

Arguments

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
threadId AiConversationThreadID! Global ID of the thread to delete.

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! List of errors that occurred whilst trying to delete the thread.
success Boolean! Returns true if thread was successfully deleted.

Mutation.deletePackagesProtectionRule

Deletes a protection rule for packages.

Input type: DeletePackagesProtectionRuleInput

Arguments

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
id PackagesProtectionRuleID! Global ID of the package protection rule to delete.

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.
packageProtectionRule PackagesProtectionRule Packages protection rule that was deleted successfully.

Mutation.deletePagesDeployment

Deletes a Pages deployment.

{{< details >}} Introduced in GitLab 17.1. Status: Experiment. {{< /details >}}

Input type: DeletePagesDeploymentInput

Arguments

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
id PagesDeploymentID! ID of the Pages Deployment.

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.
pagesDeployment PagesDeployment! Deleted Pages Deployment.

Mutation.designManagementDelete

Input type: DesignManagementDeleteInput

Arguments

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

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.
version DesignVersion New version in which the designs are deleted.

Mutation.designManagementMove

Input type: DesignManagementMoveInput

Arguments

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
id DesignManagementDesignID! ID of the design to move.
next DesignManagementDesignID ID of the immediately following design.
previous DesignManagementDesignID ID of the immediately preceding design.

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
designCollection DesignCollection Current state of the collection.
errors [String!]! Errors encountered during execution of the mutation.

Mutation.designManagementUpdate

Input type: DesignManagementUpdateInput

Arguments

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
description String Description of the design.
id DesignManagementDesignID! ID of the design to update.

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
design Design! Updated design.
errors [String!]! Errors encountered during execution of the mutation.

Mutation.designManagementUpload

Input type: DesignManagementUploadInput

Arguments

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

Fields

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

Mutation.destroyBoard

Input type: DestroyBoardInput

Arguments

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
id BoardID! Global ID of the board to destroy.

Fields

Name Type Description
board Board Board after mutation.
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.

Mutation.destroyBoardList

Input type: DestroyBoardListInput

Arguments

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
listId ListID! Global ID of the list to destroy. Only label lists are accepted.

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.
list BoardList List after mutation.

Mutation.destroyComplianceFramework

Input type: DestroyComplianceFrameworkInput

Arguments

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
id ComplianceManagementFrameworkID! Global ID of the compliance framework to destroy.

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.

Mutation.destroyComplianceRequirement

{{< details >}} Introduced in GitLab 17.7. Status: Experiment. {{< /details >}}

Input type: DestroyComplianceRequirementInput

Arguments

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
id ComplianceManagementComplianceFrameworkComplianceRequirementID! Global ID of the compliance requirement to destroy.

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.

Mutation.destroyComplianceRequirementsControl

{{< details >}} Introduced in GitLab 17.9. Status: Experiment. {{< /details >}}

Input type: DestroyComplianceRequirementsControlInput

Arguments

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
id ComplianceManagementComplianceFrameworkComplianceRequirementsControlID! Global ID of the compliance requirement control to destroy.

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.

Mutation.destroyContainerRepository

Input type: DestroyContainerRepositoryInput

Arguments

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
id ContainerRepositoryID! ID of the container repository.

Fields

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

Mutation.destroyContainerRepositoryTags

Input type: DestroyContainerRepositoryTagsInput

Arguments

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

Fields

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

Mutation.destroyCustomEmoji

Input type: DestroyCustomEmojiInput

Arguments

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
id CustomEmojiID! Global ID of the custom emoji to destroy.

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
customEmoji CustomEmoji Deleted custom emoji.
errors [String!]! Errors encountered during execution of the mutation.

Mutation.destroyEpicBoard

{{< details >}} Deprecated in GitLab 17.5. Replaced by WorkItem type. {{< /details >}}

Input type: DestroyEpicBoardInput

Arguments

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
id BoardsEpicBoardID! Global ID of the board to destroy.

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
epicBoard EpicBoard Epic board after mutation.
errors [String!]! Errors encountered during execution of the mutation.

Mutation.destroyNote

Input type: DestroyNoteInput

Arguments

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
id NoteID! Global ID of the note to destroy.

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.
note Note Note after mutation.
quickActionsStatus QuickActionsStatus Status of quick actions after mutation.

Mutation.destroyPackage

Input type: DestroyPackageInput

Arguments

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
id PackagesPackageID! ID of the Package.

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.

Mutation.destroyPackageFile

Input type: DestroyPackageFileInput

Arguments

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
id PackagesPackageFileID! ID of the Package file.

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.

Mutation.destroyPackageFiles

Input type: DestroyPackageFilesInput

Arguments

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

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.

Mutation.destroyPackages

Input type: DestroyPackagesInput

Arguments

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
ids [PackagesPackageID!]! Global IDs of the Packages. Max 100.

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.

Mutation.destroySnippet

Input type: DestroySnippetInput

Arguments

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
id SnippetID! Global ID of the snippet to destroy.

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.
snippet Snippet Snippet after mutation.

Mutation.disableDevopsAdoptionNamespace

Status: Beta.

Input type: DisableDevopsAdoptionNamespaceInput

Arguments

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
id [AnalyticsDevopsAdoptionEnabledNamespaceID!]! One or many IDs of the enabled namespaces to disable.

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.

Mutation.discussionToggleResolve

Toggles the resolved state of a discussion.

Input type: DiscussionToggleResolveInput

Arguments

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
id DiscussionID! Global ID of the discussion.
resolve Boolean! Will resolve the discussion when true, and unresolve the discussion when false.

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
discussion Discussion Discussion after mutation.
errors [String!]! Errors encountered during execution of the mutation.

Mutation.duoSettingsUpdate

Updates GitLab Duo settings.

{{< details >}} Introduced in GitLab 17.9. Status: Experiment. {{< /details >}}

Input type: DuoSettingsUpdateInput

Arguments

Name Type Description
aiGatewayUrl String URL for local AI gateway server.
clientMutationId String A unique identifier for the client performing the mutation.
duoCoreFeaturesEnabled Boolean Indicates whether GitLab Duo Core features are enabled.

Fields

Name Type Description
aiGatewayUrl String URL for local AI gateway server.
clientMutationId String A unique identifier for the client performing the mutation.
duoCoreFeaturesEnabled {{< icon name=”warning-solid” >}} Boolean Deprecated: Status: Experiment. Introduced in GitLab 18.0.
errors [String!]! Errors encountered during execution of the mutation.

Mutation.duoUserFeedback

{{< details >}} Introduced in GitLab 16.10. Status: Experiment. {{< /details >}}

Input type: DuoUserFeedbackInput

Arguments

Name Type Description
agentVersionId AiAgentVersionID Global ID of the agent to answer the chat.
aiMessageId String! ID of the AI Message.
clientMutationId String A unique identifier for the client performing the mutation.
trackingEvent TrackingEventInput Tracking event data.

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.

Mutation.echoCreate

A mutation that does not perform any changes.

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

Input type: EchoCreateInput

Arguments

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!] Errors to return to the user.
messages [String!] Messages to return to the user.

Fields

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

Mutation.enableDevopsAdoptionNamespace

Status: Beta.

Input type: EnableDevopsAdoptionNamespaceInput

Arguments

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
displayNamespaceId NamespaceID Display namespace ID.
namespaceId NamespaceID! Namespace ID.

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
enabledNamespace DevopsAdoptionEnabledNamespace Enabled namespace after mutation.
errors [String!]! Errors encountered during execution of the mutation.

Mutation.environmentCreate

Create an environment.

Input type: EnvironmentCreateInput

Arguments

Name Type Description
autoStopSetting AutoStopSetting Auto stop setting of the environment.
clientMutationId String A unique identifier for the client performing the mutation.
clusterAgentId ClustersAgentID Cluster agent of the environment.
description String Description of the environment.
externalUrl String External URL of the environment.
fluxResourcePath String Flux resource path of the environment.
kubernetesNamespace String Kubernetes namespace of the environment.
name String! Name of the environment.
projectPath ID! Full path of the project.
tier DeploymentTier Tier of the environment.

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
environment Environment Created environment.
errors [String!]! Errors encountered during execution of the mutation.

Mutation.environmentDelete

Delete an environment.

Input type: EnvironmentDeleteInput

Arguments

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
id EnvironmentID! Global ID of the environment to Delete.

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.

Mutation.environmentStop

Stop an environment.

Input type: EnvironmentStopInput

Arguments

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
force Boolean Force environment to stop without executing on_stop actions.
id EnvironmentID! Global ID of the environment to stop.

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
environment Environment Environment after attempt to stop.
errors [String!]! Errors encountered during execution of the mutation.

Mutation.environmentUpdate

Update an environment.

Input type: EnvironmentUpdateInput

Arguments

Name Type Description
autoStopSetting AutoStopSetting Auto stop setting of the environment.
clientMutationId String A unique identifier for the client performing the mutation.
clusterAgentId ClustersAgentID Cluster agent of the environment.
description String Description of the environment.
externalUrl String External URL of the environment.
fluxResourcePath String Flux resource path of the environment.
id EnvironmentID! Global ID of the environment to update.
kubernetesNamespace String Kubernetes namespace of the environment.
tier DeploymentTier Tier of the environment.

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
environment Environment Environment after attempt to update.
errors [String!]! Errors encountered during execution of the mutation.

Mutation.environmentsCanaryIngressUpdate

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

Input type: EnvironmentsCanaryIngressUpdateInput

Arguments

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
id EnvironmentID! Global ID of the environment to update.
weight Int! Weight of the Canary Ingress.

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.

Mutation.epicAddIssue

{{< details >}} Deprecated in GitLab 17.5. Replaced by WorkItem type. {{< /details >}}

Input type: EpicAddIssueInput

Arguments

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

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
epic Epic Epic after mutation.
epicIssue EpicIssue Epic-issue relationship.
errors [String!]! Errors encountered during execution of the mutation.

Mutation.epicBoardCreate

{{< details >}} Deprecated in GitLab 17.5. Replaced by WorkItem type. {{< /details >}}

Input type: EpicBoardCreateInput

Arguments

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
displayColors Boolean Whether or not display epic colors.
groupPath ID Full path of the group with which the resource is associated.
hideBacklogList Boolean Whether or not backlog list is hidden.
hideClosedList Boolean Whether or not closed list is hidden.
labelIds [LabelID!] IDs of labels to be added to the board.
labels [String!] Labels of the issue.
name String Board name.

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
epicBoard EpicBoard Created epic board.
errors [String!]! Errors encountered during execution of the mutation.

Mutation.epicBoardListCreate

{{< details >}} Deprecated in GitLab 17.5. Replaced by WorkItem type. {{< /details >}}

Input type: EpicBoardListCreateInput

Arguments

Name Type Description
backlog Boolean Create the backlog list.
boardId BoardsEpicBoardID! Global ID of the issue board to mutate.
clientMutationId String A unique identifier for the client performing the mutation.
labelId LabelID Global ID of an existing label.

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.
list EpicList Epic list in the epic board.

Mutation.epicBoardListDestroy

Destroys an epic board list.

{{< details >}} Deprecated in GitLab 17.5. Replaced by WorkItem type. {{< /details >}}

Input type: EpicBoardListDestroyInput

Arguments

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
listId BoardsEpicListID! Global ID of the epic board list to destroy.

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.
list EpicList Epic board list. null if the board was destroyed successfully.

Mutation.epicBoardUpdate

{{< details >}} Deprecated in GitLab 17.5. Replaced by WorkItem type. {{< /details >}}

Input type: EpicBoardUpdateInput

Arguments

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
displayColors Boolean Whether or not display epic colors.
hideBacklogList Boolean Whether or not backlog list is hidden.
hideClosedList Boolean Whether or not closed list is hidden.
id BoardsEpicBoardID! Epic board global ID.
labelIds [LabelID!] IDs of labels to be added to the board.
labels [String!] Labels of the issue.
name String Board name.

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
epicBoard EpicBoard Updated epic board.
errors [String!]! Errors encountered during execution of the mutation.

Mutation.epicMoveList

{{< details >}} Deprecated in GitLab 17.5. Replaced by WorkItem type. {{< /details >}}

Input type: EpicMoveListInput

Arguments

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

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
epic Epic Epic after mutation.
errors [String!]! Errors encountered during execution of the mutation.

Mutation.epicSetSubscription

{{< details >}} Deprecated in GitLab 17.5. Replaced by WorkItem type. {{< /details >}}

Input type: EpicSetSubscriptionInput

Arguments

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
groupPath ID! Group the epic to mutate belongs to.
iid ID! IID of the epic to mutate.
subscribedState Boolean! Desired state of the subscription.

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
epic Epic Epic after mutation.
errors [String!]! Errors encountered during execution of the mutation.

Mutation.epicTreeReorder

{{< details >}} Deprecated in GitLab 17.5. Replaced by WorkItem type. {{< /details >}}

Input type: EpicTreeReorderInput

Arguments

Name Type Description
baseEpicId EpicID! ID of the base epic of the tree.
clientMutationId String A unique identifier for the client performing the mutation.
moved EpicTreeNodeFieldsInputType! Parameters for updating the tree positions.

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.

Mutation.escalationPolicyCreate

Input type: EscalationPolicyCreateInput

Arguments

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

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.
escalationPolicy EscalationPolicyType Escalation policy.

Mutation.escalationPolicyDestroy

Input type: EscalationPolicyDestroyInput

Arguments

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
id IncidentManagementEscalationPolicyID! Escalation policy internal ID to remove.

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.
escalationPolicy EscalationPolicyType Escalation policy.

Mutation.escalationPolicyUpdate

Input type: EscalationPolicyUpdateInput

Arguments

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
description String Description of the escalation policy.
id IncidentManagementEscalationPolicyID! ID of the on-call schedule to create the on-call rotation in.
name String Name of the escalation policy.
rules [EscalationRuleInput!] Steps of the escalation policy.

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.
escalationPolicy EscalationPolicyType Escalation policy.

Mutation.exportRequirements

Input type: ExportRequirementsInput

Arguments

Name Type Description
authorUsername [String!] Filter requirements by author username.
clientMutationId String A unique identifier for the client performing the mutation.
projectPath ID! Full project path the requirements are associated with.
search String Search query for requirement title.
selectedFields [String!] List of selected requirements fields to be exported.
sort Sort List requirements by sort order.
state RequirementState Filter requirements by state.

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.

Mutation.externalAuditEventDestinationCreate

Input type: ExternalAuditEventDestinationCreateInput

Arguments

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
destinationUrl String! Destination URL.
groupPath ID! Group path.
name String Destination name.
verificationToken String Verification token.

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.
externalAuditEventDestination ExternalAuditEventDestination Destination created.

Mutation.externalAuditEventDestinationDestroy

Input type: ExternalAuditEventDestinationDestroyInput

Arguments

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
id AuditEventsExternalAuditEventDestinationID! ID of external audit event destination to destroy.

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.

Mutation.externalAuditEventDestinationUpdate

Input type: ExternalAuditEventDestinationUpdateInput

Arguments

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
destinationUrl String Destination URL to change.
id AuditEventsExternalAuditEventDestinationID! ID of external audit event destination to update.
name String Destination name.

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.
externalAuditEventDestination ExternalAuditEventDestination Updated destination.

Mutation.geoRegistriesBulkUpdate

Mutates multiple Geo registries for a given registry class.

{{< details >}} Introduced in GitLab 16.4. Status: Experiment. {{< /details >}}

Input type: GeoRegistriesBulkUpdateInput

Arguments

Name Type Description
action GeoRegistriesBulkAction! Action to be executed on Geo registries.
clientMutationId String A unique identifier for the client performing the mutation.
registryClass GeoRegistryClass! Class of the Geo registries to be updated.

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.
registryClass GeoRegistryClass Updated Geo registry class.

Mutation.geoRegistriesUpdate

Mutates a Geo registry.

{{< details >}} Introduced in GitLab 16.1. Status: Experiment. {{< /details >}}

Input type: GeoRegistriesUpdateInput

Arguments

Name Type Description
action GeoRegistryAction! Action to be executed on a Geo registry.
clientMutationId String A unique identifier for the client performing the mutation.
registryId GeoBaseRegistryID! ID of the Geo registry entry to be updated.

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.
registry Registrable Updated Geo registry entry.

Mutation.gitlabSubscriptionActivate

Input type: GitlabSubscriptionActivateInput

Arguments

Name Type Description
activationCode String! Activation code received after purchasing a GitLab subscription.
clientMutationId String A unique identifier for the client performing the mutation.

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.
futureSubscriptions [SubscriptionFutureEntry!] Array of future subscriptions.
license CurrentLicense Current license.

Mutation.googleCloudLoggingConfigurationCreate

Input type: GoogleCloudLoggingConfigurationCreateInput

Arguments

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

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.
googleCloudLoggingConfiguration GoogleCloudLoggingConfigurationType configuration created.

Mutation.googleCloudLoggingConfigurationDestroy

Input type: GoogleCloudLoggingConfigurationDestroyInput

Arguments

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
id AuditEventsGoogleCloudLoggingConfigurationID! ID of the Google Cloud logging configuration to destroy.

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.

Mutation.googleCloudLoggingConfigurationUpdate

Input type: GoogleCloudLoggingConfigurationUpdateInput

Arguments

Name Type Description
clientEmail String Email address associated with the service account that will be used to authenticate and interact with the Google Cloud Logging service. This is part of the IAM credentials.
clientMutationId String A unique identifier for the client performing the mutation.
googleProjectIdName String Unique identifier of the Google Cloud project to which the logging configuration belongs.
id AuditEventsGoogleCloudLoggingConfigurationID! ID of the google Cloud configuration to update.
logIdName String Unique identifier used to distinguish and manage different logs within the same Google Cloud project.
name String Destination name.
privateKey String Private Key associated with the service account. This key is used to authenticate the service account and authorize it to interact with the Google Cloud Logging service.

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.
googleCloudLoggingConfiguration GoogleCloudLoggingConfigurationType configuration updated.

Mutation.groupAuditEventStreamingDestinationsCreate

{{< details >}} Introduced in GitLab 16.11. Status: Experiment. {{< /details >}}

Input type: GroupAuditEventStreamingDestinationsCreateInput

Arguments

Name Type Description
category String! Destination category.
clientMutationId String A unique identifier for the client performing the mutation.
config JSON! Destination config.
groupPath ID! Group path.
name String Destination name.
secretToken String Secret token.

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.
externalAuditEventDestination GroupAuditEventStreamingDestination Destination created.

Mutation.groupAuditEventStreamingDestinationsDelete

{{< details >}} Introduced in GitLab 16.11. Status: Experiment. {{< /details >}}

Input type: GroupAuditEventStreamingDestinationsDeleteInput

Arguments

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
id AuditEventsGroupExternalStreamingDestinationID! ID of the audit events external streaming destination to delete.

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.

Mutation.groupAuditEventStreamingDestinationsUpdate

{{< details >}} Introduced in GitLab 16.11. Status: Experiment. {{< /details >}}

Input type: GroupAuditEventStreamingDestinationsUpdateInput

Arguments

Name Type Description
category String Destination category.
clientMutationId String A unique identifier for the client performing the mutation.
config JSON Destination config.
id AuditEventsGroupExternalStreamingDestinationID! ID of external audit event destination to update.
name String Destination name.
secretToken String Secret token.

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.
externalAuditEventDestination GroupAuditEventStreamingDestination Updated destination.

Mutation.groupMemberBulkUpdate

Input type: GroupMemberBulkUpdateInput

Arguments

Name Type Description
accessLevel MemberAccessLevel! Access level to update the members to.
clientMutationId String A unique identifier for the client performing the mutation.
expiresAt Time Date and time the membership expires.
groupId GroupID! Global ID of the group.
userIds [UserID!]! Global IDs of the members.

Fields

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

Mutation.groupMembersExport

{{< details >}} Introduced in GitLab 17.4. Status: Experiment. {{< /details >}}

Input type: GroupMembersExportInput

Arguments

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
groupId GroupID! Global ID of the group.

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.
message String Export request result message.

Mutation.groupSavedReplyCreate

{{< details >}} Introduced in GitLab 16.10. Status: Experiment. {{< /details >}}

Input type: GroupSavedReplyCreateInput

Arguments

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
content String! Content of the saved reply.
groupId GroupID! Group for the save reply.
name String! Name of the saved reply.

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.
savedReply GroupSavedReply Saved reply after mutation.

Mutation.groupSavedReplyDestroy

{{< details >}} Introduced in GitLab 16.10. Status: Experiment. {{< /details >}}

Input type: GroupSavedReplyDestroyInput

Arguments

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
id GroupsSavedReplyID! Global ID of the group-level saved reply.

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.
savedReply GroupSavedReply Saved reply after mutation.

Mutation.groupSavedReplyUpdate

{{< details >}} Introduced in GitLab 16.10. Status: Experiment. {{< /details >}}

Input type: GroupSavedReplyUpdateInput

Arguments

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
content String! Content of the saved reply.
id GroupsSavedReplyID! Global ID of the group-level saved reply.
name String! Name of the saved reply.

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.
savedReply GroupSavedReply Saved reply after mutation.

Mutation.groupUpdate

Input type: GroupUpdateInput

Arguments

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
duoFeaturesEnabled Boolean Indicates whether GitLab Duo features are enabled for the group. Introduced in GitLab 16.10: Status: Experiment.
fullPath ID! Full path of the group that will be updated.
lockDuoFeaturesEnabled Boolean Indicates if the GitLab Duo features enabled setting is enforced for all subgroups. Introduced in GitLab 16.10: Status: Experiment.
lockMathRenderingLimitsEnabled Boolean Indicates if math rendering limits are locked for all descendant groups.
mathRenderingLimitsEnabled Boolean Indicates if math rendering limits are used for the group.
name String Name of the group.
path String Path of the namespace.
sharedRunnersSetting SharedRunnersSetting Shared runners availability for the namespace and its descendants.
visibility VisibilityLevelsEnum Visibility of the namespace.

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.
group Group Group after update.

Mutation.httpIntegrationCreate

Input type: HttpIntegrationCreateInput

Arguments

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

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.
integration AlertManagementHttpIntegration HTTP integration.

Mutation.httpIntegrationDestroy

Input type: HttpIntegrationDestroyInput

Arguments

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
id AlertManagementHttpIntegrationID! ID of the integration to remove.

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.
integration AlertManagementHttpIntegration HTTP integration.

Mutation.httpIntegrationResetToken

Input type: HttpIntegrationResetTokenInput

Arguments

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
id AlertManagementHttpIntegrationID! ID of the integration to mutate.

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.
integration AlertManagementHttpIntegration HTTP integration.

Mutation.httpIntegrationUpdate

Input type: HttpIntegrationUpdateInput

Arguments

Name Type Description
active Boolean Whether the integration is receiving alerts.
clientMutationId String A unique identifier for the client performing the mutation.
id AlertManagementHttpIntegrationID! ID of the integration to mutate.
name String Name of the integration.
payloadAttributeMappings [AlertManagementPayloadAlertFieldInput!] Custom mapping of GitLab alert attributes to fields from the payload example.
payloadExample JsonString Example of an alert payload.

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.
integration AlertManagementHttpIntegration HTTP integration.

Mutation.importSourceUserCancelReassignment

{{< details >}} Introduced in GitLab 17.2. Status: Experiment. {{< /details >}}

Input type: ImportSourceUserCancelReassignmentInput

Arguments

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
id ImportSourceUserID! Global ID of the mapping of a user on source instance to a user on destination instance.

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.
importSourceUser ImportSourceUser Mapping of a user on source instance to a user on destination instance after mutation.

Mutation.importSourceUserKeepAllAsPlaceholder

{{< details >}} Introduced in GitLab 17.6. Status: Experiment. {{< /details >}}

Input type: ImportSourceUserKeepAllAsPlaceholderInput

Arguments

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
namespaceId NamespaceID! Global ID of the namespace.

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.
updatedImportSourceUserCount Int Number of successfully updated mappings of users on source instance to their destination users.

Mutation.importSourceUserKeepAsPlaceholder

{{< details >}} Introduced in GitLab 17.2. Status: Experiment. {{< /details >}}

Input type: ImportSourceUserKeepAsPlaceholderInput

Arguments

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
id ImportSourceUserID! Global ID of the mapping of a user on source instance to a user on destination instance.

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.
importSourceUser ImportSourceUser Mapping of a user on source instance to a user on destination instance after mutation.

Mutation.importSourceUserReassign

{{< details >}} Introduced in GitLab 17.2. Status: Experiment. {{< /details >}}

Input type: ImportSourceUserReassignInput

Arguments

Name Type Description
assigneeUserId UserID! Global ID of the assignee user.
clientMutationId String A unique identifier for the client performing the mutation.
id ImportSourceUserID! Global ID of the mapping of a user on source instance to a user on destination instance.

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.
importSourceUser ImportSourceUser Mapping of a user on source instance to a user on destination instance after mutation.

Mutation.importSourceUserResendNotification

{{< details >}} Introduced in GitLab 17.2. Status: Experiment. {{< /details >}}

Input type: ImportSourceUserResendNotificationInput

Arguments

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
id ImportSourceUserID! Global ID of the mapping of a user on source instance to a user on destination instance.

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.
importSourceUser ImportSourceUser Mapping of a user on source instance to a user on destination instance after mutation.

Mutation.instanceAuditEventStreamingDestinationsCreate

{{< details >}} Introduced in GitLab 16.11. Status: Experiment. {{< /details >}}

Input type: InstanceAuditEventStreamingDestinationsCreateInput

Arguments

Name Type Description
category String! Destination category.
clientMutationId String A unique identifier for the client performing the mutation.
config JSON! Destination config.
name String Destination name.
secretToken String Secret token.

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.
externalAuditEventDestination InstanceAuditEventStreamingDestination Destination created.

Mutation.instanceAuditEventStreamingDestinationsDelete

{{< details >}} Introduced in GitLab 16.11. Status: Experiment. {{< /details >}}

Input type: InstanceAuditEventStreamingDestinationsDeleteInput

Arguments

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
id AuditEventsInstanceExternalStreamingDestinationID! ID of the audit events external streaming destination to delete.

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.

Mutation.instanceAuditEventStreamingDestinationsUpdate

{{< details >}} Introduced in GitLab 16.11. Status: Experiment. {{< /details >}}

Input type: InstanceAuditEventStreamingDestinationsUpdateInput

Arguments

Name Type Description
category String Destination category.
clientMutationId String A unique identifier for the client performing the mutation.
config JSON Destination config.
id AuditEventsInstanceExternalStreamingDestinationID! ID of external audit event destination to update.
name String Destination name.
secretToken String Secret token.

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.
externalAuditEventDestination InstanceAuditEventStreamingDestination Updated destination.

Mutation.instanceExternalAuditEventDestinationCreate

Input type: InstanceExternalAuditEventDestinationCreateInput

Arguments

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
destinationUrl String! Destination URL.
name String Destination name.

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.
instanceExternalAuditEventDestination InstanceExternalAuditEventDestination Destination created.

Mutation.instanceExternalAuditEventDestinationDestroy

Input type: InstanceExternalAuditEventDestinationDestroyInput

Arguments

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
id AuditEventsInstanceExternalAuditEventDestinationID! ID of the external instance audit event destination to destroy.

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.

Mutation.instanceExternalAuditEventDestinationUpdate

Input type: InstanceExternalAuditEventDestinationUpdateInput

Arguments

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
destinationUrl String Destination URL to change.
id AuditEventsInstanceExternalAuditEventDestinationID! ID of the external instance audit event destination to update.
name String Destination name.

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.
instanceExternalAuditEventDestination InstanceExternalAuditEventDestination Updated destination.

Mutation.instanceGoogleCloudLoggingConfigurationCreate

Input type: InstanceGoogleCloudLoggingConfigurationCreateInput

Arguments

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

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.
instanceGoogleCloudLoggingConfiguration InstanceGoogleCloudLoggingConfigurationType configuration created.

Mutation.instanceGoogleCloudLoggingConfigurationDestroy

Input type: InstanceGoogleCloudLoggingConfigurationDestroyInput

Arguments

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
id AuditEventsInstanceGoogleCloudLoggingConfigurationID! ID of the Google Cloud logging configuration to destroy.

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.

Mutation.instanceGoogleCloudLoggingConfigurationUpdate

Input type: InstanceGoogleCloudLoggingConfigurationUpdateInput

Arguments

Name Type Description
clientEmail String Email address associated with the service account that will be used to authenticate and interact with the Google Cloud Logging service. This is part of the IAM credentials.
clientMutationId String A unique identifier for the client performing the mutation.
googleProjectIdName String Unique identifier of the Google Cloud project to which the logging configuration belongs.
id AuditEventsInstanceGoogleCloudLoggingConfigurationID! ID of the instance google Cloud configuration to update.
logIdName String Unique identifier used to distinguish and manage different logs within the same Google Cloud project.
name String Destination name.
privateKey String Private Key associated with the service account. This key is used to authenticate the service account and authorize it to interact with the Google Cloud Logging service.

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.
instanceGoogleCloudLoggingConfiguration InstanceGoogleCloudLoggingConfigurationType configuration updated.

Mutation.integrationExclusionCreate

{{< details >}} Introduced in GitLab 17.0. Status: Experiment. {{< /details >}}

Input type: IntegrationExclusionCreateInput

Arguments

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
groupIds [GroupID!] IDs of groups to exclude up to a maximum of 100.
integrationName IntegrationType! Type of integration to exclude.
projectIds [ProjectID!] IDs of projects to exclude up to a maximum of 100.

Fields

Name Type Description
clientMutationId String A 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

{{< details >}} Introduced in GitLab 17.0. Status: Experiment. {{< /details >}}

Input type: IntegrationExclusionDeleteInput

Arguments

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
groupIds [GroupID!] IDs of excluded groups.
integrationName IntegrationType! Type of integration.
projectIds [ProjectID!] IDs of excluded projects.

Fields

Name Type Description
clientMutationId String A 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

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
id IssueID! Incident id to associate the resource link with.
link String! Link of the resource.
linkText String Link text of the resource.
linkType IssuableResourceLinkType Link type of the resource.

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.
issuableResourceLink IssuableResourceLink Issuable resource link.

Mutation.issuableResourceLinkDestroy

Input type: IssuableResourceLinkDestroyInput

Arguments

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
id IncidentManagementIssuableResourceLinkID! Issuable resource link ID to remove.

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.
issuableResourceLink IssuableResourceLink Issuable resource link.

Mutation.issueLinkAlerts

Input type: IssueLinkAlertsInput

Arguments

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

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.
issue Issue Issue after mutation.

Mutation.issueMove

Input type: IssueMoveInput

Arguments

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

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.
issue Issue Issue after mutation.

Mutation.issueMoveList

Input type: IssueMoveListInput

Arguments

Name Type Description
boardId BoardID! Global ID of the board that the issue is in.
clientMutationId String A unique identifier for the client performing the mutation.
epicId {{< icon name=”warning-solid” >}} EpicID Deprecated: This will be replaced by WorkItem hierarchyWidget. Deprecated in GitLab 17.5.
fromListId ID ID of the board list that the issue will be moved from.
iid String! IID of the issue to mutate.
moveAfterId ID ID of issue that should be placed after the current issue.
moveBeforeId ID ID of issue that should be placed before the current issue.
positionInList Int Position of issue within the board list. Positions start at 0. Use -1 to move to the end of the list.
projectPath ID! Project the issue to mutate is in.
toListId ID ID of the board list that the issue will be moved to.

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.
issue Issue Issue after mutation.

Mutation.issueSetAssignees

Input type: IssueSetAssigneesInput

Arguments

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

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.
issue Issue Issue after mutation.

Mutation.issueSetConfidential

Input type: IssueSetConfidentialInput

Arguments

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

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.
issue Issue Issue after mutation.

Mutation.issueSetCrmContacts

Input type: IssueSetCrmContactsInput

Arguments

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

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.
issue Issue Issue after mutation.

Mutation.issueSetDueDate

Input type: IssueSetDueDateInput

Arguments

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
dueDate Time Desired due date for the issue. Due date is removed if null.
iid String! IID of the issue to mutate.
projectPath ID! Project the issue to mutate is in.

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.
issue Issue Issue after mutation.

Mutation.issueSetEpic

{{< details >}} Deprecated in GitLab 17.5. Replaced by WorkItem type. {{< /details >}}

Input type: IssueSetEpicInput

Arguments

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
epicId {{< icon name=”warning-solid” >}} EpicID Deprecated: This will be replaced by WorkItem hierarchyWidget. Deprecated in GitLab 17.5.
iid String! IID of the issue to mutate.
projectPath ID! Project the issue to mutate is in.

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.
issue Issue Issue after mutation.

Mutation.issueSetEscalationPolicy

Input type: IssueSetEscalationPolicyInput

Arguments

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
escalationPolicyId IncidentManagementEscalationPolicyID Global ID of the escalation policy to assign to the issue. Policy will be removed if absent or set to null.
iid String! IID of the issue to mutate.
projectPath ID! Project the issue to mutate is in.

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.
issue Issue Issue after mutation.

Mutation.issueSetEscalationStatus

Input type: IssueSetEscalationStatusInput

Arguments

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

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.
issue Issue Issue after mutation.

Mutation.issueSetIteration

Input type: IssueSetIterationInput

Arguments

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
iid String! IID of the issue to mutate.
iterationId IterationID Iteration to assign to the issue.
projectPath ID! Project the issue to mutate is in.

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.
issue Issue Issue after mutation.

Mutation.issueSetLocked

Input type: IssueSetLockedInput

Arguments

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

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.
issue Issue Issue after mutation.

Mutation.issueSetSeverity

Input type: IssueSetSeverityInput

Arguments

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

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.
issue Issue Issue after mutation.

Mutation.issueSetSubscription

Input type: IssueSetSubscriptionInput

Arguments

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

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.
issue Issue Issue after mutation.

Mutation.issueSetWeight

Input type: IssueSetWeightInput

Arguments

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
iid String! IID of the issue to mutate.
projectPath ID! Project the issue to mutate is in.
weight Int The desired weight for the issue. If set to null, weight is removed.

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.
issue Issue Issue after mutation.

Mutation.issueUnlinkAlert

Input type: IssueUnlinkAlertInput

Arguments

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

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.
issue Issue Issue after mutation.

Mutation.issuesBulkUpdate

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

{{< details >}} Introduced in GitLab 15.9. Status: Experiment. {{< /details >}}

Input type: IssuesBulkUpdateInput

Arguments

Name Type Description
addLabelIds [LabelID!] Global ID array of the labels that will be added to the issues.
assigneeIds [UserID!] Global ID array of the users that will be assigned to the given issues. Existing assignees will be replaced with the ones on this list.
clientMutationId String A unique identifier for the client performing the mutation.
epicId {{< icon name=”warning-solid” >}} EpicID Deprecated: This will be replaced by WorkItem hierarchyWidget. Deprecated in GitLab 17.5.
healthStatus HealthStatus Health status that will be assigned to the issues.
ids [IssueID!]! Global ID array of the issues that will be updated. IDs that the user can’t update will be ignored. A max of 100 can be provided.
iterationId IterationID Global ID of the iteration that will be assigned to the issues.
milestoneId MilestoneID Global ID of the milestone that will be assigned to the issues.
parentId IssueParentID! Global ID of the parent to which the bulk update will be scoped. The parent can be a project. 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.
stateEvent IssueStateEvent Close or reopen an issue.
subscriptionEvent IssuableSubscriptionEvent Subscribe to or unsubscribe from issue notifications.

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.
updatedIssueCount Int Number of issues that were successfully updated.

Mutation.iterationCadenceCreate

Input type: IterationCadenceCreateInput

Arguments

Name Type Description
active Boolean! Whether the iteration cadence is active.
automatic Boolean! Whether the iteration cadence should automatically generate upcoming iterations.
clientMutationId String A unique identifier for the client performing the mutation.
description String Description of the iteration cadence. Maximum length is 5000 characters.
durationInWeeks Int Duration in weeks of the iterations within the cadence.
groupPath ID! Group where the iteration cadence is created.
iterationsInAdvance Int Upcoming iterations to be created when iteration cadence is set to automatic.
rollOver Boolean Whether the iteration cadence should roll over issues to the next iteration or not.
startDate Time Timestamp of the automation start date.
title String Title of the iteration cadence.

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.
iterationCadence IterationCadence Created iteration cadence.

Mutation.iterationCadenceDestroy

Input type: IterationCadenceDestroyInput

Arguments

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
id IterationsCadenceID! Global ID of the iteration cadence.

Fields

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

Mutation.iterationCadenceUpdate

Input type: IterationCadenceUpdateInput

Arguments

Name Type Description
active Boolean Whether the iteration cadence is active.
automatic Boolean Whether the iteration cadence should automatically generate upcoming iterations.
clientMutationId String A unique identifier for the client performing the mutation.
description String Description of the iteration cadence. Maximum length is 5000 characters.
durationInWeeks Int Duration in weeks of the iterations within the cadence.
id IterationsCadenceID! Global ID of the iteration cadence.
iterationsInAdvance Int Upcoming iterations to be created when iteration cadence is set to automatic.
rollOver Boolean Whether the iteration cadence should roll over issues to the next iteration or not.
startDate Time Timestamp of the automation start date.
title String Title of the iteration cadence.

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.
iterationCadence IterationCadence Updated iteration cadence.

Mutation.iterationCreate

Input type: iterationCreateInput

Arguments

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
description String Description of the iteration.
dueDate String End date of the iteration.
groupPath ID Full path of the group with which the resource is associated.
iterationsCadenceId IterationsCadenceID Global ID of the iteration cadence to be assigned to the new iteration.
projectPath ID Full path of the project with which the resource is associated.
startDate String Start date of the iteration.
title String Title of the iteration.

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.
iteration Iteration Created iteration.

Mutation.iterationDelete

Input type: IterationDeleteInput

Arguments

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
id IterationID! ID of the iteration.

Fields

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

Mutation.jiraImportStart

Input type: JiraImportStartInput

Arguments

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
jiraProjectKey String! Project key of the importer Jira project.
jiraProjectName {{< icon name=”warning-solid” >}} String Deprecated: Argument is not used. Deprecated in GitLab 17.4.
projectPath ID! Project to import the Jira project into.
usersMapping [JiraUsersMappingInputType!] Mapping of Jira to GitLab users.

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.
jiraImport JiraImport Jira import data after mutation.

Mutation.jiraImportUsers

Input type: JiraImportUsersInput

Arguments

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
projectPath ID! Project to import the Jira users into.
startAt Int Index of the record the import should started at, default 0 (50 records returned).

Fields

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

Mutation.jobArtifactsDestroy

Input type: JobArtifactsDestroyInput

Arguments

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
id CiBuildID! ID of the job to mutate.

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
destroyedArtifactsCount Int! Number of artifacts deleted.
errors [String!]! Errors encountered during execution of the mutation.
job CiJob Job with artifacts to be deleted.

Mutation.jobCancel

Input type: JobCancelInput

Arguments

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
id CiBuildID! ID of the job to mutate.

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.
job CiJob Job after the mutation.

Mutation.jobPlay

Input type: JobPlayInput

Arguments

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
id CiProcessableID! ID of the job to mutate.
variables [CiVariableInput!] Variables to use when playing a manual job.

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.
job CiJob Job after the mutation.

Mutation.jobRetry

Input type: JobRetryInput

Arguments

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
id CiProcessableID! ID of the job to mutate.
variables [CiVariableInput!] Variables to use when retrying a manual job.

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.
job CiJob Job after the mutation.

Mutation.jobUnschedule

Input type: JobUnscheduleInput

Arguments

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
id CiBuildID! ID of the job to mutate.

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.
job CiJob Job after the mutation.

Mutation.labelCreate

Input type: LabelCreateInput

Arguments

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
color String The color of the label given in 6-digit hex notation with leading ‘#’ sign (for example, #FFAABB) or one of the CSS color names.
description String Description of the label.
groupPath ID Full path of the group with which the resource is associated.
projectPath ID Full path of the project with which the resource is associated.
title String! Title of the label.

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.
label Label Label after mutation.

Mutation.ldapAdminRoleLinkCreate

Creates an instance-level custom admin role LDAP link.

{{< details >}} Introduced in GitLab 17.11. Status: Experiment. {{< /details >}}

Input type: LdapAdminRoleLinkCreateInput

Arguments

Name Type Description
adminMemberRoleId MemberRoleID! Global ID of the custom admin role to be assigned to a user.
clientMutationId String A unique identifier for the client performing the mutation.
cn String Common Name (CN) of the LDAP group.
filter String Search filter for the LDAP group.
provider String! LDAP provider for the LDAP link.

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.
ldapAdminRoleLink LdapAdminRoleLink Created instance-level LDAP link.

Mutation.ldapAdminRoleLinkDestroy

Destroys an instance-level custom admin role LDAP link.

{{< details >}} Introduced in GitLab 18.0. Status: Experiment. {{< /details >}}

Input type: LdapAdminRoleLinkDestroyInput

Arguments

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
id AuthzLdapAdminRoleLinkID! Global ID of the instance-level LDAP link to delete.

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.
ldapAdminRoleLink LdapAdminRoleLink Deleted instance-level LDAP link.

Mutation.markAsSpamSnippet

Input type: MarkAsSpamSnippetInput

Arguments

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
id SnippetID! Global ID of the snippet to update.

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.
snippet Snippet Snippet after mutation.

Mutation.memberRoleAdminCreate

{{< details >}} Introduced in GitLab 17.7. Status: Experiment. {{< /details >}}

Input type: MemberRoleAdminCreateInput

Arguments

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
description String Description of the member role.
name String Name of the member role.
permissions [MemberRoleAdminPermission!] List of all customizable admin permissions.

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.
memberRole AdminMemberRole Member role.

Mutation.memberRoleAdminDelete

{{< details >}} Introduced in GitLab 17.10. Status: Experiment. {{< /details >}}

Input type: MemberRoleAdminDeleteInput

Arguments

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
id MemberRoleID! ID of the admin member role to delete.

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.
memberRole MemberRole Deleted admin member role.

Mutation.memberRoleAdminUpdate

{{< details >}} Introduced in GitLab 17.10. Status: Experiment. {{< /details >}}

Input type: MemberRoleAdminUpdateInput

Arguments

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
description String Description of the member role.
id MemberRoleID! ID of the member role to mutate.
name String Name of the member role.
permissions [MemberRoleAdminPermission!] List of all customizable admin permissions.

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.
memberRole AdminMemberRole Member role.

Mutation.memberRoleCreate

{{< details >}} Introduced in GitLab 16.5. Status: Experiment. {{< /details >}}

Input type: MemberRoleCreateInput

Arguments

Name Type Description
baseAccessLevel MemberRolesAccessLevel! Base access level for the custom role.
clientMutationId String A unique identifier for the client performing the mutation.
description String Description of the member role.
groupPath ID Group the member role to mutate is in. Required for SaaS.
name String Name of the member role.
permissions [MemberRolePermission!] List of all customizable permissions.

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.
memberRole MemberRole Member role.

Mutation.memberRoleDelete

{{< details >}} Introduced in GitLab 16.7. Status: Experiment. {{< /details >}}

Input type: MemberRoleDeleteInput

Arguments

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
id MemberRoleID! ID of the member role to delete.

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.
memberRole MemberRole Deleted member role.

Mutation.memberRoleToUserAssign

{{< details >}} Introduced in GitLab 17.7. Status: Experiment. {{< /details >}}

Input type: MemberRoleToUserAssignInput

Arguments

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
memberRoleId MemberRoleID Global 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.
userId UserID! Global ID of the user to be assigned to a custom role.

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.
userMemberRole UserMemberRole Created user member role or nil if the relation was deleted.

Mutation.memberRoleUpdate

Input type: MemberRoleUpdateInput

Arguments

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
description String Description of the member role.
id MemberRoleID! ID of the member role to mutate.
name String Name of the member role.
permissions [MemberRolePermission!] List of all customizable permissions.

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.
memberRole MemberRole Member role.

Mutation.mergeRequestAccept

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

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

Input type: MergeRequestAcceptInput

Arguments

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
commitMessage String Custom merge commit message.
iid String! IID of the merge request to mutate.
projectPath ID! Project the merge request to mutate is in.
sha String! HEAD SHA at the time when the merge was requested.
shouldRemoveSourceBranch Boolean Should the source branch be removed.
squash Boolean Squash commits on the source branch before merge.
squashCommitMessage String Custom squash commit message (if squash is true).
strategy MergeStrategyEnum How to merge the merge request.

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.
mergeRequest MergeRequest Merge request after mutation.

Mutation.mergeRequestCreate

Input type: MergeRequestCreateInput

Arguments

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
description String Description of the merge request (Markdown rendered as HTML for caching).
labels [String!] Labels of the merge request.
mergeAfter Time Date after which the merge request can be merged.
projectPath ID! Project full path the merge request is associated with.
sourceBranch String! Source branch of the merge request.
targetBranch String! Target branch of the merge request.
title String! Title of the merge request.

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.
mergeRequest MergeRequest Merge request after mutation.

Mutation.mergeRequestDestroyRequestedChanges

Input type: MergeRequestDestroyRequestedChangesInput

Arguments

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
iid String! IID of the merge request to mutate.
projectPath ID! Project the merge request to mutate is in.

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.
mergeRequest MergeRequest Merge request after mutation.

Mutation.mergeRequestReviewerRereview

Input type: MergeRequestReviewerRereviewInput

Arguments

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

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.
mergeRequest MergeRequest Merge request after mutation.

Mutation.mergeRequestSetAssignees

Input type: MergeRequestSetAssigneesInput

Arguments

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

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.
mergeRequest MergeRequest Merge request after mutation.

Mutation.mergeRequestSetDraft

Input type: MergeRequestSetDraftInput

Arguments

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

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.
mergeRequest MergeRequest Merge request after mutation.

Mutation.mergeRequestSetLabels

Input type: MergeRequestSetLabelsInput

Arguments

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

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.
mergeRequest MergeRequest Merge request after mutation.

Mutation.mergeRequestSetLocked

Input type: MergeRequestSetLockedInput

Arguments

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

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.
mergeRequest MergeRequest Merge request after mutation.

Mutation.mergeRequestSetMilestone

Input type: MergeRequestSetMilestoneInput

Arguments

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
iid String! IID of the merge request to mutate.
milestoneId MilestoneID Milestone to assign to the merge request.
projectPath ID! Project the merge request to mutate is in.

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.
mergeRequest MergeRequest Merge request after mutation.

Mutation.mergeRequestSetReviewers

Input type: MergeRequestSetReviewersInput

Arguments

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

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.
mergeRequest MergeRequest Merge request after mutation.

Mutation.mergeRequestSetSubscription

Input type: MergeRequestSetSubscriptionInput

Arguments

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

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.
mergeRequest MergeRequest Merge request after mutation.

Mutation.mergeRequestUpdate

Update attributes of a merge request.

Input type: MergeRequestUpdateInput

Arguments

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
description String Description of the merge request (Markdown rendered as HTML for caching).
iid String! IID of the merge request to mutate.
mergeAfter Time Date after which the merge request can be merged.
overrideRequestedChanges Boolean Override all requested changes. Can only be set by users who have permissionto merge this merge request.
projectPath ID! Project the merge request to mutate is in.
state MergeRequestNewState Action to perform to change the state.
targetBranch String Target branch of the merge request.
timeEstimate String Estimated time to complete the merge request. Use null or 0 to remove the current estimate.
title String Title of the merge request.

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.
mergeRequest MergeRequest Merge request after mutation.

Mutation.mergeRequestUpdateApprovalRule

Input type: MergeRequestUpdateApprovalRuleInput

Arguments

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

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.
mergeRequest MergeRequest Merge request after mutation.

Mutation.mergeTrainsDeleteCar

{{< details >}} Introduced in GitLab 17.2. Status: Experiment. {{< /details >}}

Input type: MergeTrainsDeleteCarInput

Arguments

Name Type Description
carId MergeTrainsCarID! Global ID of the car.
clientMutationId String A unique identifier for the client performing the mutation.

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.

Mutation.mlModelCreate

{{< details >}} Introduced in GitLab 16.8. Status: Experiment. {{< /details >}}

Input type: MlModelCreateInput

Arguments

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
description String Description of the model.
name String! Name of the model.
projectPath ID! Project the model to mutate is in.

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.
model MlModel Model after mutation.

Mutation.mlModelDelete

{{< details >}} Introduced in GitLab 17.0. Status: Experiment. {{< /details >}}

Input type: MlModelDeleteInput

Arguments

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
id MlModelID! Global ID of the model to be deleted.
projectPath ID! Project the model to mutate is in.

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.
model MlModel Model after mutation.

Mutation.mlModelDestroy

{{< details >}} Introduced in GitLab 16.10. Status: Experiment. {{< /details >}}

Input type: MlModelDestroyInput

Arguments

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
id MlModelID! Global ID of the model to be deleted.
projectPath ID! Project the model to mutate is in.

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.
message String Model deletion result message.
model MlModel Model after mutation.

Mutation.mlModelEdit

{{< details >}} Introduced in GitLab 17.3. Status: Experiment. {{< /details >}}

Input type: MlModelEditInput

Arguments

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
description String Description of the model.
modelId Int Id of the model.
name String! Name of the model.
projectPath ID! Project the model to mutate is in.

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.
model MlModel Model after mutation.

Mutation.mlModelVersionCreate

{{< details >}} Introduced in GitLab 17.1. Status: Experiment. {{< /details >}}

Input type: MlModelVersionCreateInput

Arguments

Name Type Description
candidateId MlCandidateID Global ID of a candidate to promote optionally.
clientMutationId String A unique identifier for the client performing the mutation.
description String Description of the model version.
modelId MlModelID! Global ID of the model the version belongs to.
projectPath ID! Project the model to mutate is in.
version String Model version.

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.
modelVersion MlModelVersion Model after mutation.

Mutation.mlModelVersionDelete

{{< details >}} Introduced in GitLab 17.0. Status: Experiment. {{< /details >}}

Input type: MlModelVersionDeleteInput

Arguments

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
id MlModelVersionID! Global ID of the model version to be deleted.

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.
modelVersion MlModelVersion Deleted model version.

Mutation.mlModelVersionEdit

{{< details >}} Introduced in GitLab 17.4. Status: Experiment. {{< /details >}}

Input type: MlModelVersionEditInput

Arguments

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
description String! Description of the model version.
modelId MlModelID! Global ID of the model the version belongs to.
projectPath ID! Project the model to mutate is in.
version String! Model version.

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.
modelVersion MlModelVersion Model after mutation.

Mutation.namespaceBanDestroy

Input type: NamespaceBanDestroyInput

Arguments

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
id NamespacesNamespaceBanID! Global ID of the namespace ban to remove.

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.
namespaceBan NamespaceBan Namespace Ban.

Mutation.namespaceCiCdSettingsUpdate

Input type: NamespaceCiCdSettingsUpdateInput

Arguments

Name Type Description
allowStaleRunnerPruning Boolean Indicates if stale runners directly belonging to the namespace should be periodically pruned.
clientMutationId String A unique identifier for the client performing the mutation.
fullPath ID! Full path of the namespace the settings belong to.

Fields

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

Mutation.namespaceCreateRemoteDevelopmentClusterAgentMapping

Input type: NamespaceCreateRemoteDevelopmentClusterAgentMappingInput

Arguments

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
clusterAgentId ClustersAgentID! GlobalID of the cluster agent to be associated with the namespace.
namespaceId NamespaceID! GlobalID of the namespace to be associated with the cluster agent.

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.
namespaceClusterAgentMapping {{< icon name=”warning-solid” >}} NamespaceClusterAgentMapping Deprecated: Status: Experiment. Introduced in GitLab 17.10.

Mutation.namespaceDeleteRemoteDevelopmentClusterAgentMapping

Input type: NamespaceDeleteRemoteDevelopmentClusterAgentMappingInput

Arguments

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
clusterAgentId ClustersAgentID! GlobalID of the cluster agent to be un-associated from the namespace.
namespaceId NamespaceID! GlobalID of the namespace to be un-associated from the cluster agent.

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.
namespaceClusterAgentMapping {{< icon name=”warning-solid” >}} NamespaceClusterAgentMapping Deprecated: Status: Experiment. Introduced in GitLab 17.11.

Mutation.namespaceSettingsUpdate

{{< details >}} Introduced in GitLab 17.9. Status: Experiment. {{< /details >}}

Input type: NamespaceSettingsUpdateInput

Arguments

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
fullPath ID! Full path of the namespace the settings belong to.
pipelineVariablesDefaultRole PipelineVariablesDefaultRoleType Indicates the default minimum role required to override pipeline variables in the namespace.

Fields

Name Type Description
ciCdSettings CiCdSettings! Namespace CI/CD settings after mutation.
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.

Mutation.noteConvertToThread

Convert a standard comment to a resolvable thread.

Input type: NoteConvertToThreadInput

Arguments

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
id NoteID! Global ID of the Note to convert.

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.
note Note Note after mutation.
quickActionsStatus QuickActionsStatus Status of quick actions after mutation.

Mutation.oncallRotationCreate

Input type: OncallRotationCreateInput

Arguments

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

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.
oncallRotation IncidentManagementOncallRotation On-call rotation.

Mutation.oncallRotationDestroy

Input type: OncallRotationDestroyInput

Arguments

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

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.
oncallRotation IncidentManagementOncallRotation On-call rotation.

Mutation.oncallRotationUpdate

Input type: OncallRotationUpdateInput

Arguments

Name Type Description
activePeriod OncallRotationActivePeriodInputType Active period of time that the on-call rotation should take place.
clientMutationId String A unique identifier for the client performing the mutation.
endsAt OncallRotationDateInputType End date and time of the on-call rotation, in the timezone of the on-call schedule.
id IncidentManagementOncallRotationID! ID of the on-call schedule to create the on-call rotation in.
name String Name of the on-call rotation.
participants [OncallUserInputType!] Usernames of users participating in the on-call rotation. A maximum limit of 100 participants applies.
rotationLength OncallRotationLengthInputType Rotation length of the on-call rotation.
startsAt OncallRotationDateInputType Start date and time of the on-call rotation, in the timezone of the on-call schedule.

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.
oncallRotation IncidentManagementOncallRotation On-call rotation.

Mutation.oncallScheduleCreate

Input type: OncallScheduleCreateInput

Arguments

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

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.
oncallSchedule IncidentManagementOncallSchedule On-call schedule.

Mutation.oncallScheduleDestroy

Input type: OncallScheduleDestroyInput

Arguments

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

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.
oncallSchedule IncidentManagementOncallSchedule On-call schedule.

Mutation.oncallScheduleUpdate

Input type: OncallScheduleUpdateInput

Arguments

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
description String Description of the on-call schedule.
iid String! On-call schedule internal ID to update.
name String Name of the on-call schedule.
projectPath ID! Project to update the on-call schedule in.
timezone String Timezone of the on-call schedule.

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.
oncallSchedule IncidentManagementOncallSchedule On-call schedule.

Mutation.organizationCreate

{{< details >}} Introduced in GitLab 16.6. Status: Experiment. {{< /details >}}

Input type: OrganizationCreateInput

Arguments

Name Type Description
avatar Upload Avatar for the organization.
clientMutationId String A unique identifier for the client performing the mutation.
description String Description of the organization.
name String! Name for the organization.
path String! Path for the organization.

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.
organization Organization Organization after mutation.

Mutation.organizationCreateClusterAgentMapping

{{< details >}} Introduced in GitLab 17.11. Status: Experiment. {{< /details >}}

Input type: OrganizationCreateClusterAgentMappingInput

Arguments

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
clusterAgentId ClustersAgentID! GlobalID of the cluster agent to be associated with the organization.
organizationId OrganizationsOrganizationID! GlobalID of the organization to be associated with the cluster agent.

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.

Mutation.organizationDeleteClusterAgentMapping

{{< details >}} Introduced in GitLab 17.11. Status: Experiment. {{< /details >}}

Input type: OrganizationDeleteClusterAgentMappingInput

Arguments

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
clusterAgentId ClustersAgentID! GlobalID of the cluster agent to be dissociated with the organization.
organizationId OrganizationsOrganizationID! GlobalID of the organization to be dissociated with the cluster agent.

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.

Mutation.organizationUpdate

{{< details >}} Introduced in GitLab 16.7. Status: Experiment. {{< /details >}}

Input type: OrganizationUpdateInput

Arguments

Name Type Description
avatar Upload Avatar for the organization.
clientMutationId String A unique identifier for the client performing the mutation.
description String Description of the organization.
id OrganizationsOrganizationID! ID of the organization to mutate.
name String Name for the organization.
path String Path for the organization.

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.
organization Organization Organization after mutation.

Mutation.organizationUserUpdate

{{< details >}} Introduced in GitLab 17.5. Status: Experiment. {{< /details >}}

Input type: OrganizationUserUpdateInput

Arguments

Name Type Description
accessLevel OrganizationUserAccessLevel! Access level to update the organization user to.
clientMutationId String A unique identifier for the client performing the mutation.
id OrganizationsOrganizationUserID! ID of the organization user to mutate.

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.
organizationUser {{< icon name=”warning-solid” >}} OrganizationUser Deprecated: Status: Experiment. Introduced in GitLab 17.5.

Mutation.pagesMarkOnboardingComplete

Input type: PagesMarkOnboardingCompleteInput

Arguments

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
projectPath ID! Full path of the project.

Fields

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

Mutation.pipelineCancel

Input type: PipelineCancelInput

Arguments

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
id CiPipelineID! ID of the pipeline to mutate.

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.

Mutation.pipelineCreate

Input type: PipelineCreateInput

Arguments

Name Type Description
async {{< icon name=”warning-solid” >}} Boolean Deprecated: Status: Experiment. Introduced in GitLab 17.8.
clientMutationId String A unique identifier for the client performing the mutation.
inputs {{< icon name=”warning-solid” >}} [CiInputsInput!] Deprecated: Status: Experiment. Introduced in GitLab 17.10.
projectPath ID! Full path of the project that is triggering the pipeline.
ref String! Ref on which to run the pipeline.
variables [CiVariableInput!] Variables for the pipeline.

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.
pipeline Pipeline Pipeline created after mutation. Null if async: true.
requestId {{< icon name=”warning-solid” >}} String Deprecated: Status: Experiment. Introduced in GitLab 17.8.

Mutation.pipelineDestroy

Input type: PipelineDestroyInput

Arguments

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
id CiPipelineID! ID of the pipeline to mutate.

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.

Mutation.pipelineRetry

Input type: PipelineRetryInput

Arguments

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
id CiPipelineID! ID of the pipeline to mutate.

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.
pipeline Pipeline Pipeline after mutation.

Mutation.pipelineScheduleCreate

Input type: PipelineScheduleCreateInput

Arguments

Name Type Description
active Boolean Indicates if the pipeline schedule should be active or not.
clientMutationId String A unique identifier for the client performing the mutation.
cron String! Cron expression of the pipeline schedule.
cronTimezone String Cron time zone supported by ActiveSupport::TimeZone. For example: “Pacific Time (US & Canada)” (default: “UTC”).
description String! Description of the pipeline schedule.
inputs {{< icon name=”warning-solid” >}} [CiInputsInput!] Deprecated: Status: Experiment. Introduced in GitLab 17.10.
projectPath ID! Full path of the project the pipeline schedule is associated with.
ref String! Ref of the pipeline schedule.
variables [PipelineScheduleVariableInput!] Variables for the pipeline schedule.

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.
pipelineSchedule PipelineSchedule Created pipeline schedule.

Mutation.pipelineScheduleDelete

Input type: PipelineScheduleDeleteInput

Arguments

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
id CiPipelineScheduleID! ID of the pipeline schedule to mutate.

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.

Mutation.pipelineSchedulePlay

Input type: PipelineSchedulePlayInput

Arguments

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
id CiPipelineScheduleID! ID of the pipeline schedule to mutate.

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.
pipelineSchedule PipelineSchedule Pipeline schedule after mutation.

Mutation.pipelineScheduleTakeOwnership

Input type: PipelineScheduleTakeOwnershipInput

Arguments

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
id CiPipelineScheduleID! ID of the pipeline schedule to mutate.

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.
pipelineSchedule PipelineSchedule Updated pipeline schedule ownership.

Mutation.pipelineScheduleUpdate

Input type: PipelineScheduleUpdateInput

Arguments

Name Type Description
active Boolean Indicates if the pipeline schedule should be active or not.
clientMutationId String A unique identifier for the client performing the mutation.
cron String Cron expression of the pipeline schedule.
cronTimezone String Cron time zone supported by ActiveSupport::TimeZone. For example: “Pacific Time (US & Canada)” (default: “UTC”).
description String Description of the pipeline schedule.
id CiPipelineScheduleID! ID of the pipeline schedule to mutate.
inputs {{< icon name=”warning-solid” >}} [CiInputsInput!] Deprecated: Status: Experiment. Introduced in GitLab 17.11.
ref String Ref of the pipeline schedule.
variables [PipelineScheduleVariableInput!] Variables for the pipeline schedule.

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.
pipelineSchedule PipelineSchedule Updated pipeline schedule.

Mutation.pipelineTriggerCreate

{{< details >}} Introduced in GitLab 16.3. Status: Experiment. {{< /details >}}

Input type: PipelineTriggerCreateInput

Arguments

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
description String! Description of the pipeline trigger token.
expiresAt Time Timestamp of when the pipeline trigger token expires.
projectPath ID! Full path of the project that the pipeline trigger token to mutate is in.

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.
pipelineTrigger PipelineTrigger Mutated pipeline trigger token.

Mutation.pipelineTriggerDelete

{{< details >}} Introduced in GitLab 16.3. Status: Experiment. {{< /details >}}

Input type: PipelineTriggerDeleteInput

Arguments

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
id CiTriggerID! ID of the pipeline trigger token to delete.

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.

Mutation.pipelineTriggerUpdate

{{< details >}} Introduced in GitLab 16.3. Status: Experiment. {{< /details >}}

Input type: PipelineTriggerUpdateInput

Arguments

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
description String! Description of the pipeline trigger token.
id CiTriggerID! ID of the pipeline trigger token to update.

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.
pipelineTrigger PipelineTrigger Mutated pipeline trigger token.

Mutation.processUserBillablePromotionRequest

{{< details >}} Introduced in GitLab 17.2. Status: Experiment. {{< /details >}}

Input type: ProcessUserBillablePromotionRequestInput

Arguments

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
status MemberApprovalStatusType! Status for the member approval request (approved, denied, pending).
userId UserID! Global ID of user to be promoted.

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.
result UserPromotionStatusType Status of the user promotion process (success, partial_success, failed).

Mutation.productAnalyticsProjectSettingsUpdate

Input type: ProductAnalyticsProjectSettingsUpdateInput

Arguments

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
cubeApiBaseUrl String Base URL for the Cube API.
cubeApiKey String API key for the Cube API.
fullPath ID! Full path of the project the settings belong to.
productAnalyticsConfiguratorConnectionString String Connection string for the product analytics configurator.
productAnalyticsDataCollectorHost String Host for the product analytics data collector.

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
cubeApiBaseUrl String Base URL for the Cube API.
cubeApiKey String API key for the Cube API.
errors [String!]! Errors encountered during execution of the mutation.
productAnalyticsConfiguratorConnectionString String Connection string for the product analytics configurator.
productAnalyticsDataCollectorHost String Host for the product analytics data collector.

Mutation.projectBlobsRemove

{{< details >}} Introduced in GitLab 17.1. Status: Experiment. {{< /details >}}

Input type: projectBlobsRemoveInput

Arguments

Name Type Description
blobOids [String!]! List of blob oids.
clientMutationId String A unique identifier for the client performing the mutation.
projectPath ID! Full path of the project to replace.

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.

Mutation.projectCiCdSettingsUpdate

Input type: ProjectCiCdSettingsUpdateInput

Arguments

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
fullPath ID! Full Path of the project the settings belong to.
inboundJobTokenScopeEnabled Boolean Indicates CI/CD job tokens generated in other projects have restricted access to this project.
jobTokenScopeEnabled {{< icon name=”warning-solid” >}} Boolean Deprecated: Outbound job token scope is being removed. This field can now only be set to false. Deprecated in GitLab 16.0.
keepLatestArtifact Boolean Indicates if the latest artifact should be kept for the project.
mergePipelinesEnabled Boolean Indicates if merged results pipelines are enabled for the project.
mergeTrainsEnabled Boolean Indicates if merge trains are enabled for the project.
mergeTrainsSkipTrainAllowed Boolean Indicates whether an option is allowed to merge without refreshing the merge train. Ignored unless the merge_trains_skip_train feature flag is also enabled.
pipelineVariablesMinimumOverrideRole String Minimum role required to set variables when creating a pipeline or running a job.
pushRepositoryForJobTokenAllowed Boolean Indicates the ability to push to the original project repository using a job token.

Fields

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

Mutation.projectInitializeProductAnalytics

Input type: ProjectInitializeProductAnalyticsInput

Arguments

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
projectPath ID! Full path of the project to initialize.

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.
project Project Project on which the initialization took place.

Mutation.projectMemberBulkUpdate

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

Input type: ProjectMemberBulkUpdateInput

Arguments

Name Type Description
accessLevel MemberAccessLevel! Access level to update the members to.
clientMutationId String A unique identifier for the client performing the mutation.
expiresAt Time Date and time the membership expires.
projectId ProjectID! Global ID of the project.
userIds [UserID!]! Global IDs of the members.

Fields

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

Mutation.projectSavedReplyCreate

{{< details >}} Introduced in GitLab 16.11. Status: Experiment. {{< /details >}}

Input type: ProjectSavedReplyCreateInput

Arguments

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
content String! Content of the saved reply.
name String! Name of the saved reply.
projectId ProjectID! Project for the saved reply.

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.
savedReply ProjectSavedReply Saved reply after mutation.

Mutation.projectSavedReplyDestroy

{{< details >}} Introduced in GitLab 16.11. Status: Experiment. {{< /details >}}

Input type: ProjectSavedReplyDestroyInput

Arguments

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
id ProjectsSavedReplyID! Global ID of the project-level saved reply.

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.
savedReply ProjectSavedReply Saved reply after mutation.

Mutation.projectSavedReplyUpdate

{{< details >}} Introduced in GitLab 16.11. Status: Experiment. {{< /details >}}

Input type: ProjectSavedReplyUpdateInput

Arguments

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
content String! Content of the saved reply.
id ProjectsSavedReplyID! Global ID of the project-level saved reply.
name String! Name of the saved reply.

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.
savedReply ProjectSavedReply Saved reply after mutation.

Mutation.projectSecretCreate

Input type: ProjectSecretCreateInput

Arguments

Name Type Description
branch String! Branches that can access the secret.
clientMutationId String A unique identifier for the client performing the mutation.
description String Description of the project secret.
environment String! Environments that can access the secret.
name String! Name of the project secret.
projectPath ID! Project of the secret.
value String! Value of the project secret.

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.
projectSecret ProjectSecret Project secret.

Mutation.projectSecretDelete

Input type: ProjectSecretDeleteInput

Arguments

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
name String! Name of the project secret.
projectPath ID! Project of the secret.

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.
projectSecret ProjectSecret Deleted project secret.

Mutation.projectSecretsManagerInitialize

Input type: ProjectSecretsManagerInitializeInput

Arguments

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
projectPath ID! Project of the secrets manager.

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.
projectSecretsManager ProjectSecretsManager Project secrets manager.

Mutation.projectSecurityExclusionCreate

Input type: ProjectSecurityExclusionCreateInput

Arguments

Name Type Description
active Boolean! Whether the exclusion is active.
clientMutationId String A unique identifier for the client performing the mutation.
description String Optional description for the exclusion.
projectPath ID! Full path of the project the exclusion will be associated with.
scanner ExclusionScannerEnum! Scanner to ignore values for based on the exclusion.
type ExclusionTypeEnum! Type of the exclusion.
value String! Value of the exclusion.

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.
securityExclusion ProjectSecurityExclusion Project security exclusion created.

Mutation.projectSecurityExclusionDelete

Input type: ProjectSecurityExclusionDeleteInput

Arguments

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
id SecurityProjectSecurityExclusionID! Global ID of the exclusion to be deleted.

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.

Mutation.projectSecurityExclusionUpdate

Input type: ProjectSecurityExclusionUpdateInput

Arguments

Name Type Description
active Boolean Whether the exclusion is active.
clientMutationId String A unique identifier for the client performing the mutation.
description String Optional description for the exclusion.
id SecurityProjectSecurityExclusionID! Global ID of the exclusion to be updated.
scanner ExclusionScannerEnum Scanner to ignore values for based on the exclusion.
type ExclusionTypeEnum Type of the exclusion.
value String Value of the exclusion.

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.
securityExclusion ProjectSecurityExclusion Project 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.

{{< details >}} Deprecated in GitLab 17.11. Use mutation ProjectUpdateComplianceFrameworks instead of this. {{< /details >}}

Input type: ProjectSetComplianceFrameworkInput

Arguments

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
complianceFrameworkId ComplianceManagementFrameworkID ID of the compliance framework to assign to the project. Set to null to unset.
projectId ProjectID! ID of the project to change the compliance framework of.

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.
project Project Project after mutation.

Mutation.projectSetContinuousVulnerabilityScanning

Enable/disable Continuous Vulnerability Scanning for the given project.

{{< details >}} Deprecated in GitLab 17.3. CVS has been enabled permanently. See this epic for more information. {{< /details >}}

Input type: ProjectSetContinuousVulnerabilityScanningInput

Arguments

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
enable Boolean! Desired status for Continuous Vulnerability Scanning feature.
projectPath ID! Full path of the project.

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
continuousVulnerabilityScanningEnabled Boolean! Whether feature is enabled.
errors [String!]! Errors encountered during execution of the mutation.

Mutation.projectSetLocked

Input type: ProjectSetLockedInput

Arguments

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

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.
project Project Project after mutation.

Mutation.projectSettingsUpdate

{{< details >}} Introduced in GitLab 16.9. Status: Experiment. {{< /details >}}

Input type: ProjectSettingsUpdateInput

Arguments

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
duoFeaturesEnabled Boolean! Indicates whether GitLab Duo features are enabled for the project.
fullPath ID! Full Path of the project the settings belong to.

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.
projectSettings ProjectSetting! Project settings after mutation.

Mutation.projectSubscriptionCreate

Input type: ProjectSubscriptionCreateInput

Arguments

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
projectPath String! Full path of the downstream project of the Project Subscription.
upstreamPath String! Full path of the upstream project of the Project Subscription.

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.
subscription CiSubscriptionsProject Project Subscription created by the mutation.

Mutation.projectSubscriptionDelete

Input type: ProjectSubscriptionDeleteInput

Arguments

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
subscriptionId CiSubscriptionsProjectID! ID of the subscription to delete.

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.
project Project Project after mutation.

Mutation.projectSyncFork

{{< details >}} Introduced in GitLab 15.9. Status: Experiment. {{< /details >}}

Input type: ProjectSyncForkInput

Arguments

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

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
details ForkDetails Updated fork details.
errors [String!]! Errors encountered during execution of the mutation.

Mutation.projectTargetBranchRuleCreate

Input type: ProjectTargetBranchRuleCreateInput

Arguments

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
name String! Name for the target branch rule.
projectId ProjectID! Project ID for the target branch rule.
targetBranch String! Target branch for the target branch rule.

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.
targetBranchRule ProjectTargetBranchRule Target branch rule after mutation.

Mutation.projectTargetBranchRuleDestroy

Input type: ProjectTargetBranchRuleDestroyInput

Arguments

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
id ProjectsTargetBranchRuleID! ID for the target branch rule.

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.

Mutation.projectTextReplace

{{< details >}} Introduced in GitLab 17.1. Status: Experiment. {{< /details >}}

Input type: projectTextReplaceInput

Arguments

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
projectPath ID! Full path of the project to replace.
replacements [String!]! List of text patterns to replace project-wide.

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.

Mutation.projectUpdateComplianceFrameworks

Update compliance frameworks for a project.

Input type: ProjectUpdateComplianceFrameworksInput

Arguments

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
complianceFrameworkIds [ComplianceManagementFrameworkID!]! IDs of the compliance framework to update for the project.
projectId ProjectID! ID of the project to change the compliance framework of.

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.
project Project Project after mutation.

Mutation.prometheusIntegrationCreate

Input type: PrometheusIntegrationCreateInput

Arguments

Name Type Description
active Boolean! Whether the integration is receiving alerts.
apiUrl String Endpoint at which Prometheus can be queried.
clientMutationId String A unique identifier for the client performing the mutation.
projectPath ID! Project to create the integration in.

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.
integration AlertManagementPrometheusIntegration Newly created integration.

Mutation.prometheusIntegrationResetToken

Input type: PrometheusIntegrationResetTokenInput

Arguments

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
id IntegrationsPrometheusID! ID of the integration to mutate.

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.
integration AlertManagementPrometheusIntegration Newly created integration.

Mutation.prometheusIntegrationUpdate

Input type: PrometheusIntegrationUpdateInput

Arguments

Name Type Description
active Boolean Whether the integration is receiving alerts.
apiUrl String Endpoint at which Prometheus can be queried.
clientMutationId String A unique identifier for the client performing the mutation.
id IntegrationsPrometheusID! ID of the integration to mutate.

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.
integration AlertManagementPrometheusIntegration Newly created integration.

Mutation.promoteToEpic

{{< details >}} Deprecated in GitLab 17.5. Replaced by WorkItem type. {{< /details >}}

Input type: PromoteToEpicInput

Arguments

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
groupPath ID Group the promoted epic will belong to.
iid String! IID of the issue to mutate.
projectPath ID! Project the issue to mutate is in.

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
epic Epic Epic after issue promotion.
errors [String!]! Errors encountered during execution of the mutation.
issue Issue Issue after mutation.

Mutation.refreshStandardsAdherenceChecks

Input type: RefreshStandardsAdherenceChecksInput

Arguments

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
groupPath ID! Group path.

Fields

Name Type Description
adherenceChecksStatus StandardsAdherenceChecksStatus Progress of standards adherence checks.
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.

Mutation.releaseAssetLinkCreate

Input type: ReleaseAssetLinkCreateInput

Arguments

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
directAssetPath String Relative path for a direct asset link.
linkType ReleaseAssetLinkType Type of the asset link.
name String! Name of the asset link.
projectPath ID! Full path of the project the asset link is associated with.
tagName String! Name of the associated release’s tag.
url String! URL of the asset link.

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.
link ReleaseAssetLink Asset link after mutation.

Mutation.releaseAssetLinkDelete

Input type: ReleaseAssetLinkDeleteInput

Arguments

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
id ReleasesLinkID! ID of the release asset link to delete.

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.
link ReleaseAssetLink Deleted release asset link.

Mutation.releaseAssetLinkUpdate

Input type: ReleaseAssetLinkUpdateInput

Arguments

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
directAssetPath String Relative path for a direct asset link.
id ReleasesLinkID! ID of the release asset link to update.
linkType ReleaseAssetLinkType Type of the asset link.
name String Name of the asset link.
url String URL of the asset link.

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.
link ReleaseAssetLink Asset link after mutation.

Mutation.releaseCreate

Input type: ReleaseCreateInput

Arguments

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

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.
release Release Release after mutation.

Mutation.releaseDelete

Input type: ReleaseDeleteInput

Arguments

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

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.
release Release Deleted release.

Mutation.releaseUpdate

Input type: ReleaseUpdateInput

Arguments

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

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.
release Release Release after mutation.

Mutation.removeProjectFromSecurityDashboard

Input type: RemoveProjectFromSecurityDashboardInput

Arguments

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
id ProjectID! ID of the project to remove from the Instance Security Dashboard.

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.

Mutation.repositionImageDiffNote

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

Input type: RepositionImageDiffNoteInput

Arguments

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
id DiffNoteID! Global ID of the DiffNote to update.
position UpdateDiffImagePositionInput! Position of the note on a diff.

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.
note Note Note after mutation.
quickActionsStatus QuickActionsStatus Status of quick actions after mutation.

Mutation.restorePagesDeployment

Restores a Pages deployment that has been scheduled for deletion.

{{< details >}} Introduced in GitLab 17.1. Status: Experiment. {{< /details >}}

Input type: RestorePagesDeploymentInput

Arguments

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
id PagesDeploymentID! ID of the Pages Deployment.

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.
pagesDeployment PagesDeployment! Restored Pages Deployment.

Mutation.runnerBulkPause

{{< details >}} Introduced in GitLab 17.11. Status: Experiment. {{< /details >}}

Input type: RunnerBulkPauseInput

Arguments

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
ids [CiRunnerID!]! IDs of the runners to pause or unpause.
paused Boolean! Indicates the runner is not allowed to receive jobs.

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.
updatedCount Int Number of records effectively updated. Only present if operation was performed synchronously.
updatedRunners [CiRunner!] Runners after mutation.

Mutation.runnerCacheClear

Input type: RunnerCacheClearInput

Arguments

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
projectId ProjectID! Global ID of the project that will have its runner cache cleared.

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.

Mutation.runnerCreate

{{< details >}} Introduced in GitLab 15.10. Status: Experiment. {{< /details >}}

Input type: RunnerCreateInput

Arguments

Name Type Description
accessLevel CiRunnerAccessLevel Access level of the runner.
clientMutationId String A unique identifier for the client performing the mutation.
description String Description of the runner.
groupId GroupID Global ID of the group that the runner is created in (valid only for group runner).
locked Boolean Indicates the runner is locked.
maintenanceNote String Runner’s maintenance notes.
maximumTimeout Int Maximum timeout (in seconds) for jobs processed by the runner.
paused Boolean Indicates the runner is not allowed to receive jobs.
privateProjectsMinutesCostFactor {{< icon name=”warning-solid” >}} Float Deprecated: Status: Experiment. Introduced in GitLab 17.7.
projectId ProjectID Global ID of the project that the runner is created in (valid only for project runner).
publicProjectsMinutesCostFactor {{< icon name=”warning-solid” >}} Float Deprecated: Status: Experiment. Introduced in GitLab 17.7.
runUntagged Boolean Indicates the runner is able to run untagged jobs.
runnerType CiRunnerType! Type of the runner to create.
tagList [String!] Tags associated with the runner.

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.
runner CiRunner Runner after mutation.

Mutation.runnerDelete

Input type: RunnerDeleteInput

Arguments

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
id CiRunnerID! ID of the runner to delete.

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.

Mutation.runnerUpdate

Input type: RunnerUpdateInput

Arguments

Name Type Description
accessLevel CiRunnerAccessLevel Access level of the runner.
active {{< icon name=”warning-solid” >}} Boolean Deprecated: This was renamed. Please use paused. Deprecated in GitLab 14.8.
associatedProjects [ProjectID!] Projects associated with the runner. Available only for project runners.
clientMutationId String A unique identifier for the client performing the mutation.
description String Description of the runner.
id CiRunnerID! ID of the runner to update.
locked Boolean Indicates the runner is locked.
maintenanceNote String Runner’s maintenance notes.
maximumTimeout Int Maximum timeout (in seconds) for jobs processed by the runner.
paused Boolean Indicates the runner is not allowed to receive jobs.
privateProjectsMinutesCostFactor {{< icon name=”warning-solid” >}} Float Deprecated: Status: Experiment. Introduced in GitLab 17.7.
publicProjectsMinutesCostFactor {{< icon name=”warning-solid” >}} Float Deprecated: Status: Experiment. Introduced in GitLab 17.7.
runUntagged Boolean Indicates the runner is able to run untagged jobs.
tagList [String!] Tags associated with the runner.

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.
runner CiRunner Runner after mutation.

Mutation.runnersExportUsage

Input type: RunnersExportUsageInput

Arguments

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
fromDate ISO8601Date UTC start date of the period to report on. Defaults to the start of last full month.
fullPath ID Filter 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.
maxProjectCount Int Maximum number of projects to return. All other runner usage will be attributed to an <Other projects> entry. Defaults to 1000 projects.
runnerType CiRunnerType Scope of the runners to include in the report.
toDate ISO8601Date UTC end date of the period to report on. “ \ “Defaults to the end of the month specified by fromDate.

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.

Mutation.runnersRegistrationTokenReset

{{< details >}} Deprecated in GitLab 17.7. Underlying feature was deprecated in 15.6 and will be removed in 18.0. {{< /details >}}

Input type: RunnersRegistrationTokenResetInput

Arguments

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
id ID ID of the project or group to reset the token for. Omit if resetting instance runner token.
type CiRunnerType! Scope of the object to reset the token for.

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.
token String Runner token after mutation.

Mutation.savedReplyCreate

Input type: SavedReplyCreateInput

Arguments

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
content String! Content of the saved reply.
name String! Name of the saved reply.

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.
savedReply SavedReply Saved reply after mutation.

Mutation.savedReplyDestroy

Input type: SavedReplyDestroyInput

Arguments

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
id UsersSavedReplyID! Global ID of the user saved reply.

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.
savedReply SavedReply Saved reply after mutation.

Mutation.savedReplyUpdate

Input type: SavedReplyUpdateInput

Arguments

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
content String! Content of the saved reply.
id UsersSavedReplyID! Global ID of the user saved reply.
name String! Name of the saved reply.

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.
savedReply SavedReply Saved reply after mutation.

Mutation.scanExecutionPolicyCommit

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

Input type: ScanExecutionPolicyCommitInput

Arguments

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
fullPath String Full path of the project.
name String! Name of the policy. If the name is null, the name field from policy_yaml is used.
operationMode MutationOperationMode! Changes the operation mode.
policyYaml String! YAML snippet of the policy.
projectPath {{< icon name=”warning-solid” >}} ID Deprecated: Use fullPath. Deprecated in GitLab 14.10.

Fields

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

Mutation.secretPermissionDelete

Input type: SecretPermissionDeleteInput

Arguments

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
principal PrincipalInput! Whose permission to be deleted.
projectPath ID! Project permissions for the secret.

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.
secretPermission SecretPermission Deleted Secret Permission.

Mutation.secretPermissionUpdate

Input type: SecretPermissionUpdateInput

Arguments

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
expiredAt ISO8601Date Expiration date for Secret Permission (optional).
permissions [String!]! Permissions to be provided. [‘create’, ‘update’, ‘read’, ‘delete’].
principal PrincipalInput! User/MemberRole/Role/Group that is provided access.
projectPath ID! Project to which the permissions are added.

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.
secretPermission SecretPermission Secret Permission that was created.

Mutation.securityFindingCreateIssue

Input type: SecurityFindingCreateIssueInput

Arguments

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

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.
issue Issue Issue created after mutation.

Mutation.securityFindingCreateMergeRequest

Input type: SecurityFindingCreateMergeRequestInput

Arguments

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
uuid String! UUID of the security finding to be used to create a merge request.

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.
mergeRequest MergeRequest Merge Request created after mutation.

Mutation.securityFindingCreateVulnerability

{{< details >}} Introduced in GitLab 17.5. Status: Experiment. {{< /details >}}

Input type: SecurityFindingCreateVulnerabilityInput

Arguments

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
uuid String! UUID of the security finding to be used to create a vulnerability.

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.
vulnerability Vulnerability Vulnerability created after mutation.

Mutation.securityFindingDismiss

Input type: SecurityFindingDismissInput

Arguments

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
comment String Comment why finding should be dismissed.
dismissalReason VulnerabilityDismissalReason Reason why finding should be dismissed.
uuid String! UUID of the finding to be dismissed.

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.
securityFinding PipelineSecurityReportFinding Dismissed finding.
uuid String UUID of dismissed finding.

Mutation.securityFindingRevertToDetected

Input type: SecurityFindingRevertToDetectedInput

Arguments

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
comment String Comment that explains why finding was reverted to detected status.
uuid String! UUID of the finding to be dismissed.

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.
securityFinding PipelineSecurityReportFinding Finding reverted to detected.

Mutation.securityFindingSeverityOverride

Input type: SecurityFindingSeverityOverrideInput

Arguments

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
severity VulnerabilitySeverity! New severity value for the finding.
uuid String! UUID of the finding to modify.

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.
securityFinding PipelineSecurityReportFinding Finding 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

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
fullPath String Full path of the project or group.
projectPath {{< icon name=”warning-solid” >}} ID Deprecated: Use fullPath. Deprecated in GitLab 14.10.
securityPolicyProjectId ProjectID! ID of the security policy project.

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.

Mutation.securityPolicyProjectCreate

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

Input type: SecurityPolicyProjectCreateInput

Arguments

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
fullPath String Full path of the project or group.
projectPath {{< icon name=”warning-solid” >}} ID Deprecated: Use fullPath. Deprecated in GitLab 14.10.

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.
project Project Security Policy Project that was created.

Mutation.securityPolicyProjectCreateAsync

Status: Experiment. Creates and assigns a security policy project for the given project or group (full_path) async.

{{< details >}} Introduced in GitLab 17.3. Status: Experiment. {{< /details >}}

Input type: SecurityPolicyProjectCreateAsyncInput

Arguments

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
fullPath String! Full path of the project or group.

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.

Mutation.securityPolicyProjectUnassign

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

Input type: SecurityPolicyProjectUnassignInput

Arguments

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
fullPath String Full path of the project or group.
projectPath {{< icon name=”warning-solid” >}} ID Deprecated: Use fullPath. Deprecated in GitLab 14.10.

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.

Mutation.securityTrainingUpdate

Input type: SecurityTrainingUpdateInput

Arguments

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
isEnabled Boolean! Sets the training provider as enabled for the project.
isPrimary Boolean Sets the training provider as primary for the project.
projectPath ID! Full path of the project.
providerId SecurityTrainingProviderID! ID of the provider.

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.
training ProjectSecurityTraining Represents the training entity subject to mutation.

Mutation.setContainerScanningForRegistry

Enable/disable Container Scanning on container registry for the given project.

Input type: SetContainerScanningForRegistryInput

Arguments

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
enable Boolean! Desired status for Container Scanning on container registry feature.
namespacePath ID! Full path of the namespace (project).

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
containerScanningForRegistryEnabled Boolean Whether 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

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
namespacePath ID! Full path of the group.
projectsToExclude [Int!] IDs of projects to exclude from the feature.
secretPushProtectionEnabled Boolean! Whether to enable the feature.

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.

Mutation.setPreReceiveSecretDetection

Enable/disable secret push protection for the given project.

Input type: SetPreReceiveSecretDetectionInput

Arguments

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
enable Boolean! Desired status for secret push protection feature.
namespacePath ID! Full path of the namespace (project).

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.
preReceiveSecretDetectionEnabled Boolean Whether the feature is enabled.
secretPushProtectionEnabled Boolean Whether the feature is enabled.

Mutation.setSecretPushProtection

Enable/disable secret push protection for the given project.

Input type: SetSecretPushProtectionInput

Arguments

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
enable Boolean! Desired status for secret push protection feature.
namespacePath ID! Full path of the namespace (project).

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.
preReceiveSecretDetectionEnabled Boolean Whether the feature is enabled.
secretPushProtectionEnabled Boolean Whether the feature is enabled.

Mutation.starProject

{{< details >}} Introduced in GitLab 16.7. Status: Experiment. {{< /details >}}

Input type: StarProjectInput

Arguments

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
projectId ProjectID! Full path of the project to star or unstar.
starred Boolean! Indicates whether to star or unstar the project.

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
count String! Number of stars for the project.
errors [String!]! Errors encountered during execution of the mutation.

Mutation.tagCreate

Input type: TagCreateInput

Arguments

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
message String Tagging message.
name String! Name of the tag.
projectPath ID! Project full path the branch is associated with.
ref String! Tag name or commit SHA to create tag from.

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.
tag Tag Tag after mutation.

Mutation.tagDelete

Input type: TagDeleteInput

Arguments

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
name String! Name of the tag.
projectPath ID! Project full path the branch is associated with.

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.
tag Tag Tag after mutation.

Mutation.terraformStateDelete

Input type: TerraformStateDeleteInput

Arguments

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
id TerraformStateID! Global ID of the Terraform state.

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.

Mutation.terraformStateLock

Input type: TerraformStateLockInput

Arguments

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
id TerraformStateID! Global ID of the Terraform state.

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.

Mutation.terraformStateUnlock

Input type: TerraformStateUnlockInput

Arguments

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
id TerraformStateID! Global ID of the Terraform state.

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.

Mutation.timelineEventCreate

{{< details >}} Introduced in GitLab 15.6. Status: Experiment. {{< /details >}}

Input type: TimelineEventCreateInput

Arguments

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

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.
timelineEvent TimelineEventType Timeline event.

Mutation.timelineEventDestroy

Input type: TimelineEventDestroyInput

Arguments

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
id IncidentManagementTimelineEventID! Timeline event ID to remove.

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.
timelineEvent TimelineEventType Timeline event.

Mutation.timelineEventPromoteFromNote

Input type: TimelineEventPromoteFromNoteInput

Arguments

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
noteId NoteID! Note ID from which the timeline event promoted.

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.
timelineEvent TimelineEventType Timeline event.

Mutation.timelineEventTagCreate

Input type: TimelineEventTagCreateInput

Arguments

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

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.
timelineEventTag TimelineEventTagType Timeline event tag.

Mutation.timelineEventUpdate

Input type: TimelineEventUpdateInput

Arguments

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
id IncidentManagementTimelineEventID! ID of the timeline event to update.
note String Text note of the timeline event.
occurredAt Time Timestamp when the event occurred.
timelineEventTagNames [String!] Tags for the incident timeline event.

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.
timelineEvent TimelineEventType Timeline event.

Mutation.timelogCreate

Input type: TimelogCreateInput

Arguments

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
issuableId IssuableID! Global ID of the issuable (Issue, WorkItem or MergeRequest).
spentAt Time Timestamp of when the time was spent. If empty, defaults to current time.
summary String! Summary of time spent.
timeSpent String! Amount of time spent.

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.
timelog Timelog Timelog.

Mutation.timelogDelete

Input type: TimelogDeleteInput

Arguments

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
id TimelogID! Global ID of the timelog.

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.
timelog Timelog Timelog.

Mutation.todoCreate

Input type: TodoCreateInput

Arguments

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

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.
todo Todo To-do item created.

Mutation.todoDeleteAllDone

{{< details >}} Introduced in GitLab 17.11. Status: Experiment. {{< /details >}}

Input type: TodoDeleteAllDoneInput

Arguments

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.

Mutation.todoDeleteMany

{{< details >}} Introduced in GitLab 17.11. Status: Experiment. {{< /details >}}

Input type: TodoDeleteManyInput

Arguments

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
ids [TodoID!]! Global IDs of the to-do items to process (a maximum of 100 is supported at once).

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.

Mutation.todoMarkDone

Input type: TodoMarkDoneInput

Arguments

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
id TodoID! Global ID of the to-do item to mark as done.

Fields

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

Mutation.todoResolveMany

{{< details >}} Introduced in GitLab 17.9. Status: Experiment. {{< /details >}}

Input type: TodoResolveManyInput

Arguments

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
ids [TodoID!]! Global IDs of the to-do items to process (a maximum of 100 is supported at once).

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.
todos [Todo!]! Resolved to-do items.

Mutation.todoRestore

Input type: TodoRestoreInput

Arguments

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
id TodoID! Global ID of the to-do item to restore.

Fields

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

Mutation.todoRestoreMany

Input type: TodoRestoreManyInput

Arguments

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
ids [TodoID!]! Global IDs of the to-do items to process (a maximum of 100 is supported at once).

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.
todos [Todo!]! Restored to-do items.

Mutation.todoSnooze

{{< details >}} Introduced in GitLab 17.4. Status: Experiment. {{< /details >}}

Input type: TodoSnoozeInput

Arguments

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
id TodoID! Global ID of the to-do item to be snoozed.
snoozeUntil Time! Time until which the todo should be snoozed.

Fields

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

Mutation.todoSnoozeMany

{{< details >}} Introduced in GitLab 17.9. Status: Experiment. {{< /details >}}

Input type: TodoSnoozeManyInput

Arguments

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
ids [TodoID!]! Global IDs of the to-do items to process (a maximum of 100 is supported at once).
snoozeUntil Time! Time until which the todos should be snoozed.

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.
todos [Todo!]! Snoozed to-do items.

Mutation.todoUnSnooze

{{< details >}} Introduced in GitLab 17.4. Status: Experiment. {{< /details >}}

Input type: TodoUnSnoozeInput

Arguments

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
id TodoID! Global ID of the to-do item to be snoozed.

Fields

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

Mutation.todoUnsnoozeMany

{{< details >}} Introduced in GitLab 17.9. Status: Experiment. {{< /details >}}

Input type: TodoUnsnoozeManyInput

Arguments

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
ids [TodoID!]! Global IDs of the to-do items to process (a maximum of 100 is supported at once).

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.
todos [Todo!]! Unsnoozed to-do items.

Mutation.todosMarkAllDone

Input type: TodosMarkAllDoneInput

Arguments

Name Type Description
action [TodoActionEnum!] Action to be filtered.
authorId [ID!] ID of an author.
clientMutationId String A unique identifier for the client performing the mutation.
groupId [ID!] ID of a group.
projectId [ID!] ID of a project.
targetId TodoableID Global ID of the to-do item’s parent. Issues, merge requests, designs, and epics are supported. If argument is omitted, all pending to-do items of the current user are marked as done.
type [TodoTargetEnum!] Type of the todo.

Fields

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

Mutation.updateAbuseReportNote

Updates an abuse report Note.

{{< details >}} Introduced in GitLab 17.5. Status: Experiment. {{< /details >}}

Input type: UpdateAbuseReportNoteInput

Arguments

Name Type Description
body String! Content of the note.
clientMutationId String A unique identifier for the client performing the mutation.
id AntiAbuseReportsNoteID! Global ID of the note to update.

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.
note AbuseReportNote! Abuse report note after mutation.

Mutation.updateAlertStatus

Input type: UpdateAlertStatusInput

Arguments

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
iid String! IID of the alert to mutate.
projectPath ID! Project the alert to mutate is in.
status AlertManagementStatus! Status to set the alert.

Fields

Name Type Description
alert AlertManagementAlert Alert after mutation.
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.
issue Issue Issue created after mutation.
todo Todo To-do item after mutation.

Mutation.updateBoard

Input type: UpdateBoardInput

Arguments

Name Type Description
assigneeId UserID ID of user to be assigned to the board.
clientMutationId String A unique identifier for the client performing the mutation.
hideBacklogList Boolean Whether or not backlog list is hidden.
hideClosedList Boolean Whether or not closed list is hidden.
id BoardID! Board global ID.
iterationCadenceId IterationsCadenceID ID of iteration cadence to be assigned to the board.
iterationId IterationID ID of iteration to be assigned to the board.
labelIds [LabelID!] IDs of labels to be added to the board.
labels [String!] Labels of the issue.
milestoneId MilestoneID ID of milestone to be assigned to the board.
name String Board name.
weight Int Weight value to be assigned to the board.

Fields

Name Type Description
board Board Board after mutation.
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.

Mutation.updateBoardEpicUserPreferences

{{< details >}} Deprecated in GitLab 17.5. Replaced by WorkItem type. {{< /details >}}

Input type: UpdateBoardEpicUserPreferencesInput

Arguments

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

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
epicUserPreferences BoardEpicUserPreferences User preferences for the epic in the board after mutation.
errors [String!]! Errors encountered during execution of the mutation.

Mutation.updateBoardList

Input type: UpdateBoardListInput

Arguments

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
collapsed Boolean Indicates if the list is collapsed for the user.
listId ListID! Global ID of the list.
position Int Position of list within the board.

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.
list BoardList Mutated list.

Mutation.updateComplianceFramework

Input type: UpdateComplianceFrameworkInput

Arguments

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
id ComplianceManagementFrameworkID! Global ID of the compliance framework to update.
params ComplianceFrameworkInput! Parameters to update the compliance framework with.

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
complianceFramework ComplianceFramework Compliance framework after mutation.
errors [String!]! Errors encountered during execution of the mutation.

Mutation.updateComplianceRequirement

{{< details >}} Introduced in GitLab 17.7. Status: Experiment. {{< /details >}}

Input type: UpdateComplianceRequirementInput

Arguments

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
controls [ComplianceRequirementsControlInput!] Controls to add or update to the compliance requirement.
id ComplianceManagementComplianceFrameworkComplianceRequirementID! Global ID of the compliance requirement to update.
params ComplianceRequirementInput! Parameters to update the compliance requirement with.

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.
requirement ComplianceRequirement Compliance requirement after updation.

Mutation.updateComplianceRequirementsControl

{{< details >}} Introduced in GitLab 17.9. Status: Experiment. {{< /details >}}

Input type: UpdateComplianceRequirementsControlInput

Arguments

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
id ComplianceManagementComplianceFrameworkComplianceRequirementsControlID! Global ID of the compliance requirement control to update.
params ComplianceRequirementsControlInput! Parameters to update the compliance requirement control with.

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.
requirementsControl ComplianceRequirementsControl Compliance requirement control after updation.

Mutation.updateContainerExpirationPolicy

Input type: UpdateContainerExpirationPolicyInput

Arguments

Name Type Description
cadence ContainerExpirationPolicyCadenceEnum Schedule of the container expiration policy.
clientMutationId String A unique identifier for the client performing the mutation.
enabled Boolean Indicates whether the container expiration policy is enabled.
keepN ContainerExpirationPolicyKeepEnum Number of tags to retain.
nameRegex UntrustedRegexp Tags with names matching the regex pattern will expire.
nameRegexKeep UntrustedRegexp Tags with names matching the regex pattern will be preserved.
olderThan ContainerExpirationPolicyOlderThanEnum Tags older than the given age will expire.
projectPath ID! Project path where the container expiration policy is located.

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
containerExpirationPolicy {{< icon name=”warning-solid” >}} ContainerExpirationPolicy Deprecated: Use container_tags_expiration_policy. Deprecated in GitLab 17.5.
containerTagsExpirationPolicy ContainerTagsExpirationPolicy Container 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

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
id ContainerRegistryProtectionRuleID! Global ID of the container repository protection rule to be updated.
minimumAccessLevelForDelete ContainerProtectionRepositoryRuleAccessLevel Minimum GitLab access level required to delete container images from the container repository. Valid values include MAINTAINER, OWNER, or ADMIN. If the value is nil, the default minimum access level is DEVELOPER.
minimumAccessLevelForPush ContainerProtectionRepositoryRuleAccessLevel Minimum GitLab access level required to push container images to the container repository. Valid values include MAINTAINER, OWNER, or ADMIN. If the value is nil, the default minimum access level is DEVELOPER.
repositoryPathPattern String Container repository path pattern protected by the protection rule. Must start with the project’s full path. For example: my-project/*-prod-*. Wildcard character * is allowed anywhere after the project’s full path.

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
containerProtectionRepositoryRule ContainerProtectionRepositoryRule Container 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.

{{< details >}} Introduced in GitLab 17.8. Status: Experiment. {{< /details >}}

Input type: UpdateContainerProtectionTagRuleInput

Arguments

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
id ContainerRegistryProtectionTagRuleID! Global ID of the tag protection rule to update.
minimumAccessLevelForDelete {{< icon name=”warning-solid” >}} ContainerProtectionTagRuleAccessLevel Deprecated: Status: Experiment. Introduced in GitLab 17.8.
minimumAccessLevelForPush {{< icon name=”warning-solid” >}} ContainerProtectionTagRuleAccessLevel Deprecated: Status: Experiment. Introduced in GitLab 17.8.
tagNamePattern {{< icon name=”warning-solid” >}} String Deprecated: Status: Experiment. Introduced in GitLab 17.8.

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
containerProtectionTagRule {{< icon name=”warning-solid” >}} ContainerProtectionTagRule Deprecated: 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

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
enabled Boolean Indicates whether the policy is enabled or disabled.
groupPath ID! Group path for the group dependency proxy image TTL policy.
ttl Int Number of days to retain a cached image file.

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
dependencyProxyImageTtlPolicy DependencyProxyImageTtlGroupPolicy Group image TTL policy after mutation.
errors [String!]! Errors encountered during execution of the mutation.

Mutation.updateDependencyProxyPackagesSettings

Updates or creates dependency proxy for packages settings. Requires the packages and dependency proxy to be enabled in the config. Requires the packages feature to be enabled at the project level.

Input type: UpdateDependencyProxyPackagesSettingsInput

Arguments

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
enabled Boolean Indicates whether the dependency proxy for packages is enabled for the project.
mavenExternalRegistryPassword String Password for the external Maven packages registry. Introduced in 16.5: This feature is an Experiment. It can be changed or removed at any time.
mavenExternalRegistryUrl String URL for the external Maven packages registry.
mavenExternalRegistryUsername String Username for the external Maven packages registry.
projectPath ID! Project path for the dependency proxy for packages settings.

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
dependencyProxyPackagesSetting DependencyProxyPackagesSetting Dependency proxy for packages settings after mutation.
errors [String!]! Errors encountered during execution of the mutation.

Mutation.updateDependencyProxySettings

These settings can be adjusted only by the group Owner.

Input type: UpdateDependencyProxySettingsInput

Arguments

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
enabled Boolean Indicates whether the policy is enabled or disabled.
groupPath ID! Group path for the group dependency proxy.
identity String Identity credential used to authenticate with Docker Hub when pulling images. Can be a username (for password or personal access token (PAT)) or organization name (for organization access token (OAT)).
secret String Secret credential used to authenticate with Docker Hub when pulling images. Can be a password, personal access token (PAT), or organization access token (OAT).

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
dependencyProxySetting DependencyProxySetting Group dependency proxy settings after mutation.
errors [String!]! Errors encountered during execution of the mutation.

Mutation.updateEpic

{{< details >}} Deprecated in GitLab 17.5. Replaced by WorkItem type. {{< /details >}}

Input type: UpdateEpicInput

Arguments

Name Type Description
addLabelIds [ID!] IDs of labels to be added to the epic.
addLabels [String!] Array of labels to be added to the epic.
clientMutationId String A unique identifier for the client performing the mutation.
color Color Color of the epic.
confidential Boolean Indicates if the epic is confidential.
description String Description of the epic.
dueDateFixed String End date of the epic.
dueDateIsFixed Boolean Indicates end date should be sourced from due_date_fixed field not the issue milestones.
groupPath ID! Group the epic to mutate is in.
iid ID! IID of the epic to mutate.
removeLabelIds [ID!] IDs of labels to be removed from the epic.
removeLabels [String!] Array of labels to be removed from the epic.
startDateFixed String Start date of the epic.
startDateIsFixed Boolean Indicates start date should be sourced from start_date_fixed field not the issue milestones.
stateEvent EpicStateEvent State event for the epic.
title String Title of the epic.

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
epic Epic Epic after mutation.
errors [String!]! Errors encountered during execution of the mutation.

Mutation.updateEpicBoardList

{{< details >}} Deprecated in GitLab 17.5. Replaced by WorkItem type. {{< /details >}}

Input type: UpdateEpicBoardListInput

Arguments

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
collapsed Boolean Indicates if the list is collapsed for the user.
listId BoardsEpicListID! Global ID of the epic list.
position Int Position of list within the board.

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.
list EpicList Mutated epic list.

Mutation.updateImageDiffNote

Updates a DiffNote on an image (a Note where the position.positionType is "image"). If the body of the Note contains only quick actions, the Note will be destroyed during an update, and no Note will be returned.

Input type: UpdateImageDiffNoteInput

Arguments

Name Type Description
body String Content of the note.
clientMutationId String A unique identifier for the client performing the mutation.
id NoteID! Global ID of the note to update.
position UpdateDiffImagePositionInput Position of the note on a diff.

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.
note Note Note after mutation.
quickActionsStatus QuickActionsStatus Status of quick actions after mutation.

Mutation.updateIssue

Input type: UpdateIssueInput

Arguments

Name Type Description
addLabelIds [ID!] IDs of labels to be added to the issue.
clientMutationId String A unique identifier for the client performing the mutation.
confidential Boolean Indicates the issue is confidential.
description String Description of the issue.
dueDate ISO8601Date Due date of the issue.
epicId {{< icon name=”warning-solid” >}} EpicID Deprecated: This will be replaced by WorkItem hierarchyWidget. Deprecated in GitLab 17.5.
healthStatus HealthStatus Desired health status.
iid String! IID of the issue to mutate.
labelIds [ID!] IDs of labels to be set. Replaces existing issue labels.
locked Boolean Indicates discussion is locked on the issue.
milestoneId ID ID of the milestone to assign to the issue. On update milestone will be removed if set to null.
projectPath ID! Project the issue to mutate is in.
removeLabelIds [ID!] IDs of labels to be removed from the issue.
stateEvent IssueStateEvent Close or reopen an issue.
timeEstimate String Estimated time to complete the issue. Use null or 0 to remove the current estimate.
title String Title of the issue.
type IssueType Type of the issue.
weight Int Weight of the issue.

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.
issue Issue Issue after mutation.

Mutation.updateIteration

Input type: UpdateIterationInput

Arguments

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
description String Description of the iteration.
dueDate String End date of the iteration.
groupPath ID! Group of the iteration.
id ID! Global ID of the iteration.
startDate String Start date of the iteration.
title String Title of the iteration.

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.
iteration Iteration Updated iteration.

Mutation.updateNamespacePackageSettings

These settings can be adjusted only by the group Owner.

Input type: UpdateNamespacePackageSettingsInput

Arguments

Name Type Description
auditEventsEnabled {{< icon name=”warning-solid” >}} Boolean Deprecated: Status: Experiment. Introduced in GitLab 17.10.
clientMutationId String A unique identifier for the client performing the mutation.
genericDuplicateExceptionRegex UntrustedRegexp When generic_duplicates_allowed is false, you can publish duplicate packages with names that match this regex. Otherwise, this setting has no effect.
genericDuplicatesAllowed Boolean Indicates whether duplicate generic packages are allowed for the namespace.
lockMavenPackageRequestsForwarding Boolean Indicates whether Maven package forwarding is locked for all descendent namespaces.
lockNpmPackageRequestsForwarding Boolean Indicates whether npm package forwarding is locked for all descendent namespaces.
lockPypiPackageRequestsForwarding Boolean Indicates whether PyPI package forwarding is locked for all descendent namespaces.
mavenDuplicateExceptionRegex UntrustedRegexp When maven_duplicates_allowed is false, you can publish duplicate packages with names that match this regex. Otherwise, this setting has no effect.
mavenDuplicatesAllowed Boolean Indicates whether duplicate Maven packages are allowed for the namespace.
mavenPackageRequestsForwarding Boolean Indicates whether Maven package forwarding is allowed for the namespace.
namespacePath ID! Namespace path where the namespace package setting is located.
npmPackageRequestsForwarding Boolean Indicates whether npm package forwarding is allowed for the namespace.
nugetDuplicateExceptionRegex UntrustedRegexp When nuget_duplicates_allowed is false, you can publish duplicate packages with names that match this regex. Otherwise, this setting has no effect.
nugetDuplicatesAllowed Boolean Indicates whether duplicate NuGet packages are allowed for the namespace.
nugetSymbolServerEnabled Boolean Indicates whether the NuGet symbol server is enabled for the namespace.
pypiPackageRequestsForwarding Boolean Indicates whether PyPI package forwarding is allowed for the namespace.
terraformModuleDuplicateExceptionRegex UntrustedRegexp When terraform_module_duplicates_allowed is false, you can publish duplicate packages with names that match this regex. Otherwise, this setting has no effect.
terraformModuleDuplicatesAllowed Boolean Indicates whether duplicate Terraform packages are allowed for the namespace.

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.
packageSettings PackageSettings Namespace package setting after mutation.

Mutation.updateNote

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

Input type: UpdateNoteInput

Arguments

Name Type Description
body String Content of the note.
clientMutationId String A unique identifier for the client performing the mutation.
id NoteID! Global ID of the note to update.

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.
note Note Note after mutation.
quickActionsStatus QuickActionsStatus Status of quick actions after mutation.

Mutation.updatePackagesCleanupPolicy

Input type: UpdatePackagesCleanupPolicyInput

Arguments

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
keepNDuplicatedPackageFiles PackagesCleanupKeepDuplicatedPackageFilesEnum Number of duplicated package files to retain.
projectPath ID! Project path where the packages cleanup policy is located.

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.
packagesCleanupPolicy PackagesCleanupPolicy Packages cleanup policy after mutation.

Mutation.updatePackagesProtectionRule

Updates a package protection rule to restrict access to project packages. You can prevent users without certain permissions from altering packages.

Input type: UpdatePackagesProtectionRuleInput

Arguments

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
id PackagesProtectionRuleID! Global ID of the package protection rule to be updated.
minimumAccessLevelForDelete {{< icon name=”warning-solid” >}} PackagesProtectionRuleAccessLevelForDelete Deprecated: Status: Experiment. Introduced in GitLab 17.10.
minimumAccessLevelForPush PackagesProtectionRuleAccessLevel Minimum GitLab access required to push packages to the package registry. Valid values include MAINTAINER, OWNER, or ADMIN. If the value is nil, the default minimum access level is DEVELOPER.
packageNamePattern String Package name protected by the protection rule. For example, @my-scope/my-package-*. Wildcard character * allowed.
packageType PackagesProtectionRulePackageType Package type protected by the protection rule. For example, NPM, PYPI.

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.
packageProtectionRule PackagesProtectionRule Packages protection rule after mutation.

Mutation.updateRequirement

Input type: UpdateRequirementInput

Arguments

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
description String Description of the requirement.
iid {{< icon name=”warning-solid” >}} String Deprecated: Use work_item_iid instead. Deprecated in GitLab 15.8.
lastTestReportState TestReportState Creates a test report for the requirement with the given state.
projectPath ID! Full project path the requirement is associated with.
state RequirementState State of the requirement.
title String Title of the requirement.
workItemIid String IID of the requirement work item to update.

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.
requirement Requirement Requirement after mutation.

Mutation.updateSnippet

Input type: UpdateSnippetInput

Arguments

Name Type Description
blobActions [SnippetBlobActionInputType!] Actions to perform over the snippet repository and blobs.
clientMutationId String A unique identifier for the client performing the mutation.
description String Description of the snippet.
id SnippetID! Global ID of the snippet to update.
title String Title of the snippet.
visibilityLevel VisibilityLevelsEnum Visibility level of the snippet.

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.
snippet Snippet Snippet after mutation.

Mutation.uploadDelete

Deletes an upload.

Input type: UploadDeleteInput

Arguments

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
filename String! Upload filename.
groupPath ID Full path of the group with which the resource is associated.
projectPath ID Full path of the project with which the resource is associated.
secret String! Secret part of upload path.

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.
upload FileUpload Deleted upload.

Mutation.userAchievementPrioritiesUpdate

{{< details >}} Introduced in GitLab 16.5. Status: Experiment. {{< /details >}}

Input type: UserAchievementPrioritiesUpdateInput

Arguments

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
userAchievementIds [AchievementsUserAchievementID!]! Global IDs of the user achievements being prioritized, ordered from highest to lowest priority.

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.
userAchievements [UserAchievement!]! Updated user achievements.

Mutation.userAchievementsDelete

{{< details >}} Introduced in GitLab 16.1. Status: Experiment. {{< /details >}}

Input type: UserAchievementsDeleteInput

Arguments

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
userAchievementId AchievementsUserAchievementID! Global ID of the user achievement being deleted.

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.
userAchievement UserAchievement Deleted user achievement.

Mutation.userAchievementsUpdate

{{< details >}} Introduced in GitLab 17.3. Status: Experiment. {{< /details >}}

Input type: UserAchievementsUpdateInput

Arguments

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
showOnProfile Boolean! Indicates whether or not the user achievement is visible on the profile.
userAchievementId AchievementsUserAchievementID! Global ID of the user achievement being updated.

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.
userAchievement UserAchievement Achievement award.

Mutation.userAddOnAssignmentBulkCreate

Input type: UserAddOnAssignmentBulkCreateInput

Arguments

Name Type Description
addOnPurchaseId GitlabSubscriptionsAddOnPurchaseID! Global ID of AddOnPurchase to be assigned to.
clientMutationId String A unique identifier for the client performing the mutation.
userIds [UserID!]! Global IDs of user to be assigned.

Fields

Name Type Description
addOnPurchase AddOnPurchase AddOnPurchase state after mutation.
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.

Mutation.userAddOnAssignmentBulkRemove

Input type: UserAddOnAssignmentBulkRemoveInput

Arguments

Name Type Description
addOnPurchaseId GitlabSubscriptionsAddOnPurchaseID! Global ID of AddOnPurchase to be unassigned from.
clientMutationId String A unique identifier for the client performing the mutation.
userIds [UserID!]! Global IDs of user to be unassigned.

Fields

Name Type Description
addOnPurchase AddOnPurchase AddOnPurchase state after mutation.
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.

Mutation.userAddOnAssignmentCreate

Input type: UserAddOnAssignmentCreateInput

Arguments

Name Type Description
addOnPurchaseId GitlabSubscriptionsAddOnPurchaseID! Global ID of AddOnPurchase to be assigned to.
clientMutationId String A unique identifier for the client performing the mutation.
userId UserID! Global ID of user to be assigned.

Fields

Name Type Description
addOnPurchase AddOnPurchase AddOnPurchase state after mutation.
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.
user AddOnUser User who the add-on purchase was assigned to.

Mutation.userAddOnAssignmentRemove

Input type: UserAddOnAssignmentRemoveInput

Arguments

Name Type Description
addOnPurchaseId GitlabSubscriptionsAddOnPurchaseID! Global ID of AddOnPurchase assignment belongs to.
clientMutationId String A unique identifier for the client performing the mutation.
userId UserID! Global ID of user whose assignment will be removed.

Fields

Name Type Description
addOnPurchase AddOnPurchase AddOnPurchase state after mutation.
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.
user AddOnUser User that the add-on was removed from.

Mutation.userCalloutCreate

Input type: UserCalloutCreateInput

Arguments

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
featureName String! Feature name you want to dismiss the callout for.

Fields

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

Mutation.userPreferencesUpdate

Input type: UserPreferencesUpdateInput

Arguments

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
extensionsMarketplaceOptInStatus ExtensionsMarketplaceOptInStatus Status of the Web IDE Extension Marketplace opt-in for the user.
issuesSort IssueSort Sort order for issue lists.
mergeRequestDashboardListType MergeRequestsDashboardListType Merge request dashboard list rendering type.
mergeRequestsSort MergeRequestSort Sort order for issue lists.
organizationGroupsProjectsDisplay {{< icon name=”warning-solid” >}} OrganizationGroupProjectDisplay Deprecated: Status: Experiment. Introduced in GitLab 17.2.
organizationGroupsProjectsSort {{< icon name=”warning-solid” >}} OrganizationGroupProjectSort Deprecated: Status: Experiment. Introduced in GitLab 17.2.
projectsSort ProjectSort Sort order for projects.
useWorkItemsView Boolean Use work item view instead of legacy issue view.
visibilityPipelineIdType VisibilityPipelineIdType Determines whether the pipeline list shows ID or IID.

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.
userPreferences UserPreferences User preferences after mutation.

Mutation.userSetNamespaceCommitEmail

Input type: UserSetNamespaceCommitEmailInput

Arguments

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
emailId EmailID ID of the email to set.
namespaceId NamespaceID! ID of the namespace to set the namespace commit email for.

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.
namespaceCommitEmail NamespaceCommitEmail User namespace commit email after mutation.

Mutation.valueStreamCreate

Creates a value stream.

{{< details >}} Introduced in GitLab 16.6. Status: Experiment. {{< /details >}}

Input type: ValueStreamCreateInput

Arguments

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
name String! Value stream name.
namespacePath ID! Full path of the namespace(project or group) the value stream is created in.
setting ValueStreamSettingInput Value stream configuration.
stages [ValueStreamStageInput!] Value stream custom stages.

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.
valueStream ValueStream Created value stream.

Mutation.valueStreamDestroy

Destroy a value stream.

{{< details >}} Introduced in GitLab 16.6. Status: Experiment. {{< /details >}}

Input type: ValueStreamDestroyInput

Arguments

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
id AnalyticsCycleAnalyticsValueStreamID! Global ID of the value stream to destroy.

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.
valueStream ValueStream Value stream deleted after mutation.

Mutation.valueStreamUpdate

Updates a value stream.

{{< details >}} Introduced in GitLab 16.6. Status: Experiment. {{< /details >}}

Input type: ValueStreamUpdateInput

Arguments

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
id AnalyticsCycleAnalyticsValueStreamID! Global ID of the value stream to update.
name String Value stream name.
setting ValueStreamSettingInput Value stream configuration.
stages [ValueStreamStageInput!] Value stream custom stages.

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.
valueStream ValueStream Updated value stream.

Mutation.verifiedNamespaceCreate

Create a verified namespace and mark all child catalog resources with the passed verification level info.

Input type: VerifiedNamespaceCreateInput

Arguments

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
namespacePath ID! Root namespace path.
verificationLevel CiCatalogResourceVerificationLevel! Verification level used to indicate the verification for namespace given by Gitlab.

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.

Mutation.vulnerabilitiesArchive

{{< details >}} Introduced in GitLab 17.10. Status: Experiment. {{< /details >}}

Input type: VulnerabilitiesArchiveInput

Arguments

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
date Date! Last update date of vulnerabilities being archived.
projectId ProjectID! ID of the project to attach the vulnerability to.

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.
status String! Status of the action.

Mutation.vulnerabilitiesCreateIssue

{{< details >}} Introduced in GitLab 17.9. Status: Experiment. {{< /details >}}

Input type: VulnerabilitiesCreateIssueInput

Arguments

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
project ProjectID! ID of the project to attach the issue to.
vulnerabilityIds [VulnerabilityID!]! IDs of vulnerabilities to link to the given issue. Up to 100 can be provided.

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.
issue Issue Issue created after mutation.

Mutation.vulnerabilitiesDismiss

Input type: VulnerabilitiesDismissInput

Arguments

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
comment String Comment why vulnerability was dismissed (maximum 50,000 characters).
dismissalReason VulnerabilityDismissalReason Reason why vulnerability should be dismissed.
vulnerabilityIds [VulnerabilityID!]! IDs of the vulnerabilities to be dismissed (maximum 100 entries).

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.
vulnerabilities [Vulnerability!]! Vulnerabilities after state change.

Mutation.vulnerabilitiesRemoveAllFromProject

Remove all Vulnerabilities and related information from a given project. Introduced in GitLab 16.7.

Input type: VulnerabilitiesRemoveAllFromProjectInput

Arguments

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
projectIds [ProjectID!]! IDs of project for which all Vulnerabilities should be removed. The deletion will happen in the background so the changes will not be visible immediately.
resolvedOnDefaultBranch Boolean When set as true, deletes only the vulnerabilities no longer detected. When set as false, deletes only the vulnerabilities still detected.

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.
projects [Project!]! Projects for which the deletion was scheduled.

Mutation.vulnerabilitiesSeverityOverride

Input type: vulnerabilitiesSeverityOverrideInput

Arguments

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
comment String! Comment why vulnerability severity was changed (maximum 50,000 characters).
severity VulnerabilitySeverity! New severity value for the severities.
vulnerabilityIds [VulnerabilityID!]! IDs of the vulnerabilities for which severity needs to be changed (maximum 100 entries).

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.
vulnerabilities [Vulnerability!]! Vulnerabilities after severity change.

Mutation.vulnerabilityConfirm

Input type: VulnerabilityConfirmInput

Arguments

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
comment String Comment why vulnerability was confirmed (maximum 50,000 characters).
id VulnerabilityID! ID of the vulnerability to be confirmed.

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.
vulnerability Vulnerability Vulnerability after state change.

Mutation.vulnerabilityCreate

Input type: VulnerabilityCreateInput

Arguments

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
confirmedAt Time Timestamp of when the vulnerability state changed to confirmed (defaults to creation time if status is confirmed).
description String! Long text section that describes the vulnerability in more detail.
detectedAt Time Timestamp of when the vulnerability was first detected (defaults to creation time).
dismissedAt Time Timestamp of when the vulnerability state changed to dismissed (defaults to creation time if status is dismissed).
identifiers [VulnerabilityIdentifierInput!]! Array of CVE or CWE identifiers for the vulnerability.
name String! Name of the vulnerability.
project ProjectID! ID of the project to attach the vulnerability to.
resolvedAt Time Timestamp of when the vulnerability state changed to resolved (defaults to creation time if status is resolved).
scanner VulnerabilityScannerInput! Information about the scanner used to discover the vulnerability.
severity VulnerabilitySeverity Severity of the vulnerability (defaults to unknown).
solution String Instructions for how to fix the vulnerability.
state VulnerabilityState State of the vulnerability (defaults to detected).

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.
vulnerability Vulnerability Vulnerability created.

Mutation.vulnerabilityDismiss

Input type: VulnerabilityDismissInput

Arguments

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
comment String Comment why vulnerability was dismissed (maximum 50,000 characters).
dismissalReason VulnerabilityDismissalReason Reason why vulnerability should be dismissed.
id VulnerabilityID! ID of the vulnerability to be dismissed.

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.
vulnerability Vulnerability Vulnerability after state change.

Mutation.vulnerabilityExternalIssueLinkCreate

Input type: VulnerabilityExternalIssueLinkCreateInput

Arguments

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

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.
externalIssueLink VulnerabilityExternalIssueLink Created external issue link.

Mutation.vulnerabilityExternalIssueLinkDestroy

Input type: VulnerabilityExternalIssueLinkDestroyInput

Arguments

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
id VulnerabilitiesExternalIssueLinkID! Global ID of the vulnerability external issue link.

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.

Mutation.vulnerabilityIssueLinkCreate

Input type: VulnerabilityIssueLinkCreateInput

Arguments

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

Fields

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

Mutation.vulnerabilityResolve

Input type: VulnerabilityResolveInput

Arguments

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
comment String Comment why vulnerability was resolved (maximum 50,000 characters).
id VulnerabilityID! ID of the vulnerability to be resolved.

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.
vulnerability Vulnerability Vulnerability after state change.

Mutation.vulnerabilityRevertToDetected

Input type: VulnerabilityRevertToDetectedInput

Arguments

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
comment String Comment why vulnerability was reverted to detected (maximum 50,000 characters).
id VulnerabilityID! ID of the vulnerability to be reverted to detected.

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.
vulnerability Vulnerability Vulnerability after state change.

Mutation.workItemAddClosingMergeRequest

Adds a closing merge request to a work item.

{{< details >}} Introduced in GitLab 17.1. Status: Experiment. {{< /details >}}

Input type: WorkItemAddClosingMergeRequestInput

Arguments

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
contextNamespacePath ID Full 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.
id WorkItemID! Global ID of the work item.
mergeRequestReference String! Merge request reference (short, full or URL). Example: !1, project_full_path!1 or https://gitlab.com/gitlab-org/gitlab/-/merge_requests/1.

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
closingMergeRequest WorkItemClosingMergeRequest Closing merge request added to the work item.
errors [String!]! Errors encountered during execution of the mutation.
workItem WorkItem Work item with new closing merge requests.

Mutation.workItemAddLinkedItems

Add linked items to the work item.

{{< details >}} Introduced in GitLab 16.3. Status: Experiment. {{< /details >}}

Input type: WorkItemAddLinkedItemsInput

Arguments

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
id WorkItemID! Global ID of the work item.
linkType WorkItemRelatedLinkType Type of link. Defaults to RELATED.
workItemsIds [WorkItemID!]! Global IDs of the items to link. Maximum number of IDs you can provide: 10.

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.
message String Linked items update result message.
workItem WorkItem Updated work item.

Mutation.workItemBulkUpdate

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

{{< details >}} Introduced in GitLab 17.4. Status: Experiment. {{< /details >}}

Input type: WorkItemBulkUpdateInput

Arguments

Name Type Description
clientMutationId String A 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.
labelsWidget WorkItemWidgetLabelsUpdateInput Input for labels widget.
parentId WorkItemsParentID! 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

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.
updatedWorkItemCount Int Number of work items that were successfully updated.

Mutation.workItemConvert

Converts the work item to a new type.

{{< details >}} Introduced in GitLab 15.11. Status: Experiment. {{< /details >}}

Input type: WorkItemConvertInput

Arguments

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
id WorkItemID! Global ID of the work item.
workItemTypeId WorkItemsTypeID! Global ID of the new work item type.

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.
workItem WorkItem Updated work item.

Mutation.workItemCreate

Creates a work item.

{{< details >}} Introduced in GitLab 15.1. Status: Experiment. {{< /details >}}

Input type: WorkItemCreateInput

Arguments

Name Type Description
assigneesWidget WorkItemWidgetAssigneesInput Input for assignees widget.
clientMutationId String A unique identifier for the client performing the mutation.
colorWidget WorkItemWidgetColorInput Input for color widget.
confidential Boolean Sets the work item confidentiality.
createdAt Time Timestamp when the work item was created. Available only for admins and project owners.
crmContactsWidget WorkItemWidgetCrmContactsCreateInput Input for CRM contacts widget.
customFieldsWidget {{< icon name=”warning-solid” >}} [WorkItemWidgetCustomFieldValueInputType!] Deprecated: Status: Experiment. Introduced in GitLab 17.10.
description {{< icon name=”warning-solid” >}} String Deprecated: use description widget instead. Deprecated in GitLab 16.9.
descriptionWidget WorkItemWidgetDescriptionInput Input for description widget.
discussionsToResolve WorkItemResolveDiscussionsInput Information required to resolve discussions in a noteable, when the work item is created.
healthStatusWidget WorkItemWidgetHealthStatusInput Input for health status widget.
hierarchyWidget WorkItemWidgetHierarchyCreateInput Input for hierarchy widget.
iterationWidget WorkItemWidgetIterationInput Iteration widget of the work item.
labelsWidget WorkItemWidgetLabelsCreateInput Input for labels widget.
linkedItemsWidget WorkItemWidgetLinkedItemsCreateInput Input for linked items widget.
milestoneWidget WorkItemWidgetMilestoneInput Input for milestone widget.
namespacePath ID Full path of the namespace(project or group) the work item is created in.
projectPath {{< icon name=”warning-solid” >}} ID Deprecated: Please use namespacePath instead. That will cover for both projects and groups. Deprecated in GitLab 15.10.
startAndDueDateWidget WorkItemWidgetStartAndDueDateUpdateInput Input for start and due date widget.
statusWidget {{< icon name=”warning-solid” >}} WorkItemWidgetStatusInput Deprecated: Status: Experiment. Introduced in GitLab 17.11.
title String! Title of the work item.
vulnerabilityId {{< icon name=”warning-solid” >}} VulnerabilityID Deprecated: Status: Experiment. Introduced in GitLab 17.9.
weightWidget WorkItemWidgetWeightInput Input for weight widget.
workItemTypeId WorkItemsTypeID! Global ID of a work item type.

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.
workItem WorkItem Created work item.

Mutation.workItemCreateFromTask

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

{{< details >}} Introduced in GitLab 15.1. Status: Experiment. {{< /details >}}

Input type: WorkItemCreateFromTaskInput

Arguments

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
id WorkItemID! Global ID of the work item.
workItemData WorkItemConvertTaskInput! Arguments necessary to convert a task into a work item.

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.
newWorkItem WorkItem New work item created from task.
workItem WorkItem Updated work item.

Mutation.workItemDelete

Deletes a work item.

{{< details >}} Introduced in GitLab 15.1. Status: Experiment. {{< /details >}}

Input type: WorkItemDeleteInput

Arguments

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
id WorkItemID! Global ID of the work item.

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.
namespace Namespace Namespace the deleted work item belonged to.
project {{< icon name=”warning-solid” >}} Project Deprecated: Use namespace. Deprecated in GitLab 16.9.

Mutation.workItemExport

{{< details >}} Deprecated in GitLab 18.0. Use WorkItemsCsvExport. {{< /details >}}

Input type: WorkItemExportInput

Arguments

Name Type Description
assigneeUsernames [String!] Usernames of users assigned to the work item.
assigneeWildcardId AssigneeWildcardId Filter by assignee wildcard. Incompatible with assigneeUsernames.
authorUsername String Filter work items by author username.
clientMutationId String A unique identifier for the client performing the mutation.
closedAfter Time Work items closed after the date.
closedBefore Time Work items closed before the date.
confidential Boolean Filter for confidential work items. If false, excludes confidential work items. If true, returns only confidential work items.
createdAfter Time Work items created after the timestamp.
createdBefore Time Work items created before the timestamp.
dueAfter Time Work items due after the timestamp.
dueBefore Time Work 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.
milestoneWildcardId MilestoneWildcardId Filter by milestone ID wildcard. Incompatible with milestoneTitle.
myReactionEmoji String Filter by reaction emoji applied by the current user. Wildcard values NONE and ANY are supported.
not NegatedWorkItemFilterInput Negated work item arguments.
or UnionedWorkItemFilterInput List of arguments with inclusive OR.
projectPath ID! Full project path.
search String Search query for title or description.
selectedFields [AvailableExportFields!] List of selected fields to be exported. Omit to export all available fields.
state IssuableState Current state of the work item.
subscribed SubscriptionStatus Work items the current user is subscribed to.
types [IssueType!] Filter work items by the given work item types.
updatedAfter Time Work items updated after the timestamp.
updatedBefore Time Work items updated before the timestamp.

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.
message String Export request result message.

Mutation.workItemRemoveLinkedItems

Remove items linked to the work item.

{{< details >}} Introduced in GitLab 16.3. Status: Experiment. {{< /details >}}

Input type: WorkItemRemoveLinkedItemsInput

Arguments

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
id WorkItemID! Global ID of the work item.
workItemsIds [WorkItemID!]! Global IDs of the items to unlink. Maximum number of IDs you can provide: 10.

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.
message String Linked items update result message.
workItem WorkItem Updated work item.

Mutation.workItemSubscribe

{{< details >}} Introduced in GitLab 16.3. Status: Experiment. {{< /details >}}

Input type: WorkItemSubscribeInput

Arguments

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
id WorkItemID! Global ID of the work item.
subscribed Boolean! Desired state of the subscription.

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.
workItem WorkItem Work item after mutation.

Mutation.workItemUpdate

Updates a work item by Global ID.

{{< details >}} Introduced in GitLab 15.1. Status: Experiment. {{< /details >}}

Input type: WorkItemUpdateInput

Arguments

Name Type Description
assigneesWidget WorkItemWidgetAssigneesInput Input for assignees widget.
awardEmojiWidget WorkItemWidgetAwardEmojiUpdateInput Input for emoji reactions widget.
clientMutationId String A unique identifier for the client performing the mutation.
colorWidget WorkItemWidgetColorInput Input for color widget.
confidential Boolean Sets the work item confidentiality.
crmContactsWidget WorkItemWidgetCrmContactsUpdateInput Input for CRM contacts widget.
currentUserTodosWidget WorkItemWidgetCurrentUserTodosInput Input for to-dos widget.
customFieldsWidget {{< icon name=”warning-solid” >}} [WorkItemWidgetCustomFieldValueInputType!] Deprecated: Status: Experiment. Introduced in GitLab 17.10.
descriptionWidget WorkItemWidgetDescriptionInput Input for description widget.
healthStatusWidget WorkItemWidgetHealthStatusInput Input for health status widget.
hierarchyWidget WorkItemWidgetHierarchyUpdateInput Input for hierarchy widget.
id WorkItemID! Global ID of the work item.
iterationWidget WorkItemWidgetIterationInput Input for iteration widget.
labelsWidget WorkItemWidgetLabelsUpdateInput Input for labels widget.
milestoneWidget WorkItemWidgetMilestoneInput Input for milestone widget.
notesWidget WorkItemWidgetNotesInput Input for notes widget.
notificationsWidget WorkItemWidgetNotificationsUpdateInput Input for notifications widget.
progressWidget WorkItemWidgetProgressInput Input for progress widget.
startAndDueDateWidget WorkItemWidgetStartAndDueDateUpdateInput Input for start and due date widget.
stateEvent WorkItemStateEvent Close or reopen a work item.
statusWidget {{< icon name=”warning-solid” >}} WorkItemWidgetStatusInput Deprecated: Status: Experiment. Introduced in GitLab 17.11.
timeTrackingWidget WorkItemWidgetTimeTrackingInput Input for time tracking widget.
title String Title of the work item.
verificationStatusWidget VerificationStatusInput Input for verification status widget.
weightWidget WorkItemWidgetWeightInput Input for weight widget.

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.
workItem WorkItem Updated work item.

Mutation.workItemUserPreferenceUpdate

Create or Update user preferences for a work item type and namespace.

{{< details >}} Introduced in GitLab 17.10. Status: Experiment. {{< /details >}}

Input type: WorkItemUserPreferenceUpdateInput

Arguments

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
namespacePath ID! Full path of the namespace on which the preference is set.
sort WorkItemSort Sort order for work item lists.
workItemTypeId WorkItemsTypeID Global ID of a work item type.

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.
userPreferences WorkItemTypesUserPreference User preferences.

Mutation.workItemsCsvExport

{{< details >}} Introduced in GitLab 15.10. Status: Experiment. {{< /details >}}

Input type: WorkItemsCsvExportInput

Arguments

Name Type Description
assigneeUsernames [String!] Usernames of users assigned to the work item.
assigneeWildcardId AssigneeWildcardId Filter by assignee wildcard. Incompatible with assigneeUsernames.
authorUsername String Filter work items by author username.
clientMutationId String A unique identifier for the client performing the mutation.
closedAfter Time Work items closed after the date.
closedBefore Time Work items closed before the date.
confidential Boolean Filter for confidential work items. If false, excludes confidential work items. If true, returns only confidential work items.
createdAfter Time Work items created after the timestamp.
createdBefore Time Work items created before the timestamp.
dueAfter Time Work items due after the timestamp.
dueBefore Time Work 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.
milestoneWildcardId MilestoneWildcardId Filter by milestone ID wildcard. Incompatible with milestoneTitle.
myReactionEmoji String Filter by reaction emoji applied by the current user. Wildcard values NONE and ANY are supported.
not NegatedWorkItemFilterInput Negated work item arguments.
or UnionedWorkItemFilterInput List of arguments with inclusive OR.
projectPath ID! Full project path.
search String Search query for title or description.
selectedFields [AvailableExportFields!] List of selected fields to be exported. Omit to export all available fields.
state IssuableState Current state of the work item.
subscribed SubscriptionStatus Work items the current user is subscribed to.
types [IssueType!] Filter work items by the given work item types.
updatedAfter Time Work items updated after the timestamp.
updatedBefore Time Work items updated before the timestamp.

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.
message String Export request result message.

Mutation.workItemsHierarchyReorder

Reorder a work item in the hierarchy tree.

{{< details >}} Introduced in GitLab 17.3. Status: Experiment. {{< /details >}}

Input type: workItemsHierarchyReorderInput

Arguments

Name Type Description
adjacentWorkItemId WorkItemID ID of the work item to move next to. For example, the item above or below.
clientMutationId String A unique identifier for the client performing the mutation.
id WorkItemID! Global ID of the work item to be reordered.
parentId WorkItemID Global ID of the new parent work item.
relativePosition RelativePositionType Position relative to the adjacent work item. Valid values are BEFORE or AFTER.

Fields

Name Type Description
adjacentWorkItem WorkItem Adjacent work item after mutation.
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.
parentWorkItem WorkItem Work item’s parent after mutation.
workItem WorkItem Work item after mutation.

Mutation.workspaceCreate

Input type: WorkspaceCreateInput

Arguments

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
clusterAgentId ClustersAgentID! GlobalID of the cluster agent the created workspace will be associated with.
desiredState String! Desired state of the created workspace.
devfilePath String Project path containing the devfile used to configure the workspace. If not provided, the GitLab default devfile is used.
devfileRef {{< icon name=”warning-solid” >}} String Deprecated: Argument is renamed to project_ref. Deprecated in GitLab 17.8.
editor {{< icon name=”warning-solid” >}} String Deprecated: Argument is not used. Deprecated in GitLab 17.5.
maxHoursBeforeTermination {{< icon name=”warning-solid” >}} Int Deprecated: Field is not used. Deprecated in GitLab 17.9.
projectId ProjectID! ID of the project that will provide the Devfile for the created workspace.
projectRef String Project repo git ref.
variables {{< icon name=”warning-solid” >}} [WorkspaceVariableInput!] Deprecated: Argument is renamed to workspace_variables. Deprecated in GitLab 18.0.
workspaceVariables {{< icon name=”warning-solid” >}} [WorkspaceVariableInput!] Deprecated: Status: Experiment. Introduced in GitLab 18.0.

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.
workspace Workspace Created workspace.

Mutation.workspaceUpdate

Input type: WorkspaceUpdateInput

Arguments

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
desiredState String! Desired state of the created workspace.
id RemoteDevelopmentWorkspaceID! Global ID of the workspace.

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.
workspace Workspace Created workspace.

Connections

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

Pagination arguments

All connection fields support the following pagination arguments:

Name Type Description
after String Returns the elements in the list that come after the specified cursor.
before String Returns the elements in the list that come before the specified cursor.
first Int Returns the first n elements from the list.
last Int Returns the last n elements from the list.

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

Connection fields

All connections have at least the following fields:

Name Type Description
pageInfo PageInfo! Pagination information.
edges [edge!] The edges.
nodes [item!] The items in the current page.

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

Connection types

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

AbuseReportDiscussionConnection

The connection type for AbuseReportDiscussion.

Fields
Name Type Description
edges [AbuseReportDiscussionEdge] A list of edges.
nodes [AbuseReportDiscussion] A list of nodes.
pageInfo PageInfo! Information to aid in pagination.

AbuseReportDiscussionEdge

The edge type for AbuseReportDiscussion.

Fields
Name Type Description
cursor String! A cursor for use in pagination.
node AbuseReportDiscussion The item at the end of the edge.

AbuseReportLabelConnection

The connection type for AbuseReportLabel.

Fields
Name Type Description
count Int! Total count of collection.
edges [AbuseReportLabelEdge] A list of edges.
nodes [AbuseReportLabel] A list of nodes.
pageInfo PageInfo! Information to aid in pagination.

AbuseReportLabelEdge

The edge type for AbuseReportLabel.

Fields
Name Type Description
cursor String! A cursor for use in pagination.
node AbuseReportLabel The item at the end of the edge.

AbuseReportNoteConnection

The connection type for AbuseReportNote.

Fields
Name Type Description
edges [AbuseReportNoteEdge] A list of edges.
nodes [AbuseReportNote] A list of nodes.
pageInfo PageInfo! Information to aid in pagination.

AbuseReportNoteEdge

The edge type for AbuseReportNote.

Fields
Name Type Description
cursor String! A cursor for use in pagination.
node AbuseReportNote The item at the end of the edge.

AccessLevelDeployKeyConnection

The connection type for AccessLevelDeployKey.

Fields
Name Type Description
edges [AccessLevelDeployKeyEdge] A list of edges.
nodes [AccessLevelDeployKey] A list of nodes.
pageInfo PageInfo! Information to aid in pagination.

AccessLevelDeployKeyEdge

The edge type for AccessLevelDeployKey.

Fields
Name Type Description
cursor String! A cursor for use in pagination.
node AccessLevelDeployKey The item at the end of the edge.

AchievementConnection

The connection type for Achievement.

Fields
Name Type Description
count Int! Total count of collection.
edges [AchievementEdge] A list of edges.
nodes [Achievement] A list of nodes.
pageInfo PageInfo! Information to aid in pagination.

AchievementEdge

The edge type for Achievement.

Fields
Name Type Description
cursor String! A cursor for use in pagination.
node Achievement The item at the end of the edge.

AddOnUserConnection

The connection type for AddOnUser.

Fields
Name Type Description
count Int! Total count of collection.
edges [AddOnUserEdge] A list of edges.
nodes [AddOnUser] A list of nodes.
pageInfo PageInfo! Information to aid in pagination.

AddOnUserEdge

The edge type for AddOnUser.

Fields
Name Type Description
cursor String! A cursor for use in pagination.
node AddOnUser The item at the end of the edge.

AdminMemberRoleConnection

The connection type for AdminMemberRole.

Fields
Name Type Description
edges [AdminMemberRoleEdge] A list of edges.
nodes [AdminMemberRole] A list of nodes.
pageInfo PageInfo! Information to aid in pagination.

AdminMemberRoleEdge

The edge type for AdminMemberRole.

Fields
Name Type Description
cursor String! A cursor for use in pagination.
node AdminMemberRole The item at the end of the edge.

AgentConfigurationConnection

The connection type for AgentConfiguration.

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

AgentConfigurationEdge

The edge type for AgentConfiguration.

Fields
Name Type Description
cursor String! A cursor for use in pagination.
node AgentConfiguration The item at the end of the edge.

AiAgentConnection

The connection type for AiAgent.

Fields
Name Type Description
edges [AiAgentEdge] A list of edges.
nodes [AiAgent] A list of nodes.
pageInfo PageInfo! Information to aid in pagination.

AiAgentEdge

The edge type for AiAgent.

Fields
Name Type Description
cursor String! A cursor for use in pagination.
node AiAgent The item at the end of the edge.

AiConversationsThreadConnection

The connection type for AiConversationsThread.

Fields
Name Type Description
edges [AiConversationsThreadEdge] A list of edges.
nodes [AiConversationsThread] A list of nodes.
pageInfo PageInfo! Information to aid in pagination.

AiConversationsThreadEdge

The edge type for AiConversationsThread.

Fields
Name Type Description
cursor String! A cursor for use in pagination.
node AiConversationsThread The item at the end of the edge.

AiFeatureSettingConnection

The connection type for AiFeatureSetting.

Fields
Name Type Description
edges [AiFeatureSettingEdge] A list of edges.
nodes [AiFeatureSetting] A list of nodes.
pageInfo PageInfo! Information to aid in pagination.

AiFeatureSettingEdge

The edge type for AiFeatureSetting.

Fields
Name Type Description
cursor String! A cursor for use in pagination.
node AiFeatureSetting The item at the end of the edge.

AiMessageConnection

The connection type for AiMessage.

Fields
Name Type Description
edges [AiMessageEdge] A list of edges.
nodes [AiMessage] A list of nodes.
pageInfo PageInfo! Information to aid in pagination.

AiMessageEdge

The edge type for AiMessage.

Fields
Name Type Description
cursor String! A cursor for use in pagination.
node AiMessage The item at the end of the edge.

AiSelfHostedModelConnection

The connection type for AiSelfHostedModel.

Fields
Name Type Description
edges [AiSelfHostedModelEdge] A list of edges.
nodes [AiSelfHostedModel] A list of nodes.
pageInfo PageInfo! Information to aid in pagination.

AiSelfHostedModelEdge

The edge type for AiSelfHostedModel.

Fields
Name Type Description
cursor String! A cursor for use in pagination.
node AiSelfHostedModel The item at the end of the edge.

AiUserMetricsConnection

The connection type for AiUserMetrics.

Fields
Name Type Description
edges [AiUserMetricsEdge] A list of edges.
nodes [AiUserMetrics] A list of nodes.
pageInfo PageInfo! Information to aid in pagination.

AiUserMetricsEdge

The edge type for AiUserMetrics.

Fields
Name Type Description
cursor String! A cursor for use in pagination.
node AiUserMetrics The item at the end of the edge.

AiXrayReportConnection

The connection type for AiXrayReport.

Fields
Name Type Description
edges [AiXrayReportEdge] A list of edges.
nodes [AiXrayReport] A list of nodes.
pageInfo PageInfo! Information to aid in pagination.

AiXrayReportEdge

The edge type for AiXrayReport.

Fields
Name Type Description
cursor String! A cursor for use in pagination.
node AiXrayReport The item at the end of the edge.

AlertManagementAlertConnection

The connection type for AlertManagementAlert.

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

AlertManagementAlertEdge

The edge type for AlertManagementAlert.

Fields
Name Type Description
cursor String! A cursor for use in pagination.
node AlertManagementAlert The item at the end of the edge.

AlertManagementHttpIntegrationConnection

The connection type for AlertManagementHttpIntegration.

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

AlertManagementHttpIntegrationEdge

The edge type for AlertManagementHttpIntegration.

Fields
Name Type Description
cursor String! A cursor for use in pagination.
node AlertManagementHttpIntegration The item at the end of the edge.

AlertManagementIntegrationConnection

The connection type for AlertManagementIntegration.

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

AlertManagementIntegrationEdge

The edge type for AlertManagementIntegration.

Fields
Name Type Description
cursor String! A cursor for use in pagination.
node AlertManagementIntegration The item at the end of the edge.

AmazonS3ConfigurationTypeConnection

The connection type for AmazonS3ConfigurationType.

Fields
Name Type Description
edges [AmazonS3ConfigurationTypeEdge] A list of edges.
nodes [AmazonS3ConfigurationType] A list of nodes.
pageInfo PageInfo! Information to aid in pagination.

AmazonS3ConfigurationTypeEdge

The edge type for AmazonS3ConfigurationType.

Fields
Name Type Description
cursor String! A cursor for use in pagination.
node AmazonS3ConfigurationType The item at the end of the edge.

ApprovalPolicyConnection

The connection type for ApprovalPolicy.

Fields
Name Type Description
edges [ApprovalPolicyEdge] A list of edges.
nodes [ApprovalPolicy] A list of nodes.
pageInfo PageInfo! Information to aid in pagination.

ApprovalPolicyEdge

The edge type for ApprovalPolicy.

Fields
Name Type Description
cursor String! A cursor for use in pagination.
node ApprovalPolicy The item at the end of the edge.

ApprovalProjectRuleConnection

The connection type for ApprovalProjectRule.

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

ApprovalProjectRuleEdge

The edge type for ApprovalProjectRule.

Fields
Name Type Description
cursor String! A cursor for use in pagination.
node ApprovalProjectRule The item at the end of the edge.

AuditEventDefinitionConnection

The connection type for AuditEventDefinition.

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

AuditEventDefinitionEdge

The edge type for AuditEventDefinition.

Fields
Name Type Description
cursor String! A cursor for use in pagination.
node AuditEventDefinition The item at the end of the edge.

AuditEventStreamingHeaderConnection

The connection type for AuditEventStreamingHeader.

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

AuditEventStreamingHeaderEdge

The edge type for AuditEventStreamingHeader.

Fields
Name Type Description
cursor String! A cursor for use in pagination.
node AuditEventStreamingHeader The item at the end of the edge.

AuditEventsStreamingInstanceHeaderConnection

The connection type for AuditEventsStreamingInstanceHeader.

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

AuditEventsStreamingInstanceHeaderEdge

The edge type for AuditEventsStreamingInstanceHeader.

Fields
Name Type Description
cursor String! A cursor for use in pagination.
node AuditEventsStreamingInstanceHeader The item at the end of the edge.

AwardEmojiConnection

The connection type for AwardEmoji.

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

AwardEmojiEdge

The edge type for AwardEmoji.

Fields
Name Type Description
cursor String! A cursor for use in pagination.
node AwardEmoji The item at the end of the edge.

BlobConnection

The connection type for Blob.

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

BlobEdge

The edge type for Blob.

Fields
Name Type Description
cursor String! A cursor for use in pagination.
node Blob The item at the end of the edge.

BoardConnection

The connection type for Board.

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

BoardEdge

The edge type for Board.

Fields
Name Type Description
cursor String! A cursor for use in pagination.
node Board The item at the end of the edge.

BoardEpicConnection

The connection type for BoardEpic.

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

BoardEpicEdge

The edge type for BoardEpic.

Fields
Name Type Description
cursor String! A cursor for use in pagination.
node BoardEpic The item at the end of the edge.

BoardListConnection

The connection type for BoardList.

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

BoardListEdge

The edge type for BoardList.

Fields
Name Type Description
cursor String! A cursor for use in pagination.
node BoardList The item at the end of the edge.

BranchRuleConnection

The connection type for BranchRule.

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

BranchRuleEdge

The edge type for BranchRule.

Fields
Name Type Description
cursor String! A cursor for use in pagination.
node BranchRule The item at the end of the edge.

CiBuildNeedConnection

The connection type for CiBuildNeed.

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

CiBuildNeedEdge

The edge type for CiBuildNeed.

Fields
Name Type Description
cursor String! A cursor for use in pagination.
node CiBuildNeed The item at the end of the edge.

CiCatalogResourceComponentConnection

The connection type for CiCatalogResourceComponent.

Fields
Name Type Description
edges [CiCatalogResourceComponentEdge] A list of edges.
nodes [CiCatalogResourceComponent] A list of nodes.
pageInfo PageInfo! Information to aid in pagination.

CiCatalogResourceComponentEdge

The edge type for CiCatalogResourceComponent.

Fields
Name Type Description
cursor String! A cursor for use in pagination.
node CiCatalogResourceComponent The item at the end of the edge.

CiCatalogResourceComponentUsageConnection

The connection type for CiCatalogResourceComponentUsage.

Fields
Name Type Description
edges [CiCatalogResourceComponentUsageEdge] A list of edges.
nodes [CiCatalogResourceComponentUsage] A list of nodes.
pageInfo PageInfo! Information to aid in pagination.

CiCatalogResourceComponentUsageEdge

The edge type for CiCatalogResourceComponentUsage.

Fields
Name Type Description
cursor String! A cursor for use in pagination.
node CiCatalogResourceComponentUsage The item at the end of the edge.

CiCatalogResourceConnection

The connection type for CiCatalogResource.

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

CiCatalogResourceEdge

The edge type for CiCatalogResource.

Fields
Name Type Description
cursor String! A cursor for use in pagination.
node CiCatalogResource The item at the end of the edge.

CiCatalogResourceVersionConnection

The connection type for CiCatalogResourceVersion.

Fields
Name Type Description
count Int! Total count of collection.
edges [CiCatalogResourceVersionEdge] A list of edges.
nodes [CiCatalogResourceVersion] A list of nodes.
pageInfo PageInfo! Information to aid in pagination.

CiCatalogResourceVersionEdge

The edge type for CiCatalogResourceVersion.

Fields
Name Type Description
cursor String! A cursor for use in pagination.
node CiCatalogResourceVersion The item at the end of the edge.

CiConfigGroupConnection

The connection type for CiConfigGroup.

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

CiConfigGroupEdge

The edge type for CiConfigGroup.

Fields
Name Type Description
cursor String! A cursor for use in pagination.
node CiConfigGroup The item at the end of the edge.

CiConfigJobConnection

The connection type for CiConfigJob.

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

CiConfigJobEdge

The edge type for CiConfigJob.

Fields
Name Type Description
cursor String! A cursor for use in pagination.
node CiConfigJob The item at the end of the edge.

CiConfigNeedConnection

The connection type for CiConfigNeed.

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

CiConfigNeedEdge

The edge type for CiConfigNeed.

Fields
Name Type Description
cursor String! A cursor for use in pagination.
node CiConfigNeed The item at the end of the edge.

CiConfigStageConnection

The connection type for CiConfigStage.

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

CiConfigStageEdge

The edge type for CiConfigStage.

Fields
Name Type Description
cursor String! A cursor for use in pagination.
node CiConfigStage The item at the end of the edge.

CiDedicatedHostedRunnerUsageConnection

The connection type for CiDedicatedHostedRunnerUsage.

Fields
Name Type Description
edges [CiDedicatedHostedRunnerUsageEdge] A list of edges.
nodes [CiDedicatedHostedRunnerUsage] A list of nodes.
pageInfo PageInfo! Information to aid in pagination.

CiDedicatedHostedRunnerUsageEdge

The edge type for CiDedicatedHostedRunnerUsage.

Fields
Name Type Description
cursor String! A cursor for use in pagination.
node CiDedicatedHostedRunnerUsage The item at the end of the edge.

CiDeletedRunnerConnection

The connection type for CiDeletedRunner.

Fields
Name Type Description
edges [CiDeletedRunnerEdge] A list of edges.
nodes [CiDeletedRunner] A list of nodes.
pageInfo PageInfo! Information to aid in pagination.

CiDeletedRunnerEdge

The edge type for CiDeletedRunner.

Fields
Name Type Description
cursor String! A cursor for use in pagination.
node CiDeletedRunner The item at the end of the edge.

CiGroupConnection

The connection type for CiGroup.

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

CiGroupEdge

The edge type for CiGroup.

Fields
Name Type Description
cursor String! A cursor for use in pagination.
node CiGroup The item at the end of the edge.

CiGroupEnvironmentScopeConnection

The connection type for CiGroupEnvironmentScope.

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

CiGroupEnvironmentScopeEdge

The edge type for CiGroupEnvironmentScope.

Fields
Name Type Description
cursor String! A cursor for use in pagination.
node CiGroupEnvironmentScope The item at the end of the edge.

CiGroupVariableConnection

The connection type for CiGroupVariable.

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

CiGroupVariableEdge

The edge type for CiGroupVariable.

Fields
Name Type Description
cursor String! A cursor for use in pagination.
node CiGroupVariable The item at the end of the edge.

CiInputsFieldConnection

The connection type for CiInputsField.

Fields
Name Type Description
edges [CiInputsFieldEdge] A list of edges.
nodes [CiInputsField] A list of nodes.
pageInfo PageInfo! Information to aid in pagination.

CiInputsFieldEdge

The edge type for CiInputsField.

Fields
Name Type Description
cursor String! A cursor for use in pagination.
node CiInputsField The item at the end of the edge.

CiInstanceVariableConnection

The connection type for CiInstanceVariable.

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

CiInstanceVariableEdge

The edge type for CiInstanceVariable.

Fields
Name Type Description
cursor String! A cursor for use in pagination.
node CiInstanceVariable The item at the end of the edge.

CiJobArtifactConnection

The connection type for CiJobArtifact.

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

CiJobArtifactEdge

The edge type for CiJobArtifact.

Fields
Name Type Description
cursor String! A cursor for use in pagination.
node CiJobArtifact The item at the end of the edge.

CiJobConnection

The connection type for CiJob.

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

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

Returns Int!.

# Arguments
Name Type Description
limit Int Limit value to be applied to the count query. Default is 1000.

CiJobEdge

The edge type for CiJob.

Fields
Name Type Description
cursor String! A cursor for use in pagination.
node CiJob The item at the end of the edge.

CiJobInterfaceConnection

The connection type for CiJobInterface.

Fields
Name Type Description
edges [CiJobInterfaceEdge] A list of edges.
nodes [CiJobInterface] A list of nodes.
pageInfo PageInfo! Information to aid in pagination.
Fields with arguments
CiJobInterfaceConnection.count

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

Returns Int!.

# Arguments
Name Type Description
limit Int Limit value to be applied to the count query. Default is 1000.

CiJobInterfaceEdge

The edge type for CiJobInterface.

Fields
Name Type Description
cursor String! A cursor for use in pagination.
node CiJobInterface The item at the end of the edge.

CiJobTokenAccessibleGroupConnection

The connection type for CiJobTokenAccessibleGroup.

Fields
Name Type Description
edges [CiJobTokenAccessibleGroupEdge] A list of edges.
nodes [CiJobTokenAccessibleGroup] A list of nodes.
pageInfo PageInfo! Information to aid in pagination.

CiJobTokenAccessibleGroupEdge

The edge type for CiJobTokenAccessibleGroup.

Fields
Name Type Description
cursor String! A cursor for use in pagination.
node CiJobTokenAccessibleGroup The item at the end of the edge.

CiJobTokenAccessibleProjectConnection

The connection type for CiJobTokenAccessibleProject.

Fields
Name Type Description
edges [CiJobTokenAccessibleProjectEdge] A list of edges.
nodes [CiJobTokenAccessibleProject] A list of nodes.
pageInfo PageInfo! Information to aid in pagination.

CiJobTokenAccessibleProjectEdge

The edge type for CiJobTokenAccessibleProject.

Fields
Name Type Description
cursor String! A cursor for use in pagination.
node CiJobTokenAccessibleProject The item at the end of the edge.

CiJobTokenAuthLogConnection

The connection type for CiJobTokenAuthLog.

Fields
Name Type Description
count Int! Total count of collection.
edges [CiJobTokenAuthLogEdge] A list of edges.
nodes [CiJobTokenAuthLog] A list of nodes.
pageInfo PageInfo! Information to aid in pagination.

CiJobTokenAuthLogEdge

The edge type for CiJobTokenAuthLog.

Fields
Name Type Description
cursor String! A cursor for use in pagination.
node CiJobTokenAuthLog The item at the end of the edge.

CiJobTokenScopeAllowlistEntryConnection

The connection type for CiJobTokenScopeAllowlistEntry.

Fields
Name Type Description
count Int! Total count of collection.
edges [CiJobTokenScopeAllowlistEntryEdge] A list of edges.
nodes [CiJobTokenScopeAllowlistEntry] A list of nodes.
pageInfo PageInfo! Information to aid in pagination.

CiJobTokenScopeAllowlistEntryEdge

The edge type for CiJobTokenScopeAllowlistEntry.

Fields
Name Type Description
cursor String! A cursor for use in pagination.
node CiJobTokenScopeAllowlistEntry The item at the end of the edge.

CiManualVariableConnection

The connection type for CiManualVariable.

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

CiManualVariableEdge

The edge type for CiManualVariable.

Fields
Name Type Description
cursor String! A cursor for use in pagination.
node CiManualVariable The item at the end of the edge.

CiMinutesNamespaceMonthlyUsageConnection

The connection type for CiMinutesNamespaceMonthlyUsage.

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

CiMinutesNamespaceMonthlyUsageEdge

The edge type for CiMinutesNamespaceMonthlyUsage.

Fields
Name Type Description
cursor String! A cursor for use in pagination.
node CiMinutesNamespaceMonthlyUsage The item at the end of the edge.

CiMinutesProjectMonthlyUsageConnection

The connection type for CiMinutesProjectMonthlyUsage.

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

CiMinutesProjectMonthlyUsageEdge

The edge type for CiMinutesProjectMonthlyUsage.

Fields
Name Type Description
cursor String! A cursor for use in pagination.
node CiMinutesProjectMonthlyUsage The item at the end of the edge.

CiProjectSubscriptionConnection

The connection type for CiProjectSubscription.

Fields
Name Type Description
count Int! Total count of collection.
edges [CiProjectSubscriptionEdge] A list of edges.
nodes [CiProjectSubscription] A list of nodes.
pageInfo PageInfo! Information to aid in pagination.

CiProjectSubscriptionEdge

The edge type for CiProjectSubscription.

Fields
Name Type Description
cursor String! A cursor for use in pagination.
node CiProjectSubscription The item at the end of the edge.

CiProjectVariableConnection

The connection type for CiProjectVariable.

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

CiProjectVariableEdge

The edge type for CiProjectVariable.

Fields
Name Type Description
cursor String! A cursor for use in pagination.
node CiProjectVariable The item at the end of the edge.

CiRunnerConnection

The connection type for CiRunner.

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

CiRunnerEdge

The edge type for CiRunner.

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

CiRunnerManagerConnection

The connection type for CiRunnerManager.

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

CiRunnerManagerEdge

The edge type for CiRunnerManager.

Fields
Name Type Description
cursor String! A cursor for use in pagination.
node CiRunnerManager The item at the end of the edge.

CiSecureFileRegistryConnection

The connection type for CiSecureFileRegistry.

Fields
Name Type Description
edges [CiSecureFileRegistryEdge] A list of edges.
nodes [CiSecureFileRegistry] A list of nodes.
pageInfo PageInfo! Information to aid in pagination.
Fields with arguments
CiSecureFileRegistryConnection.count

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

Returns Int!.

# Arguments
Name Type Description
limit Int Limit value to be applied to the count query. Default is 1000.

CiSecureFileRegistryEdge

The edge type for CiSecureFileRegistry.

Fields
Name Type Description
cursor String! A cursor for use in pagination.
node CiSecureFileRegistry The item at the end of the edge.

CiStageConnection

The connection type for CiStage.

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

CiStageEdge

The edge type for CiStage.

Fields
Name Type Description
cursor String! A cursor for use in pagination.
node CiStage The item at the end of the edge.

CiSubscriptionsProjectConnection

The connection type for CiSubscriptionsProject.

Fields
Name Type Description
count Int! Total count of collection.
edges [CiSubscriptionsProjectEdge] A list of edges.
nodes [CiSubscriptionsProject] A list of nodes.
pageInfo PageInfo! Information to aid in pagination.

CiSubscriptionsProjectEdge

The edge type for CiSubscriptionsProject.

Fields
Name Type Description
cursor String! A cursor for use in pagination.
node CiSubscriptionsProject The item at the end of the edge.

ClusterAgentActivityEventConnection

The connection type for ClusterAgentActivityEvent.

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

ClusterAgentActivityEventEdge

The edge type for ClusterAgentActivityEvent.

Fields
Name Type Description
cursor String! A cursor for use in pagination.
node ClusterAgentActivityEvent The item at the end of the edge.

ClusterAgentAuthorizationCiAccessConnection

The connection type for ClusterAgentAuthorizationCiAccess.

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

ClusterAgentAuthorizationCiAccessEdge

The edge type for ClusterAgentAuthorizationCiAccess.

Fields
Name Type Description
cursor String! A cursor for use in pagination.
node ClusterAgentAuthorizationCiAccess The item at the end of the edge.

ClusterAgentAuthorizationUserAccessConnection

The connection type for ClusterAgentAuthorizationUserAccess.

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

ClusterAgentAuthorizationUserAccessEdge

The edge type for ClusterAgentAuthorizationUserAccess.

Fields
Name Type Description
cursor String! A cursor for use in pagination.
node ClusterAgentAuthorizationUserAccess The item at the end of the edge.

ClusterAgentConnection

The connection type for ClusterAgent.

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

ClusterAgentEdge

The edge type for ClusterAgent.

Fields
Name Type Description
cursor String! A cursor for use in pagination.
node ClusterAgent The item at the end of the edge.

ClusterAgentTokenConnection

The connection type for ClusterAgentToken.

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

ClusterAgentTokenEdge

The edge type for ClusterAgentToken.

Fields
Name Type Description
cursor String! A cursor for use in pagination.
node ClusterAgentToken The item at the end of the edge.

ClusterAgentUrlConfigurationConnection

The connection type for ClusterAgentUrlConfiguration.

Fields
Name Type Description
count Int! Total count of collection.
edges [ClusterAgentUrlConfigurationEdge] A list of edges.
nodes [ClusterAgentUrlConfiguration] A list of nodes.
pageInfo PageInfo! Information to aid in pagination.

ClusterAgentUrlConfigurationEdge

The edge type for ClusterAgentUrlConfiguration.

Fields
Name Type Description
cursor String! A cursor for use in pagination.
node ClusterAgentUrlConfiguration The item at the end of the edge.

CodeCoverageActivityConnection

The connection type for CodeCoverageActivity.

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

CodeCoverageActivityEdge

The edge type for CodeCoverageActivity.

Fields
Name Type Description
cursor String! A cursor for use in pagination.
node CodeCoverageActivity The item at the end of the edge.

CodeQualityDegradationConnection

The connection type for CodeQualityDegradation.

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

CodeQualityDegradationEdge

The edge type for CodeQualityDegradation.

Fields
Name Type Description
cursor String! A cursor for use in pagination.
node CodeQualityDegradation The item at the end of the edge.

CodeSuggestionEventConnection

The connection type for CodeSuggestionEvent.

Fields
Name Type Description
edges [CodeSuggestionEventEdge] A list of edges.
nodes [CodeSuggestionEvent] A list of nodes.
pageInfo PageInfo! Information to aid in pagination.

CodeSuggestionEventEdge

The edge type for CodeSuggestionEvent.

Fields
Name Type Description
cursor String! A cursor for use in pagination.
node CodeSuggestionEvent The item at the end of the edge.

CommitConnection

The connection type for Commit.

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

CommitEdge

The edge type for Commit.

Fields
Name Type Description
cursor String! A cursor for use in pagination.
node Commit The item at the end of the edge.

ComplianceFrameworkConnection

The connection type for ComplianceFramework.

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

ComplianceFrameworkEdge

The edge type for ComplianceFramework.

Fields
Name Type Description
cursor String! A cursor for use in pagination.
node ComplianceFramework The item at the end of the edge.

ComplianceRequirementConnection

The connection type for ComplianceRequirement.

Fields
Name Type Description
edges [ComplianceRequirementEdge] A list of edges.
nodes [ComplianceRequirement] A list of nodes.
pageInfo PageInfo! Information to aid in pagination.

ComplianceRequirementEdge

The edge type for ComplianceRequirement.

Fields
Name Type Description
cursor String! A cursor for use in pagination.
node ComplianceRequirement The item at the end of the edge.

ComplianceRequirementsControlConnection

The connection type for ComplianceRequirementsControl.

Fields
Name Type Description
edges [ComplianceRequirementsControlEdge] A list of edges.
nodes [ComplianceRequirementsControl] A list of nodes.
pageInfo PageInfo! Information to aid in pagination.

ComplianceRequirementsControlEdge

The edge type for ComplianceRequirementsControl.

Fields
Name Type Description
cursor String! A cursor for use in pagination.
node ComplianceRequirementsControl The item at the end of the edge.

ComplianceStandardsAdherenceConnection

The connection type for ComplianceStandardsAdherence.

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

ComplianceStandardsAdherenceEdge

The edge type for ComplianceStandardsAdherence.

Fields
Name Type Description
cursor String! A cursor for use in pagination.
node ComplianceStandardsAdherence The item at the end of the edge.

ComplianceViolationConnection

The connection type for ComplianceViolation.

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

ComplianceViolationEdge

The edge type for ComplianceViolation.

Fields
Name Type Description
cursor String! A cursor for use in pagination.
node ComplianceViolation The item at the end of the edge.

ComponentVersionConnection

The connection type for ComponentVersion.

Fields
Name Type Description
edges [ComponentVersionEdge] A list of edges.
nodes [ComponentVersion] A list of nodes.
pageInfo PageInfo! Information to aid in pagination.

ComponentVersionEdge

The edge type for ComponentVersion.

Fields
Name Type Description
cursor String! A cursor for use in pagination.
node ComponentVersion The item at the end of the edge.

ConnectedAgentConnection

The connection type for ConnectedAgent.

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

ConnectedAgentEdge

The edge type for ConnectedAgent.

Fields
Name Type Description
cursor String! A cursor for use in pagination.
node ConnectedAgent The item at the end of the edge.

ContainerProtectionRepositoryRuleConnection

The connection type for ContainerProtectionRepositoryRule.

Fields
Name Type Description
edges [ContainerProtectionRepositoryRuleEdge] A list of edges.
nodes [ContainerProtectionRepositoryRule] A list of nodes.
pageInfo PageInfo! Information to aid in pagination.

ContainerProtectionRepositoryRuleEdge

The edge type for ContainerProtectionRepositoryRule.

Fields
Name Type Description
cursor String! A cursor for use in pagination.
node ContainerProtectionRepositoryRule The item at the end of the edge.

ContainerProtectionTagRuleConnection

The connection type for ContainerProtectionTagRule.

Fields
Name Type Description
edges [ContainerProtectionTagRuleEdge] A list of edges.
nodes [ContainerProtectionTagRule] A list of nodes.
pageInfo PageInfo! Information to aid in pagination.

ContainerProtectionTagRuleEdge

The edge type for ContainerProtectionTagRule.

Fields
Name Type Description
cursor String! A cursor for use in pagination.
node ContainerProtectionTagRule The item at the end of the edge.

ContainerRepositoryConnection

The connection type for ContainerRepository.

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

ContainerRepositoryEdge

The edge type for ContainerRepository.

Fields
Name Type Description
cursor String! A cursor for use in pagination.
node ContainerRepository The item at the end of the edge.

ContainerRepositoryRegistryConnection

The connection type for ContainerRepositoryRegistry.

Fields
Name Type Description
edges [ContainerRepositoryRegistryEdge] A list of edges.
nodes [ContainerRepositoryRegistry] A list of nodes.
pageInfo PageInfo! Information to aid in pagination.
Fields with arguments
ContainerRepositoryRegistryConnection.count

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

Returns Int!.

# Arguments
Name Type Description
limit Int Limit value to be applied to the count query. Default is 1000.

ContainerRepositoryRegistryEdge

The edge type for ContainerRepositoryRegistry.

Fields
Name Type Description
cursor String! A cursor for use in pagination.
node ContainerRepositoryRegistry The item at the end of the edge.

ContainerRepositoryTagConnection

The connection type for ContainerRepositoryTag.

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

ContainerRepositoryTagEdge

The edge type for ContainerRepositoryTag.

Fields
Name Type Description
cursor String! A cursor for use in pagination.
node ContainerRepositoryTag The item at the end of the edge.

ContributionAnalyticsContributionConnection

The connection type for ContributionAnalyticsContribution.

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

ContributionAnalyticsContributionEdge

The edge type for ContributionAnalyticsContribution.

Fields
Name Type Description
cursor String! A cursor for use in pagination.
node ContributionAnalyticsContribution The item at the end of the edge.

CoverageFuzzingCorpusConnection

The connection type for CoverageFuzzingCorpus.

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

CoverageFuzzingCorpusEdge

The edge type for CoverageFuzzingCorpus.

Fields
Name Type Description
cursor String! A cursor for use in pagination.
node CoverageFuzzingCorpus The item at the end of the edge.

CustomEmojiConnection

The connection type for CustomEmoji.

Fields
Name Type Description
count Int! Total count of collection.
edges [CustomEmojiEdge] A list of edges.
nodes [CustomEmoji] A list of nodes.
pageInfo PageInfo! Information to aid in pagination.

CustomEmojiEdge

The edge type for CustomEmoji.

Fields
Name Type Description
cursor String! A cursor for use in pagination.
node CustomEmoji The item at the end of the edge.

CustomFieldConnection

The connection type for CustomField.

Fields
Name Type Description
count Int! Total count of collection.
edges [CustomFieldEdge] A list of edges.
nodes [CustomField] A list of nodes.
pageInfo PageInfo! Information to aid in pagination.

CustomFieldEdge

The edge type for CustomField.

Fields
Name Type Description
cursor String! A cursor for use in pagination.
node CustomField The item at the end of the edge.

CustomerRelationsContactConnection

The connection type for CustomerRelationsContact.

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

CustomerRelationsContactEdge

The edge type for CustomerRelationsContact.

Fields
Name Type Description
cursor String! A cursor for use in pagination.
node CustomerRelationsContact The item at the end of the edge.

CustomerRelationsOrganizationConnection

The connection type for CustomerRelationsOrganization.

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

CustomerRelationsOrganizationEdge

The edge type for CustomerRelationsOrganization.

Fields
Name Type Description
cursor String! A cursor for use in pagination.
node CustomerRelationsOrganization The item at the end of the edge.

CustomizableAdminPermissionConnection

The connection type for CustomizableAdminPermission.

Fields
Name Type Description
edges [CustomizableAdminPermissionEdge] A list of edges.
nodes [CustomizableAdminPermission] A list of nodes.
pageInfo PageInfo! Information to aid in pagination.

CustomizableAdminPermissionEdge

The edge type for CustomizableAdminPermission.

Fields
Name Type Description
cursor String! A cursor for use in pagination.
node CustomizableAdminPermission The item at the end of the edge.

CustomizableDashboardConnection

The connection type for CustomizableDashboard.

Fields
Name Type Description
edges [CustomizableDashboardEdge] A list of edges.
nodes [CustomizableDashboard] A list of nodes.
pageInfo PageInfo! Information to aid in pagination.

CustomizableDashboardEdge

The edge type for CustomizableDashboard.

Fields
Name Type Description
cursor String! A cursor for use in pagination.
node CustomizableDashboard The item at the end of the edge.

CustomizableDashboardPanelConnection

The connection type for CustomizableDashboardPanel.

Fields
Name Type Description
edges [CustomizableDashboardPanelEdge] A list of edges.
nodes [CustomizableDashboardPanel] A list of nodes.
pageInfo PageInfo! Information to aid in pagination.

CustomizableDashboardPanelEdge

The edge type for CustomizableDashboardPanel.

Fields
Name Type Description
cursor String! A cursor for use in pagination.
node CustomizableDashboardPanel The item at the end of the edge.

CustomizableDashboardVisualizationConnection

The connection type for CustomizableDashboardVisualization.

Fields
Name Type Description
edges [CustomizableDashboardVisualizationEdge] A list of edges.
nodes [CustomizableDashboardVisualization] A list of nodes.
pageInfo PageInfo! Information to aid in pagination.

CustomizableDashboardVisualizationEdge

The edge type for CustomizableDashboardVisualization.

Fields
Name Type Description
cursor String! A cursor for use in pagination.
node CustomizableDashboardVisualization The item at the end of the edge.

CustomizableStandardPermissionConnection

The connection type for CustomizableStandardPermission.

Fields
Name Type Description
edges [CustomizableStandardPermissionEdge] A list of edges.
nodes [CustomizableStandardPermission] A list of nodes.
pageInfo PageInfo! Information to aid in pagination.

CustomizableStandardPermissionEdge

The edge type for CustomizableStandardPermission.

Fields
Name Type Description
cursor String! A cursor for use in pagination.
node CustomizableStandardPermission The item at the end of the edge.

DastProfileConnection

The connection type for DastProfile.

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

DastProfileEdge

The edge type for DastProfile.

Fields
Name Type Description
cursor String! A cursor for use in pagination.
node DastProfile The item at the end of the edge.

DastScannerProfileConnection

The connection type for DastScannerProfile.

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

DastScannerProfileEdge

The edge type for DastScannerProfile.

Fields
Name Type Description
cursor String! A cursor for use in pagination.
node DastScannerProfile The item at the end of the edge.

DastSiteProfileConnection

The connection type for DastSiteProfile.

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

DastSiteProfileEdge

The edge type for DastSiteProfile.

Fields
Name Type Description
cursor String! A cursor for use in pagination.
node DastSiteProfile The item at the end of the edge.

DastSiteValidationConnection

The connection type for DastSiteValidation.

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

DastSiteValidationEdge

The edge type for DastSiteValidation.

Fields
Name Type Description
cursor String! A cursor for use in pagination.
node DastSiteValidation The item at the end of the edge.

DependencyAggregationConnection

The connection type for DependencyAggregation.

Fields
Name Type Description
edges [DependencyAggregationEdge] A list of edges.
nodes [DependencyAggregation] A list of nodes.
pageInfo PageInfo! Information to aid in pagination.

DependencyAggregationEdge

The edge type for DependencyAggregation.

Fields
Name Type Description
cursor String! A cursor for use in pagination.
node DependencyAggregation The item at the end of the edge.

DependencyConnection

The connection type for Dependency.

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

DependencyEdge

The edge type for Dependency.

Fields
Name Type Description
cursor String! A cursor for use in pagination.
node Dependency The item at the end of the edge.

DependencyProxyBlobConnection

The connection type for DependencyProxyBlob.

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

DependencyProxyBlobEdge

The edge type for DependencyProxyBlob.

Fields
Name Type Description
cursor String! A cursor for use in pagination.
node DependencyProxyBlob The item at the end of the edge.

DependencyProxyBlobRegistryConnection

The connection type for DependencyProxyBlobRegistry.

Fields
Name Type Description
edges [DependencyProxyBlobRegistryEdge] A list of edges.
nodes [DependencyProxyBlobRegistry] A list of nodes.
pageInfo PageInfo! Information to aid in pagination.
Fields with arguments
DependencyProxyBlobRegistryConnection.count

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

Returns Int!.

# Arguments
Name Type Description
limit Int Limit value to be applied to the count query. Default is 1000.

DependencyProxyBlobRegistryEdge

The edge type for DependencyProxyBlobRegistry.

Fields
Name Type Description
cursor String! A cursor for use in pagination.
node DependencyProxyBlobRegistry The item at the end of the edge.

DependencyProxyManifestConnection

The connection type for DependencyProxyManifest.

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

DependencyProxyManifestEdge

The edge type for DependencyProxyManifest.

Fields
Name Type Description
cursor String! A cursor for use in pagination.
node DependencyProxyManifest The item at the end of the edge.

DependencyProxyManifestRegistryConnection

The connection type for DependencyProxyManifestRegistry.

Fields
Name Type Description
edges [DependencyProxyManifestRegistryEdge] A list of edges.
nodes [DependencyProxyManifestRegistry] A list of nodes.
pageInfo PageInfo! Information to aid in pagination.
Fields with arguments
DependencyProxyManifestRegistryConnection.count

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

Returns Int!.

# Arguments
Name Type Description
limit Int Limit value to be applied to the count query. Default is 1000.

DependencyProxyManifestRegistryEdge

The edge type for DependencyProxyManifestRegistry.

Fields
Name Type Description
cursor String! A cursor for use in pagination.
node DependencyProxyManifestRegistry The item at the end of the edge.

DeploymentConnection

The connection type for Deployment.

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

DeploymentEdge

The edge type for Deployment.

Fields
Name Type Description
cursor String! A cursor for use in pagination.
node Deployment The item at the end of the edge.

DesignAtVersionConnection

The connection type for DesignAtVersion.

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

DesignAtVersionEdge

The edge type for DesignAtVersion.

Fields
Name Type Description
cursor String! A cursor for use in pagination.
node DesignAtVersion The item at the end of the edge.

DesignConnection

The connection type for Design.

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

DesignEdge

The edge type for Design.

Fields
Name Type Description
cursor String! A cursor for use in pagination.
node Design The item at the end of the edge.

DesignManagementRepositoryRegistryConnection

The connection type for DesignManagementRepositoryRegistry.

Fields
Name Type Description
edges [DesignManagementRepositoryRegistryEdge] A list of edges.
nodes [DesignManagementRepositoryRegistry] A list of nodes.
pageInfo PageInfo! Information to aid in pagination.
Fields with arguments
DesignManagementRepositoryRegistryConnection.count

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

Returns Int!.

# Arguments
Name Type Description
limit Int Limit value to be applied to the count query. Default is 1000.

DesignManagementRepositoryRegistryEdge

The edge type for DesignManagementRepositoryRegistry.

Fields
Name Type Description
cursor String! A cursor for use in pagination.
node DesignManagementRepositoryRegistry The item at the end of the edge.

DesignVersionConnection

The connection type for DesignVersion.

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

DesignVersionEdge

The edge type for DesignVersion.

Fields
Name Type Description
cursor String! A cursor for use in pagination.
node DesignVersion The item at the end of the edge.

DevopsAdoptionEnabledNamespaceConnection

The connection type for DevopsAdoptionEnabledNamespace.

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

DevopsAdoptionEnabledNamespaceEdge

The edge type for DevopsAdoptionEnabledNamespace.

Fields
Name Type Description
cursor String! A cursor for use in pagination.
node DevopsAdoptionEnabledNamespace The item at the end of the edge.

DevopsAdoptionSnapshotConnection

The connection type for DevopsAdoptionSnapshot.

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

DevopsAdoptionSnapshotEdge

The edge type for DevopsAdoptionSnapshot.

Fields
Name Type Description
cursor String! A cursor for use in pagination.
node DevopsAdoptionSnapshot The item at the end of the edge.

DiscussionConnection

The connection type for Discussion.

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

DiscussionEdge

The edge type for Discussion.

Fields
Name Type Description
cursor String! A cursor for use in pagination.
node Discussion The item at the end of the edge.

DoraPerformanceScoreCountConnection

The connection type for DoraPerformanceScoreCount.

Fields
Name Type Description
edges [DoraPerformanceScoreCountEdge] A list of edges.
noDoraDataProjectsCount Int! Count of projects without any DORA scores within the scope.
nodes [DoraPerformanceScoreCount] A list of nodes.
pageInfo PageInfo! Information to aid in pagination.
totalProjectsCount Int! Count of total projects.

DoraPerformanceScoreCountEdge

The edge type for DoraPerformanceScoreCount.

Fields
Name Type Description
cursor String! A cursor for use in pagination.
node DoraPerformanceScoreCount The item at the end of the edge.

DuoWorkflowConnection

The connection type for DuoWorkflow.

Fields
Name Type Description
edges [DuoWorkflowEdge] A list of edges.
nodes [DuoWorkflow] A list of nodes.
pageInfo PageInfo! Information to aid in pagination.

DuoWorkflowEdge

The edge type for DuoWorkflow.

Fields
Name Type Description
cursor String! A cursor for use in pagination.
node DuoWorkflow The item at the end of the edge.

DuoWorkflowEventConnection

The connection type for DuoWorkflowEvent.

Fields
Name Type Description
edges [DuoWorkflowEventEdge] A list of edges.
nodes [DuoWorkflowEvent] A list of nodes.
pageInfo PageInfo! Information to aid in pagination.

DuoWorkflowEventEdge

The edge type for DuoWorkflowEvent.

Fields
Name Type Description
cursor String! A cursor for use in pagination.
node DuoWorkflowEvent The item at the end of the edge.

EgressNodeConnection

The connection type for EgressNode.

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

EgressNodeEdge

The edge type for EgressNode.

Fields
Name Type Description
cursor String! A cursor for use in pagination.
node EgressNode The item at the end of the edge.

EmailConnection

The connection type for Email.

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

EmailEdge

The edge type for Email.

Fields
Name Type Description
cursor String! A cursor for use in pagination.
node Email The item at the end of the edge.

EmailParticipantTypeConnection

The connection type for EmailParticipantType.

Fields
Name Type Description
edges [EmailParticipantTypeEdge] A list of edges.
nodes [EmailParticipantType] A list of nodes.
pageInfo PageInfo! Information to aid in pagination.

EmailParticipantTypeEdge

The edge type for EmailParticipantType.

Fields
Name Type Description
cursor String! A cursor for use in pagination.
node EmailParticipantType The item at the end of the edge.

EnvironmentConnection

The connection type for Environment.

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

EnvironmentEdge

The edge type for Environment.

Fields
Name Type Description
cursor String! A cursor for use in pagination.
node Environment The item at the end of the edge.

EpicBoardConnection

The connection type for EpicBoard.

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

EpicBoardEdge

The edge type for EpicBoard.

Fields
Name Type Description
cursor String! A cursor for use in pagination.
node EpicBoard The item at the end of the edge.

EpicConnection

The connection type for Epic.

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

EpicEdge

The edge type for Epic.

Fields
Name Type Description
cursor String! A cursor for use in pagination.
node Epic The item at the end of the edge.

EpicIssueConnection

The connection type for EpicIssue.

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

EpicIssueEdge

The edge type for EpicIssue.

Fields
Name Type Description
cursor String! A cursor for use in pagination.
node EpicIssue The item at the end of the edge.

EpicListConnection

The connection type for EpicList.

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

EpicListEdge

The edge type for EpicList.

Fields
Name Type Description
cursor String! A cursor for use in pagination.
node EpicList The item at the end of the edge.

ErrorTrackingStackTraceConnection

The connection type for ErrorTrackingStackTrace.

Fields
Name Type Description
count Int! Total count of collection.
edges [ErrorTrackingStackTraceEdge] A list of edges.
nodes [ErrorTrackingStackTrace] A list of nodes.
pageInfo PageInfo! Information to aid in pagination.

ErrorTrackingStackTraceEdge

The edge type for ErrorTrackingStackTrace.

Fields
Name Type Description
cursor String! A cursor for use in pagination.
node ErrorTrackingStackTrace The item at the end of the edge.

EscalationPolicyTypeConnection

The connection type for EscalationPolicyType.

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

EscalationPolicyTypeEdge

The edge type for EscalationPolicyType.

Fields
Name Type Description
cursor String! A cursor for use in pagination.
node EscalationPolicyType The item at the end of the edge.

EventConnection

The connection type for Event.

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

EventEdge

The edge type for Event.

Fields
Name Type Description
cursor String! A cursor for use in pagination.
node Event The item at the end of the edge.

ExternalAuditEventDestinationConnection

The connection type for ExternalAuditEventDestination.

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

ExternalAuditEventDestinationEdge

The edge type for ExternalAuditEventDestination.

Fields
Name Type Description
cursor String! A cursor for use in pagination.
node ExternalAuditEventDestination The item at the end of the edge.

ExternalStatusCheckConnection

The connection type for ExternalStatusCheck.

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

ExternalStatusCheckEdge

The edge type for ExternalStatusCheck.

Fields
Name Type Description
cursor String! A cursor for use in pagination.
node ExternalStatusCheck The item at the end of the edge.

FeatureFlagConnection

The connection type for FeatureFlag.

Fields
Name Type Description
edges [FeatureFlagEdge] A list of edges.
nodes [FeatureFlag] A list of nodes.
pageInfo PageInfo! Information to aid in pagination.

FeatureFlagEdge

The edge type for FeatureFlag.

Fields
Name Type Description
cursor String! A cursor for use in pagination.
node FeatureFlag The item at the end of the edge.

GitlabSubscriptionHistoryConnection

The connection type for GitlabSubscriptionHistory.

Fields
Name Type Description
edges [GitlabSubscriptionHistoryEdge] A list of edges.
nodes [GitlabSubscriptionHistory] A list of nodes.
pageInfo PageInfo! Information to aid in pagination.

GitlabSubscriptionHistoryEdge

The edge type for GitlabSubscriptionHistory.

Fields
Name Type Description
cursor String! A cursor for use in pagination.
node GitlabSubscriptionHistory The item at the end of the edge.

GoogleCloudArtifactRegistryArtifactConnection

The connection type for GoogleCloudArtifactRegistryArtifact.

Fields
Name Type Description
edges [GoogleCloudArtifactRegistryArtifactEdge] A list of edges.
nodes [GoogleCloudArtifactRegistryArtifact] A list of nodes.
pageInfo PageInfo! Information to aid in pagination.

GoogleCloudArtifactRegistryArtifactEdge

The edge type for GoogleCloudArtifactRegistryArtifact.

Fields
Name Type Description
cursor String! A cursor for use in pagination.
node GoogleCloudArtifactRegistryArtifact The item at the end of the edge.

GoogleCloudLoggingConfigurationTypeConnection

The connection type for GoogleCloudLoggingConfigurationType.

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

GoogleCloudLoggingConfigurationTypeEdge

The edge type for GoogleCloudLoggingConfigurationType.

Fields
Name Type Description
cursor String! A cursor for use in pagination.
node GoogleCloudLoggingConfigurationType The item at the end of the edge.

GroupAuditEventStreamingDestinationConnection

The connection type for GroupAuditEventStreamingDestination.

Fields
Name Type Description
edges [GroupAuditEventStreamingDestinationEdge] A list of edges.
nodes [GroupAuditEventStreamingDestination] A list of nodes.
pageInfo PageInfo! Information to aid in pagination.

GroupAuditEventStreamingDestinationEdge

The edge type for GroupAuditEventStreamingDestination.

Fields
Name Type Description
cursor String! A cursor for use in pagination.
node GroupAuditEventStreamingDestination The item at the end of the edge.

GroupConnection

The connection type for Group.

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

GroupEdge

The edge type for Group.

Fields
Name Type Description
cursor String! A cursor for use in pagination.
node Group The item at the end of the edge.

GroupInterfaceConnection

The connection type for GroupInterface.

Fields
Name Type Description
edges [GroupInterfaceEdge] A list of edges.
nodes [GroupInterface] A list of nodes.
pageInfo PageInfo! Information to aid in pagination.

GroupInterfaceEdge

The edge type for GroupInterface.

Fields
Name Type Description
cursor String! A cursor for use in pagination.
node GroupInterface The item at the end of the edge.

GroupMemberConnection

The connection type for GroupMember.

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

GroupMemberEdge

The edge type for GroupMember.

Fields
Name Type Description
cursor String! A cursor for use in pagination.
node GroupMember The item at the end of the edge.

GroupSavedReplyConnection

The connection type for GroupSavedReply.

Fields
Name Type Description
count Int! Total count of collection.
edges [GroupSavedReplyEdge] A list of edges.
nodes [GroupSavedReply] A list of nodes.
pageInfo PageInfo! Information to aid in pagination.

GroupSavedReplyEdge

The edge type for GroupSavedReply.

Fields
Name Type Description
cursor String! A cursor for use in pagination.
node GroupSavedReply The item at the end of the edge.

GroupWikiRepositoryRegistryConnection

The connection type for GroupWikiRepositoryRegistry.

Fields
Name Type Description
edges [GroupWikiRepositoryRegistryEdge] A list of edges.
nodes [GroupWikiRepositoryRegistry] A list of nodes.
pageInfo PageInfo! Information to aid in pagination.
Fields with arguments
GroupWikiRepositoryRegistryConnection.count

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

Returns Int!.

# Arguments
Name Type Description
limit Int Limit value to be applied to the count query. Default is 1000.

GroupWikiRepositoryRegistryEdge

The edge type for GroupWikiRepositoryRegistry.

Fields
Name Type Description
cursor String! A cursor for use in pagination.
node GroupWikiRepositoryRegistry The item at the end of the edge.

ImportSourceUserConnection

The connection type for ImportSourceUser.

Fields
Name Type Description
edges [ImportSourceUserEdge] A list of edges.
nodes [ImportSourceUser] A list of nodes.
pageInfo PageInfo! Information to aid in pagination.

ImportSourceUserEdge

The edge type for ImportSourceUser.

Fields
Name Type Description
cursor String! A cursor for use in pagination.
node ImportSourceUser The item at the end of the edge.

IncidentManagementOncallRotationConnection

The connection type for IncidentManagementOncallRotation.

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

IncidentManagementOncallRotationEdge

The edge type for IncidentManagementOncallRotation.

Fields
Name Type Description
cursor String! A cursor for use in pagination.
node IncidentManagementOncallRotation The item at the end of the edge.

IncidentManagementOncallScheduleConnection

The connection type for IncidentManagementOncallSchedule.

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

IncidentManagementOncallScheduleEdge

The edge type for IncidentManagementOncallSchedule.

Fields
Name Type Description
cursor String! A cursor for use in pagination.
node IncidentManagementOncallSchedule The item at the end of the edge.

IncidentManagementOncallShiftConnection

The connection type for IncidentManagementOncallShift.

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

IncidentManagementOncallShiftEdge

The edge type for IncidentManagementOncallShift.

Fields
Name Type Description
cursor String! A cursor for use in pagination.
node IncidentManagementOncallShift The item at the end of the edge.

InheritedCiVariableConnection

The connection type for InheritedCiVariable.

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

InheritedCiVariableEdge

The edge type for InheritedCiVariable.

Fields
Name Type Description
cursor String! A cursor for use in pagination.
node InheritedCiVariable The item at the end of the edge.

InstanceAmazonS3ConfigurationTypeConnection

The connection type for InstanceAmazonS3ConfigurationType.

Fields
Name Type Description
edges [InstanceAmazonS3ConfigurationTypeEdge] A list of edges.
nodes [InstanceAmazonS3ConfigurationType] A list of nodes.
pageInfo PageInfo! Information to aid in pagination.

InstanceAmazonS3ConfigurationTypeEdge

The edge type for InstanceAmazonS3ConfigurationType.

Fields
Name Type Description
cursor String! A cursor for use in pagination.
node InstanceAmazonS3ConfigurationType The item at the end of the edge.

InstanceAuditEventStreamingDestinationConnection

The connection type for InstanceAuditEventStreamingDestination.

Fields
Name Type Description
edges [InstanceAuditEventStreamingDestinationEdge] A list of edges.
nodes [InstanceAuditEventStreamingDestination] A list of nodes.
pageInfo PageInfo! Information to aid in pagination.

InstanceAuditEventStreamingDestinationEdge

The edge type for InstanceAuditEventStreamingDestination.

Fields
Name Type Description
cursor String! A cursor for use in pagination.
node InstanceAuditEventStreamingDestination The item at the end of the edge.

InstanceExternalAuditEventDestinationConnection

The connection type for InstanceExternalAuditEventDestination.

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

InstanceExternalAuditEventDestinationEdge

The edge type for InstanceExternalAuditEventDestination.

Fields
Name Type Description
cursor String! A cursor for use in pagination.
node InstanceExternalAuditEventDestination The item at the end of the edge.

InstanceGoogleCloudLoggingConfigurationTypeConnection

The connection type for InstanceGoogleCloudLoggingConfigurationType.

Fields
Name Type Description
edges [InstanceGoogleCloudLoggingConfigurationTypeEdge] A list of edges.
nodes [InstanceGoogleCloudLoggingConfigurationType] A list of nodes.
pageInfo PageInfo! Information to aid in pagination.

InstanceGoogleCloudLoggingConfigurationTypeEdge

The edge type for InstanceGoogleCloudLoggingConfigurationType.

Fields
Name Type Description
cursor String! A cursor for use in pagination.
node InstanceGoogleCloudLoggingConfigurationType The item at the end of the edge.

IntegrationExclusionConnection

The connection type for IntegrationExclusion.

Fields
Name Type Description
edges [IntegrationExclusionEdge] A list of edges.
nodes [IntegrationExclusion] A list of nodes.
pageInfo PageInfo! Information to aid in pagination.

IntegrationExclusionEdge

The edge type for IntegrationExclusion.

Fields
Name Type Description
cursor String! A cursor for use in pagination.
node IntegrationExclusion The item at the end of the edge.

IssuableResourceLinkConnection

The connection type for IssuableResourceLink.

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

IssuableResourceLinkEdge

The edge type for IssuableResourceLink.

Fields
Name Type Description
cursor String! A cursor for use in pagination.
node IssuableResourceLink The item at the end of the edge.

IssueConnection

The connection type for Issue.

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

IssueEdge

The edge type for Issue.

Fields
Name Type Description
cursor String! A cursor for use in pagination.
node Issue The item at the end of the edge.

IterationCadenceConnection

The connection type for IterationCadence.

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

IterationCadenceEdge

The edge type for IterationCadence.

Fields
Name Type Description
cursor String! A cursor for use in pagination.
node IterationCadence The item at the end of the edge.

IterationConnection

The connection type for Iteration.

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

IterationEdge

The edge type for Iteration.

Fields
Name Type Description
cursor String! A cursor for use in pagination.
node Iteration The item at the end of the edge.

JiraImportConnection

The connection type for JiraImport.

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

JiraImportEdge

The edge type for JiraImport.

Fields
Name Type Description
cursor String! A cursor for use in pagination.
node JiraImport The item at the end of the edge.

JiraProjectConnection

The connection type for JiraProject.

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

JiraProjectEdge

The edge type for JiraProject.

Fields
Name Type Description
cursor String! A cursor for use in pagination.
node JiraProject The item at the end of the edge.

JobArtifactRegistryConnection

The connection type for JobArtifactRegistry.

Fields
Name Type Description
edges [JobArtifactRegistryEdge] A list of edges.
nodes [JobArtifactRegistry] A list of nodes.
pageInfo PageInfo! Information to aid in pagination.
Fields with arguments
JobArtifactRegistryConnection.count

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

Returns Int!.

# Arguments
Name Type Description
limit Int Limit value to be applied to the count query. Default is 1000.

JobArtifactRegistryEdge

The edge type for JobArtifactRegistry.

Fields
Name Type Description
cursor String! A cursor for use in pagination.
node JobArtifactRegistry The item at the end of the edge.

JobNeedUnionConnection

The connection type for JobNeedUnion.

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

JobNeedUnionEdge

The edge type for JobNeedUnion.

Fields
Name Type Description
cursor String! A cursor for use in pagination.
node JobNeedUnion The item at the end of the edge.

LabelConnection

The connection type for Label.

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

LabelEdge

The edge type for Label.

Fields
Name Type Description
cursor String! A cursor for use in pagination.
node Label The item at the end of the edge.

LdapAdminRoleLinkConnection

The connection type for LdapAdminRoleLink.

Fields
Name Type Description
edges [LdapAdminRoleLinkEdge] A list of edges.
nodes [LdapAdminRoleLink] A list of nodes.
pageInfo PageInfo! Information to aid in pagination.

LdapAdminRoleLinkEdge

The edge type for LdapAdminRoleLink.

Fields
Name Type Description
cursor String! A cursor for use in pagination.
node LdapAdminRoleLink The item at the end of the edge.

LfsObjectRegistryConnection

The connection type for LfsObjectRegistry.

Fields
Name Type Description
edges [LfsObjectRegistryEdge] A list of edges.
nodes [LfsObjectRegistry] A list of nodes.
pageInfo PageInfo! Information to aid in pagination.
Fields with arguments
LfsObjectRegistryConnection.count

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

Returns Int!.

# Arguments
Name Type Description
limit Int Limit value to be applied to the count query. Default is 1000.

LfsObjectRegistryEdge

The edge type for LfsObjectRegistry.

Fields
Name Type Description
cursor String! A cursor for use in pagination.
node LfsObjectRegistry The item at the end of the edge.

LicenseHistoryEntryConnection

The connection type for LicenseHistoryEntry.

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

LicenseHistoryEntryEdge

The edge type for LicenseHistoryEntry.

Fields
Name Type Description
cursor String! A cursor for use in pagination.
node LicenseHistoryEntry The item at the end of the edge.

LinkedWorkItemTypeConnection

The connection type for LinkedWorkItemType.

Fields
Name Type Description
edges [LinkedWorkItemTypeEdge] A list of edges.
nodes [LinkedWorkItemType] A list of nodes.
pageInfo PageInfo! Information to aid in pagination.

LinkedWorkItemTypeEdge

The edge type for LinkedWorkItemType.

Fields
Name Type Description
cursor String! A cursor for use in pagination.
node LinkedWorkItemType The item at the end of the edge.

MemberApprovalConnection

The connection type for MemberApproval.

Fields
Name Type Description
count Int! Total count of collection.
edges [MemberApprovalEdge] A list of edges.
nodes [MemberApproval] A list of nodes.
pageInfo PageInfo! Information to aid in pagination.

MemberApprovalEdge

The edge type for MemberApproval.

Fields
Name Type Description
cursor String! A cursor for use in pagination.
node MemberApproval The item at the end of the edge.

MemberInterfaceConnection

The connection type for MemberInterface.

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

MemberInterfaceEdge

The edge type for MemberInterface.

Fields
Name Type Description
cursor String! A cursor for use in pagination.
node MemberInterface The item at the end of the edge.

MemberRoleConnection

The connection type for MemberRole.

Fields
Name Type Description
edges [MemberRoleEdge] A list of edges.
nodes [MemberRole] A list of nodes.
pageInfo PageInfo! Information to aid in pagination.

MemberRoleEdge

The edge type for MemberRole.

Fields
Name Type Description
cursor String! A cursor for use in pagination.
node MemberRole The item at the end of the edge.

MergeAccessLevelConnection

The connection type for MergeAccessLevel.

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

MergeAccessLevelEdge

The edge type for MergeAccessLevel.

Fields
Name Type Description
cursor String! A cursor for use in pagination.
node MergeAccessLevel The item at the end of the edge.

MergeRequestAssigneeConnection

The connection type for MergeRequestAssignee.

Fields
Name Type Description
count Int! Total count of collection.
edges [MergeRequestAssigneeEdge] A list of edges.
nodes [MergeRequestAssignee] A list of nodes.
pageInfo PageInfo! Information to aid in pagination.

MergeRequestAssigneeEdge

The edge type for MergeRequestAssignee.

Fields
Name Type Description
cursor String! A cursor for use in pagination.
node MergeRequestAssignee The item at the end of the edge.

MergeRequestConnection

The connection type for MergeRequest.

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

MergeRequestDiffConnection

The connection type for MergeRequestDiff.

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

MergeRequestDiffEdge

The edge type for MergeRequestDiff.

Fields
Name Type Description
cursor String! A cursor for use in pagination.
node MergeRequestDiff The item at the end of the edge.

MergeRequestDiffRegistryConnection

The connection type for MergeRequestDiffRegistry.

Fields
Name Type Description
edges [MergeRequestDiffRegistryEdge] A list of edges.
nodes [MergeRequestDiffRegistry] A list of nodes.
pageInfo PageInfo! Information to aid in pagination.
Fields with arguments
MergeRequestDiffRegistryConnection.count

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

Returns Int!.

# Arguments
Name Type Description
limit Int Limit value to be applied to the count query. Default is 1000.

MergeRequestDiffRegistryEdge

The edge type for MergeRequestDiffRegistry.

Fields
Name Type Description
cursor String! A cursor for use in pagination.
node MergeRequestDiffRegistry The item at the end of the edge.

MergeRequestEdge

The edge type for MergeRequest.

Fields
Name Type Description
cursor String! A cursor for use in pagination.
node MergeRequest The item at the end of the edge.

MergeRequestParticipantConnection

The connection type for MergeRequestParticipant.

Fields
Name Type Description
count Int! Total count of collection.
edges [MergeRequestParticipantEdge] A list of edges.
nodes [MergeRequestParticipant] A list of nodes.
pageInfo PageInfo! Information to aid in pagination.

MergeRequestParticipantEdge

The edge type for MergeRequestParticipant.

Fields
Name Type Description
cursor String! A cursor for use in pagination.
node MergeRequestParticipant The item at the end of the edge.

MergeRequestReviewerConnection

The connection type for MergeRequestReviewer.

Fields
Name Type Description
count Int! Total count of collection.
edges [MergeRequestReviewerEdge] A list of edges.
nodes [MergeRequestReviewer] A list of nodes.
pageInfo PageInfo! Information to aid in pagination.

MergeRequestReviewerEdge

The edge type for MergeRequestReviewer.

Fields
Name Type Description
cursor String! A cursor for use in pagination.
node MergeRequestReviewer The item at the end of the edge.

MergeTrainCarConnection

The connection type for MergeTrainCar.

Fields
Name Type Description
count Int! Total count of collection.
edges [MergeTrainCarEdge] A list of edges.
nodes [MergeTrainCar] A list of nodes.
pageInfo PageInfo! Information to aid in pagination.

MergeTrainCarEdge

The edge type for MergeTrainCar.

Fields
Name Type Description
cursor String! A cursor for use in pagination.
node MergeTrainCar The item at the end of the edge.

MergeTrainConnection

The connection type for MergeTrain.

Fields
Name Type Description
count Int! Total count of collection.
edges [MergeTrainEdge] A list of edges.
nodes [MergeTrain] A list of nodes.
pageInfo PageInfo! Information to aid in pagination.

MergeTrainEdge

The edge type for MergeTrain.

Fields
Name Type Description
cursor String! A cursor for use in pagination.
node MergeTrain The item at the end of the edge.

MilestoneConnection

The connection type for Milestone.

Fields
Name Type Description
edges [MilestoneEdge] A list of edges.
nodes [Milestone] A list of nodes.
pageInfo PageInfo! Information to aid in pagination.

MilestoneEdge

The edge type for Milestone.

Fields
Name Type Description
cursor String! A cursor for use in pagination.
node Milestone The item at the end of the edge.

MlCandidateConnection

The connection type for MlCandidate.

Fields
Name Type Description
edges [MlCandidateEdge] A list of edges.
nodes [MlCandidate] A list of nodes.
pageInfo PageInfo! Information to aid in pagination.
Fields with arguments
MlCandidateConnection.count

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

Returns Int!.

# Arguments
Name Type Description
limit Int Limit value to be applied to the count query. Default is 1000.

MlCandidateEdge

The edge type for MlCandidate.

Fields
Name Type Description
cursor String! A cursor for use in pagination.
node MlCandidate The item at the end of the edge.

MlCandidateMetadataConnection

The connection type for MlCandidateMetadata.

Fields
Name Type Description
edges [MlCandidateMetadataEdge] A list of edges.
nodes [MlCandidateMetadata] A list of nodes.
pageInfo PageInfo! 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
Name Type Description
limit Int Limit value to be applied to the count query. Default is 1000.

MlCandidateMetadataEdge

The edge type for MlCandidateMetadata.

Fields
Name Type Description
cursor String! A cursor for use in pagination.
node MlCandidateMetadata The item at the end of the edge.

MlCandidateMetricConnection

The connection type for MlCandidateMetric.

Fields
Name Type Description
edges [MlCandidateMetricEdge] A list of edges.
nodes [MlCandidateMetric] A list of nodes.
pageInfo PageInfo! 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
Name Type Description
limit Int Limit value to be applied to the count query. Default is 1000.

MlCandidateMetricEdge

The edge type for MlCandidateMetric.

Fields
Name Type Description
cursor String! A cursor for use in pagination.
node MlCandidateMetric The item at the end of the edge.

MlCandidateParamConnection

The connection type for MlCandidateParam.

Fields
Name Type Description
edges [MlCandidateParamEdge] A list of edges.
nodes [MlCandidateParam] A list of nodes.
pageInfo PageInfo! 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
Name Type Description
limit Int Limit value to be applied to the count query. Default is 1000.

MlCandidateParamEdge

The edge type for MlCandidateParam.

Fields
Name Type Description
cursor String! A cursor for use in pagination.
node MlCandidateParam The item at the end of the edge.

MlExperimentConnection

The connection type for MlExperiment.

Fields
Name Type Description
edges [MlExperimentEdge] A list of edges.
nodes [MlExperiment] A list of nodes.
pageInfo PageInfo! 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
Name Type Description
limit Int Limit value to be applied to the count query. Default is 1000.

MlExperimentEdge

The edge type for MlExperiment.

Fields
Name Type Description
cursor String! A cursor for use in pagination.
node MlExperiment The item at the end of the edge.

MlModelConnection

The connection type for MlModel.

Fields
Name Type Description
edges [MlModelEdge] A list of edges.
nodes [MlModel] A list of nodes.
pageInfo PageInfo! 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
Name Type Description
limit Int Limit value to be applied to the count query. Default is 1000.

MlModelEdge

The edge type for MlModel.

Fields
Name Type Description
cursor String! A cursor for use in pagination.
node MlModel The item at the end of the edge.

MlModelVersionConnection

The connection type for MlModelVersion.

Fields
Name Type Description
edges [MlModelVersionEdge] A list of edges.
nodes [MlModelVersion] A list of nodes.
pageInfo PageInfo! Information to aid in pagination.
Fields with arguments
MlModelVersionConnection.count

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

Returns Int!.

# Arguments
Name Type Description
limit Int Limit value to be applied to the count query. Default is 1000.

MlModelVersionEdge

The edge type for MlModelVersion.

Fields
Name Type Description
cursor String! A cursor for use in pagination.
node MlModelVersion The item at the end of the edge.

NamespaceCommitEmailConnection

The connection type for NamespaceCommitEmail.

Fields
Name Type Description
edges [NamespaceCommitEmailEdge] A list of edges.
nodes [NamespaceCommitEmail] A list of nodes.
pageInfo PageInfo! Information to aid in pagination.

NamespaceCommitEmailEdge

The edge type for NamespaceCommitEmail.

Fields
Name Type Description
cursor String! A cursor for use in pagination.
node NamespaceCommitEmail The item at the end of the edge.

NamespaceConnection

The connection type for Namespace.

Fields
Name Type Description
edges [NamespaceEdge] A list of edges.
nodes [Namespace] A list of nodes.
pageInfo PageInfo! Information to aid in pagination.

NamespaceEdge

The edge type for Namespace.

Fields
Name Type Description
cursor String! A cursor for use in pagination.
node Namespace The item at the end of the edge.

NestedEnvironmentConnection

The connection type for NestedEnvironment.

Fields
Name Type Description
edges [NestedEnvironmentEdge] A list of edges.
nodes [NestedEnvironment] A list of nodes.
pageInfo PageInfo! Information to aid in pagination.

NestedEnvironmentEdge

The edge type for NestedEnvironment.

Fields
Name Type Description
cursor String! A cursor for use in pagination.
node NestedEnvironment The item at the end of the edge.

NoteConnection

The connection type for Note.

Fields
Name Type Description
count Int! Total count of collection.
edges [NoteEdge] A list of edges.
nodes [Note] A list of nodes.
pageInfo PageInfo! Information to aid in pagination.

NoteEdge

The edge type for Note.

Fields
Name Type Description
cursor String! A cursor for use in pagination.
node Note The item at the end of the edge.

ObservabilityLogConnection

The connection type for ObservabilityLog.

Fields
Name Type Description
count Int! Total count of collection.
edges [ObservabilityLogEdge] A list of edges.
nodes [ObservabilityLog] A list of nodes.
pageInfo PageInfo! Information to aid in pagination.

ObservabilityLogEdge

The edge type for ObservabilityLog.

Fields
Name Type Description
cursor String! A cursor for use in pagination.
node ObservabilityLog The item at the end of the edge.

ObservabilityMetricConnection

The connection type for ObservabilityMetric.

Fields
Name Type Description
count Int! Total count of collection.
edges [ObservabilityMetricEdge] A list of edges.
nodes [ObservabilityMetric] A list of nodes.
pageInfo PageInfo! Information to aid in pagination.

ObservabilityMetricEdge

The edge type for ObservabilityMetric.

Fields
Name Type Description
cursor String! A cursor for use in pagination.
node ObservabilityMetric The item at the end of the edge.

ObservabilityTraceConnection

The connection type for ObservabilityTrace.

Fields
Name Type Description
count Int! Total count of collection.
edges [ObservabilityTraceEdge] A list of edges.
nodes [ObservabilityTrace] A list of nodes.
pageInfo PageInfo! Information to aid in pagination.

ObservabilityTraceEdge

The edge type for ObservabilityTrace.

Fields
Name Type Description
cursor String! A cursor for use in pagination.
node ObservabilityTrace The item at the end of the edge.

OncallParticipantTypeConnection

The connection type for OncallParticipantType.

Fields
Name Type Description
edges [OncallParticipantTypeEdge] A list of edges.
nodes [OncallParticipantType] A list of nodes.
pageInfo PageInfo! Information to aid in pagination.

OncallParticipantTypeEdge

The edge type for OncallParticipantType.

Fields
Name Type Description
cursor String! A cursor for use in pagination.
node OncallParticipantType The item at the end of the edge.

OrganizationConnection

The connection type for Organization.

Fields
Name Type Description
count Int! Total count of collection.
edges [OrganizationEdge] A list of edges.
nodes [Organization] A list of nodes.
pageInfo PageInfo! Information to aid in pagination.

OrganizationEdge

The edge type for Organization.

Fields
Name Type Description
cursor String! A cursor for use in pagination.
node Organization The item at the end of the edge.

OrganizationUserConnection

The connection type for OrganizationUser.

Fields
Name Type Description
edges [OrganizationUserEdge] A list of edges.
nodes [OrganizationUser] A list of nodes.
pageInfo PageInfo! Information to aid in pagination.

OrganizationUserEdge

The edge type for OrganizationUser.

Fields
Name Type Description
cursor String! A cursor for use in pagination.
node OrganizationUser The item at the end of the edge.

PackageBaseConnection

The connection type for PackageBase.

Fields
Name Type Description
count Int! Total count of collection.
edges [PackageBaseEdge] A list of edges.
nodes [PackageBase] A list of nodes.
pageInfo PageInfo! Information to aid in pagination.

PackageBaseEdge

The edge type for PackageBase.

Fields
Name Type Description
cursor String! A cursor for use in pagination.
node PackageBase The item at the end of the edge.

PackageConnection

The connection type for Package.

Fields
Name Type Description
count Int! Total count of collection.
edges [PackageEdge] A list of edges.
nodes [Package] A list of nodes.
pageInfo PageInfo! Information to aid in pagination.

PackageDependencyLinkConnection

The connection type for PackageDependencyLink.

Fields
Name Type Description
edges [PackageDependencyLinkEdge] A list of edges.
nodes [PackageDependencyLink] A list of nodes.
pageInfo PageInfo! Information to aid in pagination.

PackageDependencyLinkEdge

The edge type for PackageDependencyLink.

Fields
Name Type Description
cursor String! A cursor for use in pagination.
node PackageDependencyLink The item at the end of the edge.

PackageEdge

The edge type for Package.

Fields
Name Type Description
cursor String! A cursor for use in pagination.
node Package The item at the end of the edge.

PackageFileConnection

The connection type for PackageFile.

Fields
Name Type Description
edges [PackageFileEdge] A list of edges.
nodes [PackageFile] A list of nodes.
pageInfo PageInfo! Information to aid in pagination.

PackageFileEdge

The edge type for PackageFile.

Fields
Name Type Description
cursor String! A cursor for use in pagination.
node PackageFile The item at the end of the edge.

PackageFileRegistryConnection

The connection type for PackageFileRegistry.

Fields
Name Type Description
edges [PackageFileRegistryEdge] A list of edges.
nodes [PackageFileRegistry] A list of nodes.
pageInfo PageInfo! Information to aid in pagination.
Fields with arguments
PackageFileRegistryConnection.count

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

Returns Int!.

# Arguments
Name Type Description
limit Int Limit value to be applied to the count query. Default is 1000.

PackageFileRegistryEdge

The edge type for PackageFileRegistry.

Fields
Name Type Description
cursor String! A cursor for use in pagination.
node PackageFileRegistry The item at the end of the edge.

PackageTagConnection

The connection type for PackageTag.

Fields
Name Type Description
edges [PackageTagEdge] A list of edges.
nodes [PackageTag] A list of nodes.
pageInfo PageInfo! Information to aid in pagination.

PackageTagEdge

The edge type for PackageTag.

Fields
Name Type Description
cursor String! A cursor for use in pagination.
node PackageTag The item at the end of the edge.

PackagesProtectionRuleConnection

The connection type for PackagesProtectionRule.

Fields
Name Type Description
edges [PackagesProtectionRuleEdge] A list of edges.
nodes [PackagesProtectionRule] A list of nodes.
pageInfo PageInfo! Information to aid in pagination.

PackagesProtectionRuleEdge

The edge type for PackagesProtectionRule.

Fields
Name Type Description
cursor String! A cursor for use in pagination.
node PackagesProtectionRule The item at the end of the edge.

PagesDeploymentConnection

The connection type for PagesDeployment.

Fields
Name Type Description
count Int! Total count of collection.
edges [PagesDeploymentEdge] A list of edges.
nodes [PagesDeployment] A list of nodes.
pageInfo PageInfo! Information to aid in pagination.

PagesDeploymentEdge

The edge type for PagesDeployment.

Fields
Name Type Description
cursor String! A cursor for use in pagination.
node PagesDeployment The item at the end of the edge.

PagesDeploymentRegistryConnection

The connection type for PagesDeploymentRegistry.

Fields
Name Type Description
edges [PagesDeploymentRegistryEdge] A list of edges.
nodes [PagesDeploymentRegistry] A list of nodes.
pageInfo PageInfo! Information to aid in pagination.
Fields with arguments
PagesDeploymentRegistryConnection.count

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

Returns Int!.

# Arguments
Name Type Description
limit Int Limit value to be applied to the count query. Default is 1000.

PagesDeploymentRegistryEdge

The edge type for PagesDeploymentRegistry.

Fields
Name Type Description
cursor String! A cursor for use in pagination.
node PagesDeploymentRegistry The item at the end of the edge.

PathLockConnection

The connection type for PathLock.

Fields
Name Type Description
edges [PathLockEdge] A list of edges.
nodes [PathLock] A list of nodes.
pageInfo PageInfo! Information to aid in pagination.

PathLockEdge

The edge type for PathLock.

Fields
Name Type Description
cursor String! A cursor for use in pagination.
node PathLock The item at the end of the edge.

PendingMemberInterfaceConnection

The connection type for PendingMemberInterface.

Fields
Name Type Description
edges [PendingMemberInterfaceEdge] A list of edges.
nodes [PendingMemberInterface] A list of nodes.
pageInfo PageInfo! Information to aid in pagination.

PendingMemberInterfaceEdge

The edge type for PendingMemberInterface.

Fields
Name Type Description
cursor String! A cursor for use in pagination.
node PendingMemberInterface The item at the end of the edge.

PipelineArtifactRegistryConnection

The connection type for PipelineArtifactRegistry.

Fields
Name Type Description
edges [PipelineArtifactRegistryEdge] A list of edges.
nodes [PipelineArtifactRegistry] A list of nodes.
pageInfo PageInfo! Information to aid in pagination.
Fields with arguments
PipelineArtifactRegistryConnection.count

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

Returns Int!.

# Arguments
Name Type Description
limit Int Limit value to be applied to the count query. Default is 1000.

PipelineArtifactRegistryEdge

The edge type for PipelineArtifactRegistry.

Fields
Name Type Description
cursor String! A cursor for use in pagination.
node PipelineArtifactRegistry The item at the end of the edge.

PipelineConnection

The connection type for Pipeline.

Fields
Name Type Description
count Int! Total count of collection.
edges [PipelineEdge] A list of edges.
nodes [Pipeline] A list of nodes.
pageInfo PageInfo! Information to aid in pagination.

PipelineEdge

The edge type for Pipeline.

Fields
Name Type Description
cursor String! A cursor for use in pagination.
node Pipeline The item at the end of the edge.

PipelineExecutionPolicyConnection

The connection type for PipelineExecutionPolicy.

Fields
Name Type Description
edges [PipelineExecutionPolicyEdge] A list of edges.
nodes [PipelineExecutionPolicy] A list of nodes.
pageInfo PageInfo! Information to aid in pagination.

PipelineExecutionPolicyEdge

The edge type for PipelineExecutionPolicy.

Fields
Name Type Description
cursor String! A cursor for use in pagination.
node PipelineExecutionPolicy The item at the end of the edge.

PipelineExecutionSchedulePolicyConnection

The connection type for PipelineExecutionSchedulePolicy.

Fields
Name Type Description
edges [PipelineExecutionSchedulePolicyEdge] A list of edges.
nodes [PipelineExecutionSchedulePolicy] A list of nodes.
pageInfo PageInfo! Information to aid in pagination.

PipelineExecutionSchedulePolicyEdge

The edge type for PipelineExecutionSchedulePolicy.

Fields
Name Type Description
cursor String! A cursor for use in pagination.
node PipelineExecutionSchedulePolicy The item at the end of the edge.

PipelineManualVariableConnection

The connection type for PipelineManualVariable.

Fields
Name Type Description
edges [PipelineManualVariableEdge] A list of edges.
nodes [PipelineManualVariable] A list of nodes.
pageInfo PageInfo! Information to aid in pagination.

PipelineManualVariableEdge

The edge type for PipelineManualVariable.

Fields
Name Type Description
cursor String! A cursor for use in pagination.
node PipelineManualVariable The item at the end of the edge.

PipelineMessageConnection

The connection type for PipelineMessage.

Fields
Name Type Description
edges [PipelineMessageEdge] A list of edges.
nodes [PipelineMessage] A list of nodes.
pageInfo PageInfo! Information to aid in pagination.

PipelineMessageEdge

The edge type for PipelineMessage.

Fields
Name Type Description
cursor String! A cursor for use in pagination.
node PipelineMessage The item at the end of the edge.

PipelineScheduleConnection

The connection type for PipelineSchedule.

Fields
Name Type Description
count Int! Total count of collection.
edges [PipelineScheduleEdge] A list of edges.
nodes [PipelineSchedule] A list of nodes.
pageInfo PageInfo! Information to aid in pagination.

PipelineScheduleEdge

The edge type for PipelineSchedule.

Fields
Name Type Description
cursor String! A cursor for use in pagination.
node PipelineSchedule The item at the end of the edge.

PipelineScheduleVariableConnection

The connection type for PipelineScheduleVariable.

Fields
Name Type Description
edges [PipelineScheduleVariableEdge] A list of edges.
nodes [PipelineScheduleVariable] A list of nodes.
pageInfo PageInfo! Information to aid in pagination.

PipelineScheduleVariableEdge

The edge type for PipelineScheduleVariable.

Fields
Name Type Description
cursor String! A cursor for use in pagination.
node PipelineScheduleVariable The item at the end of the edge.

PipelineSecurityReportFindingConnection

The connection type for PipelineSecurityReportFinding.

Fields
Name Type Description
edges [PipelineSecurityReportFindingEdge] A list of edges.
nodes [PipelineSecurityReportFinding] A list of nodes.
pageInfo PageInfo! Information to aid in pagination.

PipelineSecurityReportFindingEdge

The edge type for PipelineSecurityReportFinding.

Fields
Name Type Description
cursor String! A cursor for use in pagination.
node PipelineSecurityReportFinding The item at the end of the edge.

PipelineTriggerConnection

The connection type for PipelineTrigger.

Fields
Name Type Description
count Int! Total count of collection.
edges [PipelineTriggerEdge] A list of edges.
nodes [PipelineTrigger] A list of nodes.
pageInfo PageInfo! Information to aid in pagination.

PipelineTriggerEdge

The edge type for PipelineTrigger.

Fields
Name Type Description
cursor String! A cursor for use in pagination.
node PipelineTrigger The item at the end of the edge.

ProjectComplianceControlStatusTypeConnection

The connection type for ProjectComplianceControlStatusType.

Fields
Name Type Description
edges [ProjectComplianceControlStatusTypeEdge] A list of edges.
nodes [ProjectComplianceControlStatusType] A list of nodes.
pageInfo PageInfo! Information to aid in pagination.

ProjectComplianceControlStatusTypeEdge

The edge type for ProjectComplianceControlStatusType.

Fields
Name Type Description
cursor String! A cursor for use in pagination.
node ProjectComplianceControlStatusType The item at the end of the edge.

ProjectComplianceRequirementStatusConnection

The connection type for ProjectComplianceRequirementStatus.

Fields
Name Type Description
edges [ProjectComplianceRequirementStatusEdge] A list of edges.
nodes [ProjectComplianceRequirementStatus] A list of nodes.
pageInfo PageInfo! Information to aid in pagination.

ProjectComplianceRequirementStatusEdge

The edge type for ProjectComplianceRequirementStatus.

Fields
Name Type Description
cursor String! A cursor for use in pagination.
node ProjectComplianceRequirementStatus The item at the end of the edge.

ProjectConnection

The connection type for Project.

Fields
Name Type Description
count Int! Total count of collection.
edges [ProjectEdge] A list of edges.
nodes [Project] A list of nodes.
pageInfo PageInfo! Information to aid in pagination.

ProjectEdge

The edge type for Project.

Fields
Name Type Description
cursor String! A cursor for use in pagination.
node Project The item at the end of the edge.

ProjectMemberConnection

The connection type for ProjectMember.

Fields
Name Type Description
edges [ProjectMemberEdge] A list of edges.
nodes [ProjectMember] A list of nodes.
pageInfo PageInfo! Information to aid in pagination.

ProjectMemberEdge

The edge type for ProjectMember.

Fields
Name Type Description
cursor String! A cursor for use in pagination.
node ProjectMember The item at the end of the edge.

ProjectRepositoryRegistryConnection

The connection type for ProjectRepositoryRegistry.

Fields
Name Type Description
edges [ProjectRepositoryRegistryEdge] A list of edges.
nodes [ProjectRepositoryRegistry] A list of nodes.
pageInfo PageInfo! Information to aid in pagination.
Fields with arguments
ProjectRepositoryRegistryConnection.count

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

Returns Int!.

# Arguments
Name Type Description
limit Int Limit value to be applied to the count query. Default is 1000.

ProjectRepositoryRegistryEdge

The edge type for ProjectRepositoryRegistry.

Fields
Name Type Description
cursor String! A cursor for use in pagination.
node ProjectRepositoryRegistry The item at the end of the edge.

ProjectSavedReplyConnection

The connection type for ProjectSavedReply.

Fields
Name Type Description
count Int! Total count of collection.
edges [ProjectSavedReplyEdge] A list of edges.
nodes [ProjectSavedReply] A list of nodes.
pageInfo PageInfo! Information to aid in pagination.

ProjectSavedReplyEdge

The edge type for ProjectSavedReply.

Fields
Name Type Description
cursor String! A cursor for use in pagination.
node ProjectSavedReply The item at the end of the edge.

ProjectSecretConnection

The connection type for ProjectSecret.

Fields
Name Type Description
edges [ProjectSecretEdge] A list of edges.
nodes [ProjectSecret] A list of nodes.
pageInfo PageInfo! Information to aid in pagination.

ProjectSecretEdge

The edge type for ProjectSecret.

Fields
Name Type Description
cursor String! A cursor for use in pagination.
node ProjectSecret The item at the end of the edge.

ProjectSecurityExclusionConnection

The connection type for ProjectSecurityExclusion.

Fields
Name Type Description
edges [ProjectSecurityExclusionEdge] A list of edges.
nodes [ProjectSecurityExclusion] A list of nodes.
pageInfo PageInfo! Information to aid in pagination.

ProjectSecurityExclusionEdge

The edge type for ProjectSecurityExclusion.

Fields
Name Type Description
cursor String! A cursor for use in pagination.
node ProjectSecurityExclusion The item at the end of the edge.

ProjectTargetBranchRuleConnection

The connection type for ProjectTargetBranchRule.

Fields
Name Type Description
count Int! Total count of collection.
edges [ProjectTargetBranchRuleEdge] A list of edges.
nodes [ProjectTargetBranchRule] A list of nodes.
pageInfo PageInfo! Information to aid in pagination.

ProjectTargetBranchRuleEdge

The edge type for ProjectTargetBranchRule.

Fields
Name Type Description
cursor String! A cursor for use in pagination.
node ProjectTargetBranchRule The item at the end of the edge.

ProjectWikiRepositoryRegistryConnection

The connection type for ProjectWikiRepositoryRegistry.

Fields
Name Type Description
edges [ProjectWikiRepositoryRegistryEdge] A list of edges.
nodes [ProjectWikiRepositoryRegistry] A list of nodes.
pageInfo PageInfo! Information to aid in pagination.
Fields with arguments
ProjectWikiRepositoryRegistryConnection.count

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

Returns Int!.

# Arguments
Name Type Description
limit Int Limit value to be applied to the count query. Default is 1000.

ProjectWikiRepositoryRegistryEdge

The edge type for ProjectWikiRepositoryRegistry.

Fields
Name Type Description
cursor String! A cursor for use in pagination.
node ProjectWikiRepositoryRegistry The item at the end of the edge.

ProtectedEnvironmentApprovalRuleConnection

The connection type for ProtectedEnvironmentApprovalRule.

Fields
Name Type Description
edges [ProtectedEnvironmentApprovalRuleEdge] A list of edges.
nodes [ProtectedEnvironmentApprovalRule] A list of nodes.
pageInfo PageInfo! Information to aid in pagination.

ProtectedEnvironmentApprovalRuleEdge

The edge type for ProtectedEnvironmentApprovalRule.

Fields
Name Type Description
cursor String! A cursor for use in pagination.
node ProtectedEnvironmentApprovalRule The item at the end of the edge.

ProtectedEnvironmentConnection

The connection type for ProtectedEnvironment.

Fields
Name Type Description
edges [ProtectedEnvironmentEdge] A list of edges.
nodes [ProtectedEnvironment] A list of nodes.
pageInfo PageInfo! Information to aid in pagination.

ProtectedEnvironmentDeployAccessLevelConnection

The connection type for ProtectedEnvironmentDeployAccessLevel.

Fields
Name Type Description
edges [ProtectedEnvironmentDeployAccessLevelEdge] A list of edges.
nodes [ProtectedEnvironmentDeployAccessLevel] A list of nodes.
pageInfo PageInfo! Information to aid in pagination.

ProtectedEnvironmentDeployAccessLevelEdge

The edge type for ProtectedEnvironmentDeployAccessLevel.

Fields
Name Type Description
cursor String! A cursor for use in pagination.
node ProtectedEnvironmentDeployAccessLevel The item at the end of the edge.

ProtectedEnvironmentEdge

The edge type for ProtectedEnvironment.

Fields
Name Type Description
cursor String! A cursor for use in pagination.
node ProtectedEnvironment The item at the end of the edge.

PushAccessLevelConnection

The connection type for PushAccessLevel.

Fields
Name Type Description
edges [PushAccessLevelEdge] A list of edges.
nodes [PushAccessLevel] A list of nodes.
pageInfo PageInfo! Information to aid in pagination.

PushAccessLevelEdge

The edge type for PushAccessLevel.

Fields
Name Type Description
cursor String! A cursor for use in pagination.
node PushAccessLevel The item at the end of the edge.

ReleaseAssetLinkConnection

The connection type for ReleaseAssetLink.

Fields
Name Type Description
edges [ReleaseAssetLinkEdge] A list of edges.
nodes [ReleaseAssetLink] A list of nodes.
pageInfo PageInfo! Information to aid in pagination.

ReleaseAssetLinkEdge

The edge type for ReleaseAssetLink.

Fields
Name Type Description
cursor String! A cursor for use in pagination.
node ReleaseAssetLink The item at the end of the edge.

ReleaseConnection

The connection type for Release.

Fields
Name Type Description
count Int! Total count of collection.
edges [ReleaseEdge] A list of edges.
nodes [Release] A list of nodes.
pageInfo PageInfo! Information to aid in pagination.

ReleaseEdge

The edge type for Release.

Fields
Name Type Description
cursor String! A cursor for use in pagination.
node Release The item at the end of the edge.

ReleaseEvidenceConnection

The connection type for ReleaseEvidence.

Fields
Name Type Description
edges [ReleaseEvidenceEdge] A list of edges.
nodes [ReleaseEvidence] A list of nodes.
pageInfo PageInfo! Information to aid in pagination.

ReleaseEvidenceEdge

The edge type for ReleaseEvidence.

Fields
Name Type Description
cursor String! A cursor for use in pagination.
node ReleaseEvidence The item at the end of the edge.

ReleaseSourceConnection

The connection type for ReleaseSource.

Fields
Name Type Description
edges [ReleaseSourceEdge] A list of edges.
nodes [ReleaseSource] A list of nodes.
pageInfo PageInfo! Information to aid in pagination.

ReleaseSourceEdge

The edge type for ReleaseSource.

Fields
Name Type Description
cursor String! A cursor for use in pagination.
node ReleaseSource The item at the end of the edge.

RepositoryBlobConnection

The connection type for RepositoryBlob.

Fields
Name Type Description
edges [RepositoryBlobEdge] A list of edges.
nodes [RepositoryBlob] A list of nodes.
pageInfo PageInfo! Information to aid in pagination.

RepositoryBlobEdge

The edge type for RepositoryBlob.

Fields
Name Type Description
cursor String! A cursor for use in pagination.
node RepositoryBlob The item at the end of the edge.

RequirementConnection

The connection type for Requirement.

Fields
Name Type Description
edges [RequirementEdge] A list of edges.
nodes [Requirement] A list of nodes.
pageInfo PageInfo! Information to aid in pagination.

RequirementEdge

The edge type for Requirement.

Fields
Name Type Description
cursor String! A cursor for use in pagination.
node Requirement The item at the end of the edge.

RunnerArchitectureConnection

The connection type for RunnerArchitecture.

Fields
Name Type Description
edges [RunnerArchitectureEdge] A list of edges.
nodes [RunnerArchitecture] A list of nodes.
pageInfo PageInfo! Information to aid in pagination.

RunnerArchitectureEdge

The edge type for RunnerArchitecture.

Fields
Name Type Description
cursor String! A cursor for use in pagination.
node RunnerArchitecture The item at the end of the edge.

RunnerPlatformConnection

The connection type for RunnerPlatform.

Fields
Name Type Description
edges [RunnerPlatformEdge] A list of edges.
nodes [RunnerPlatform] A list of nodes.
pageInfo PageInfo! Information to aid in pagination.

RunnerPlatformEdge

The edge type for RunnerPlatform.

Fields
Name Type Description
cursor String! A cursor for use in pagination.
node RunnerPlatform The item at the end of the edge.

SastCiConfigurationAnalyzersEntityConnection

The connection type for SastCiConfigurationAnalyzersEntity.

Fields
Name Type Description
edges [SastCiConfigurationAnalyzersEntityEdge] A list of edges.
nodes [SastCiConfigurationAnalyzersEntity] A list of nodes.
pageInfo PageInfo! Information to aid in pagination.

SastCiConfigurationAnalyzersEntityEdge

The edge type for SastCiConfigurationAnalyzersEntity.

Fields
Name Type Description
cursor String! A cursor for use in pagination.
node SastCiConfigurationAnalyzersEntity The item at the end of the edge.

SastCiConfigurationEntityConnection

The connection type for SastCiConfigurationEntity.

Fields
Name Type Description
edges [SastCiConfigurationEntityEdge] A list of edges.
nodes [SastCiConfigurationEntity] A list of nodes.
pageInfo PageInfo! Information to aid in pagination.

SastCiConfigurationEntityEdge

The edge type for SastCiConfigurationEntity.

Fields
Name Type Description
cursor String! A cursor for use in pagination.
node SastCiConfigurationEntity The item at the end of the edge.

SastCiConfigurationOptionsEntityConnection

The connection type for SastCiConfigurationOptionsEntity.

Fields
Name Type Description
edges [SastCiConfigurationOptionsEntityEdge] A list of edges.
nodes [SastCiConfigurationOptionsEntity] A list of nodes.
pageInfo PageInfo! Information to aid in pagination.

SastCiConfigurationOptionsEntityEdge

The edge type for SastCiConfigurationOptionsEntity.

Fields
Name Type Description
cursor String! A cursor for use in pagination.
node SastCiConfigurationOptionsEntity The item at the end of the edge.

SavedReplyConnection

The connection type for SavedReply.

Fields
Name Type Description
count Int! Total count of collection.
edges [SavedReplyEdge] A list of edges.
nodes [SavedReply] A list of nodes.
pageInfo PageInfo! Information to aid in pagination.

SavedReplyEdge

The edge type for SavedReply.

Fields
Name Type Description
cursor String! A cursor for use in pagination.
node SavedReply The item at the end of the edge.

ScanConnection

The connection type for Scan.

Fields
Name Type Description
edges [ScanEdge] A list of edges.
nodes [Scan] A list of nodes.
pageInfo PageInfo! Information to aid in pagination.

ScanEdge

The edge type for Scan.

Fields
Name Type Description
cursor String! A cursor for use in pagination.
node Scan The item at the end of the edge.

ScanExecutionPolicyConnection

The connection type for ScanExecutionPolicy.

Fields
Name Type Description
edges [ScanExecutionPolicyEdge] A list of edges.
nodes [ScanExecutionPolicy] A list of nodes.
pageInfo PageInfo! Information to aid in pagination.

ScanExecutionPolicyEdge

The edge type for ScanExecutionPolicy.

Fields
Name Type Description
cursor String! A cursor for use in pagination.
node ScanExecutionPolicy The item at the end of the edge.

ScanResultPolicyConnection

The connection type for ScanResultPolicy.

Fields
Name Type Description
edges [ScanResultPolicyEdge] A list of edges.
nodes [ScanResultPolicy] A list of nodes.
pageInfo PageInfo! Information to aid in pagination.

ScanResultPolicyEdge

The edge type for ScanResultPolicy.

Fields
Name Type Description
cursor String! A cursor for use in pagination.
node ScanResultPolicy The item at the end of the edge.

ScannedResourceConnection

The connection type for ScannedResource.

Fields
Name Type Description
edges [ScannedResourceEdge] A list of edges.
nodes [ScannedResource] A list of nodes.
pageInfo PageInfo! Information to aid in pagination.

ScannedResourceEdge

The edge type for ScannedResource.

Fields
Name Type Description
cursor String! A cursor for use in pagination.
node ScannedResource The item at the end of the edge.

SecretPermissionConnection

The connection type for SecretPermission.

Fields
Name Type Description
edges [SecretPermissionEdge] A list of edges.
nodes [SecretPermission] A list of nodes.
pageInfo PageInfo! Information to aid in pagination.

SecretPermissionEdge

The edge type for SecretPermission.

Fields
Name Type Description
cursor String! A cursor for use in pagination.
node SecretPermission The item at the end of the edge.

SentryErrorConnection

The connection type for SentryError.

Fields
Name Type Description
edges [SentryErrorEdge] A list of edges.
nodes [SentryError] A list of nodes.
pageInfo PageInfo! Information to aid in pagination.

SentryErrorEdge

The edge type for SentryError.

Fields
Name Type Description
cursor String! A cursor for use in pagination.
node SentryError The item at the end of the edge.

ServiceConnection

The connection type for Service.

Fields
Name Type Description
edges [ServiceEdge] A list of edges.
nodes [Service] A list of nodes.
pageInfo PageInfo! Information to aid in pagination.

ServiceEdge

The edge type for Service.

Fields
Name Type Description
cursor String! A cursor for use in pagination.
node Service The item at the end of the edge.

SeverityOverrideConnection

The connection type for SeverityOverride.

Fields
Name Type Description
edges [SeverityOverrideEdge] A list of edges.
nodes [SeverityOverride] A list of nodes.
pageInfo PageInfo! Information to aid in pagination.

SeverityOverrideEdge

The edge type for SeverityOverride.

Fields
Name Type Description
cursor String! A cursor for use in pagination.
node SeverityOverride The item at the end of the edge.

SnippetBlobConnection

The connection type for SnippetBlob.

Fields
Name Type Description
edges [SnippetBlobEdge] A list of edges.
hasUnretrievableBlobs Boolean! Indicates if the snippet has unretrievable blobs.
nodes [SnippetBlob] A list of nodes.
pageInfo PageInfo! Information to aid in pagination.

SnippetBlobEdge

The edge type for SnippetBlob.

Fields
Name Type Description
cursor String! A cursor for use in pagination.
node SnippetBlob The item at the end of the edge.

SnippetConnection

The connection type for Snippet.

Fields
Name Type Description
edges [SnippetEdge] A list of edges.
nodes [Snippet] A list of nodes.
pageInfo PageInfo! Information to aid in pagination.

SnippetEdge

The edge type for Snippet.

Fields
Name Type Description
cursor String! A cursor for use in pagination.
node Snippet The item at the end of the edge.

SnippetRepositoryRegistryConnection

The connection type for SnippetRepositoryRegistry.

Fields
Name Type Description
edges [SnippetRepositoryRegistryEdge] A list of edges.
nodes [SnippetRepositoryRegistry] A list of nodes.
pageInfo PageInfo! Information to aid in pagination.
Fields with arguments
SnippetRepositoryRegistryConnection.count

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

Returns Int!.

# Arguments
Name Type Description
limit Int Limit value to be applied to the count query. Default is 1000.

SnippetRepositoryRegistryEdge

The edge type for SnippetRepositoryRegistry.

Fields
Name Type Description
cursor String! A cursor for use in pagination.
node SnippetRepositoryRegistry The item at the end of the edge.

StandardRoleConnection

The connection type for StandardRole.

Fields
Name Type Description
edges [StandardRoleEdge] A list of edges.
nodes [StandardRole] A list of nodes.
pageInfo PageInfo! Information to aid in pagination.

StandardRoleEdge

The edge type for StandardRole.

Fields
Name Type Description
cursor String! A cursor for use in pagination.
node StandardRole The item at the end of the edge.

SubmoduleConnection

The connection type for Submodule.

Fields
Name Type Description
edges [SubmoduleEdge] A list of edges.
nodes [Submodule] A list of nodes.
pageInfo PageInfo! Information to aid in pagination.

SubmoduleEdge

The edge type for Submodule.

Fields
Name Type Description
cursor String! A cursor for use in pagination.
node Submodule The item at the end of the edge.

SubscriptionFutureEntryConnection

The connection type for SubscriptionFutureEntry.

Fields
Name Type Description
edges [SubscriptionFutureEntryEdge] A list of edges.
nodes [SubscriptionFutureEntry] A list of nodes.
pageInfo PageInfo! Information to aid in pagination.

SubscriptionFutureEntryEdge

The edge type for SubscriptionFutureEntry.

Fields
Name Type Description
cursor String! A cursor for use in pagination.
node SubscriptionFutureEntry The item at the end of the edge.

TerraformStateConnection

The connection type for TerraformState.

Fields
Name Type Description
count Int! Total count of collection.
edges [TerraformStateEdge] A list of edges.
nodes [TerraformState] A list of nodes.
pageInfo PageInfo! Information to aid in pagination.

TerraformStateEdge

The edge type for TerraformState.

Fields
Name Type Description
cursor String! A cursor for use in pagination.
node TerraformState The item at the end of the edge.

TerraformStateVersionRegistryConnection

The connection type for TerraformStateVersionRegistry.

Fields
Name Type Description
edges [TerraformStateVersionRegistryEdge] A list of edges.
nodes [TerraformStateVersionRegistry] A list of nodes.
pageInfo PageInfo! Information to aid in pagination.
Fields with arguments
TerraformStateVersionRegistryConnection.count

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

Returns Int!.

# Arguments
Name Type Description
limit Int Limit value to be applied to the count query. Default is 1000.

TerraformStateVersionRegistryEdge

The edge type for TerraformStateVersionRegistry.

Fields
Name Type Description
cursor String! A cursor for use in pagination.
node TerraformStateVersionRegistry The item at the end of the edge.

TestCaseConnection

The connection type for TestCase.

Fields
Name Type Description
count Int! Total count of collection.
edges [TestCaseEdge] A list of edges.
nodes [TestCase] A list of nodes.
pageInfo PageInfo! Information to aid in pagination.

TestCaseEdge

The edge type for TestCase.

Fields
Name Type Description
cursor String! A cursor for use in pagination.
node TestCase The item at the end of the edge.

TestReportConnection

The connection type for TestReport.

Fields
Name Type Description
edges [TestReportEdge] A list of edges.
nodes [TestReport] A list of nodes.
pageInfo PageInfo! Information to aid in pagination.

TestReportEdge

The edge type for TestReport.

Fields
Name Type Description
cursor String! A cursor for use in pagination.
node TestReport The item at the end of the edge.

TestSuiteSummaryConnection

The connection type for TestSuiteSummary.

Fields
Name Type Description
count Int! Total count of collection.
edges [TestSuiteSummaryEdge] A list of edges.
nodes [TestSuiteSummary] A list of nodes.
pageInfo PageInfo! Information to aid in pagination.

TestSuiteSummaryEdge

The edge type for TestSuiteSummary.

Fields
Name Type Description
cursor String! A cursor for use in pagination.
node TestSuiteSummary The item at the end of the edge.

TimeTrackingTimelogCategoryConnection

The connection type for TimeTrackingTimelogCategory.

Fields
Name Type Description
edges [TimeTrackingTimelogCategoryEdge] A list of edges.
nodes [TimeTrackingTimelogCategory] A list of nodes.
pageInfo PageInfo! Information to aid in pagination.

TimeTrackingTimelogCategoryEdge

The edge type for TimeTrackingTimelogCategory.

Fields
Name Type Description
cursor String! A cursor for use in pagination.
node TimeTrackingTimelogCategory The item at the end of the edge.

TimelineEventTagTypeConnection

The connection type for TimelineEventTagType.

Fields
Name Type Description
edges [TimelineEventTagTypeEdge] A list of edges.
nodes [TimelineEventTagType] A list of nodes.
pageInfo PageInfo! Information to aid in pagination.

TimelineEventTagTypeEdge

The edge type for TimelineEventTagType.

Fields
Name Type Description
cursor String! A cursor for use in pagination.
node TimelineEventTagType The item at the end of the edge.

TimelineEventTypeConnection

The connection type for TimelineEventType.

Fields
Name Type Description
edges [TimelineEventTypeEdge] A list of edges.
nodes [TimelineEventType] A list of nodes.
pageInfo PageInfo! Information to aid in pagination.

TimelineEventTypeEdge

The edge type for TimelineEventType.

Fields
Name Type Description
cursor String! A cursor for use in pagination.
node TimelineEventType The item at the end of the edge.

TimelogConnection

The connection type for Timelog.

Fields
Name Type Description
count Int! Total count of collection.
edges [TimelogEdge] A list of edges.
nodes [Timelog] A list of nodes.
pageInfo PageInfo! Information to aid in pagination.
totalSpentTime BigInt! Total time spent in seconds.

TimelogEdge

The edge type for Timelog.

Fields
Name Type Description
cursor String! A cursor for use in pagination.
node Timelog The item at the end of the edge.

TodoConnection

The connection type for Todo.

Fields
Name Type Description
count Int! Total count of collection.
edges [TodoEdge] A list of edges.
nodes [Todo] A list of nodes.
pageInfo PageInfo! Information to aid in pagination.

TodoEdge

The edge type for Todo.

Fields
Name Type Description
cursor String! A cursor for use in pagination.
node Todo The item at the end of the edge.

TopicConnection

The connection type for Topic.

Fields
Name Type Description
edges [TopicEdge] A list of edges.
nodes [Topic] A list of nodes.
pageInfo PageInfo! Information to aid in pagination.

TopicEdge

The edge type for Topic.

Fields
Name Type Description
cursor String! A cursor for use in pagination.
node Topic The item at the end of the edge.

TreeConnection

The connection type for Tree.

Fields
Name Type Description
edges [TreeEdge] A list of edges.
nodes [Tree] A list of nodes.
pageInfo PageInfo! Information to aid in pagination.

TreeEdge

The edge type for Tree.

Fields
Name Type Description
cursor String! A cursor for use in pagination.
node Tree The item at the end of the edge.

TreeEntryConnection

The connection type for TreeEntry.

Fields
Name Type Description
edges [TreeEntryEdge] A list of edges.
nodes [TreeEntry] A list of nodes.
pageInfo PageInfo! Information to aid in pagination.

TreeEntryEdge

The edge type for TreeEntry.

Fields
Name Type Description
cursor String! A cursor for use in pagination.
node TreeEntry The item at the end of the edge.

UnprotectAccessLevelConnection

The connection type for UnprotectAccessLevel.

Fields
Name Type Description
edges [UnprotectAccessLevelEdge] A list of edges.
nodes [UnprotectAccessLevel] A list of nodes.
pageInfo PageInfo! Information to aid in pagination.

UnprotectAccessLevelEdge

The edge type for UnprotectAccessLevel.

Fields
Name Type Description
cursor String! A cursor for use in pagination.
node UnprotectAccessLevel The item at the end of the edge.

UploadRegistryConnection

The connection type for UploadRegistry.

Fields
Name Type Description
edges [UploadRegistryEdge] A list of edges.
nodes [UploadRegistry] A list of nodes.
pageInfo PageInfo! Information to aid in pagination.
Fields with arguments
UploadRegistryConnection.count

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

Returns Int!.

# Arguments
Name Type Description
limit Int Limit value to be applied to the count query. Default is 1000.

UploadRegistryEdge

The edge type for UploadRegistry.

Fields
Name Type Description
cursor String! A cursor for use in pagination.
node UploadRegistry The item at the end of the edge.

UsageTrendsMeasurementConnection

The connection type for UsageTrendsMeasurement.

Fields
Name Type Description
edges [UsageTrendsMeasurementEdge] A list of edges.
nodes [UsageTrendsMeasurement] A list of nodes.
pageInfo PageInfo! Information to aid in pagination.

UsageTrendsMeasurementEdge

The edge type for UsageTrendsMeasurement.

Fields
Name Type Description
cursor String! A cursor for use in pagination.
node UsageTrendsMeasurement The item at the end of the edge.

UserAchievementConnection

The connection type for UserAchievement.

Fields
Name Type Description
count Int! Total count of collection.
edges [UserAchievementEdge] A list of edges.
nodes [UserAchievement] A list of nodes.
pageInfo PageInfo! Information to aid in pagination.

UserAchievementEdge

The edge type for UserAchievement.

Fields
Name Type Description
cursor String! A cursor for use in pagination.
node UserAchievement The item at the end of the edge.

UserAddOnAssignmentConnection

The connection type for UserAddOnAssignment.

Fields
Name Type Description
edges [UserAddOnAssignmentEdge] A list of edges.
nodes [UserAddOnAssignment] A list of nodes.
pageInfo PageInfo! Information to aid in pagination.

UserAddOnAssignmentEdge

The edge type for UserAddOnAssignment.

Fields
Name Type Description
cursor String! A cursor for use in pagination.
node UserAddOnAssignment The item at the end of the edge.

UserCalloutConnection

The connection type for UserCallout.

Fields
Name Type Description
edges [UserCalloutEdge] A list of edges.
nodes [UserCallout] A list of nodes.
pageInfo PageInfo! Information to aid in pagination.

UserCalloutEdge

The edge type for UserCallout.

Fields
Name Type Description
cursor String! A cursor for use in pagination.
node UserCallout The item at the end of the edge.

UserCoreConnection

The connection type for UserCore.

Fields
Name Type Description
count Int! Total count of collection.
edges [UserCoreEdge] A list of edges.
nodes [UserCore] A list of nodes.
pageInfo PageInfo! Information to aid in pagination.

UserCoreEdge

The edge type for UserCore.

Fields
Name Type Description
cursor String! A cursor for use in pagination.
node UserCore The item at the end of the edge.

UsersQueuedForRolePromotionConnection

The connection type for UsersQueuedForRolePromotion.

Fields
Name Type Description
count Int! Total count of collection.
edges [UsersQueuedForRolePromotionEdge] A list of edges.
nodes [UsersQueuedForRolePromotion] A list of nodes.
pageInfo PageInfo! Information to aid in pagination.

UsersQueuedForRolePromotionEdge

The edge type for UsersQueuedForRolePromotion.

Fields
Name Type Description
cursor String! A cursor for use in pagination.
node UsersQueuedForRolePromotion The item at the end of the edge.

ValueStreamConnection

The connection type for ValueStream.

Fields
Name Type Description
edges [ValueStreamEdge] A list of edges.
nodes [ValueStream] A list of nodes.
pageInfo PageInfo! Information to aid in pagination.

ValueStreamEdge

The edge type for ValueStream.

Fields
Name Type Description
cursor String! A cursor for use in pagination.
node ValueStream The item at the end of the edge.

ValueStreamStageItemsConnection

The connection type for ValueStreamStageItems.

Fields
Name Type Description
edges [ValueStreamStageItemsEdge] A list of edges.
nodes [ValueStreamStageItems] A list of nodes.
pageInfo PageInfo! Information to aid in pagination.

ValueStreamStageItemsEdge

The edge type for ValueStreamStageItems.

Fields
Name Type Description
cursor String! A cursor for use in pagination.
node ValueStreamStageItems The item at the end of the edge.

VulnerabilitiesCountByDayConnection

The connection type for VulnerabilitiesCountByDay.

Fields
Name Type Description
edges [VulnerabilitiesCountByDayEdge] A list of edges.
nodes [VulnerabilitiesCountByDay] A list of nodes.
pageInfo PageInfo! Information to aid in pagination.

VulnerabilitiesCountByDayEdge

The edge type for VulnerabilitiesCountByDay.

Fields
Name Type Description
cursor String! A cursor for use in pagination.
node VulnerabilitiesCountByDay The item at the end of the edge.

VulnerabilityConnection

The connection type for Vulnerability.

Fields
Name Type Description
edges [VulnerabilityEdge] A list of edges.
nodes [Vulnerability] A list of nodes.
pageInfo PageInfo! Information to aid in pagination.

VulnerabilityContainerImageConnection

The connection type for VulnerabilityContainerImage.

Fields
Name Type Description
edges [VulnerabilityContainerImageEdge] A list of edges.
nodes [VulnerabilityContainerImage] A list of nodes.
pageInfo PageInfo! Information to aid in pagination.

VulnerabilityContainerImageEdge

The edge type for VulnerabilityContainerImage.

Fields
Name Type Description
cursor String! A cursor for use in pagination.
node VulnerabilityContainerImage The item at the end of the edge.

VulnerabilityEdge

The edge type for Vulnerability.

Fields
Name Type Description
cursor String! A cursor for use in pagination.
node Vulnerability The item at the end of the edge.

VulnerabilityExternalIssueLinkConnection

The connection type for VulnerabilityExternalIssueLink.

Fields
Name Type Description
edges [VulnerabilityExternalIssueLinkEdge] A list of edges.
nodes [VulnerabilityExternalIssueLink] A list of nodes.
pageInfo PageInfo! Information to aid in pagination.

VulnerabilityExternalIssueLinkEdge

The edge type for VulnerabilityExternalIssueLink.

Fields
Name Type Description
cursor String! A cursor for use in pagination.
node VulnerabilityExternalIssueLink The item at the end of the edge.

VulnerabilityIssueLinkConnection

The connection type for VulnerabilityIssueLink.

Fields
Name Type Description
edges [VulnerabilityIssueLinkEdge] A list of edges.
nodes [VulnerabilityIssueLink] A list of nodes.
pageInfo PageInfo! Information to aid in pagination.

VulnerabilityIssueLinkEdge

The edge type for VulnerabilityIssueLink.

Fields
Name Type Description
cursor String! A cursor for use in pagination.
node VulnerabilityIssueLink The item at the end of the edge.

VulnerabilityManagementPolicyConnection

The connection type for VulnerabilityManagementPolicy.

Fields
Name Type Description
edges [VulnerabilityManagementPolicyEdge] A list of edges.
nodes [VulnerabilityManagementPolicy] A list of nodes.
pageInfo PageInfo! Information to aid in pagination.

VulnerabilityManagementPolicyEdge

The edge type for VulnerabilityManagementPolicy.

Fields
Name Type Description
cursor String! A cursor for use in pagination.
node VulnerabilityManagementPolicy The item at the end of the edge.

VulnerabilityScannerConnection

The connection type for VulnerabilityScanner.

Fields
Name Type Description
edges [VulnerabilityScannerEdge] A list of edges.
nodes [VulnerabilityScanner] A list of nodes.
pageInfo PageInfo! Information to aid in pagination.

VulnerabilityScannerEdge

The edge type for VulnerabilityScanner.

Fields
Name Type Description
cursor String! A cursor for use in pagination.
node VulnerabilityScanner The item at the end of the edge.

VulnerabilityStateTransitionTypeConnection

The connection type for VulnerabilityStateTransitionType.

Fields
Name Type Description
edges [VulnerabilityStateTransitionTypeEdge] A list of edges.
nodes [VulnerabilityStateTransitionType] A list of nodes.
pageInfo PageInfo! Information to aid in pagination.

VulnerabilityStateTransitionTypeEdge

The edge type for VulnerabilityStateTransitionType.

Fields
Name Type Description
cursor String! A cursor for use in pagination.
node VulnerabilityStateTransitionType The item at the end of the edge.

WorkItemClosingMergeRequestConnection

The connection type for WorkItemClosingMergeRequest.

Fields
Name Type Description
count Int Number of merge requests that close the work item on merge.
edges [WorkItemClosingMergeRequestEdge] A list of edges.
nodes [WorkItemClosingMergeRequest] A list of nodes.
pageInfo PageInfo! Information to aid in pagination.

WorkItemClosingMergeRequestEdge

The edge type for WorkItemClosingMergeRequest.

Fields
Name Type Description
cursor String! A cursor for use in pagination.
node WorkItemClosingMergeRequest The item at the end of the edge.

WorkItemConnection

The connection type for WorkItem.

Fields
Name Type Description
count Int! Total count of collection.
edges [WorkItemEdge] A list of edges.
nodes [WorkItem] A list of nodes.
pageInfo PageInfo! Information to aid in pagination.

WorkItemDescriptionTemplateConnection

The connection type for WorkItemDescriptionTemplate.

Fields
Name Type Description
edges [WorkItemDescriptionTemplateEdge] A list of edges.
nodes [WorkItemDescriptionTemplate] A list of nodes.
pageInfo PageInfo! Information to aid in pagination.

WorkItemDescriptionTemplateEdge

The edge type for WorkItemDescriptionTemplate.

Fields
Name Type Description
cursor String! A cursor for use in pagination.
node WorkItemDescriptionTemplate The item at the end of the edge.

WorkItemEdge

The edge type for WorkItem.

Fields
Name Type Description
cursor String! A cursor for use in pagination.
node WorkItem The item at the end of the edge.

WorkItemLinkedResourceConnection

The connection type for WorkItemLinkedResource.

Fields
Name Type Description
edges [WorkItemLinkedResourceEdge] A list of edges.
nodes [WorkItemLinkedResource] A list of nodes.
pageInfo PageInfo! Information to aid in pagination.

WorkItemLinkedResourceEdge

The edge type for WorkItemLinkedResource.

Fields
Name Type Description
cursor String! A cursor for use in pagination.
node WorkItemLinkedResource The item at the end of the edge.

WorkItemRelatedBranchConnection

The connection type for WorkItemRelatedBranch.

Fields
Name Type Description
edges [WorkItemRelatedBranchEdge] A list of edges.
nodes [WorkItemRelatedBranch] A list of nodes.
pageInfo PageInfo! Information to aid in pagination.

WorkItemRelatedBranchEdge

The edge type for WorkItemRelatedBranch.

Fields
Name Type Description
cursor String! A cursor for use in pagination.
node WorkItemRelatedBranch The item at the end of the edge.

WorkItemTimelogConnection

The connection type for WorkItemTimelog.

Fields
Name Type Description
count Int! Total count of collection.
edges [WorkItemTimelogEdge] A list of edges.
nodes [WorkItemTimelog] A list of nodes.
pageInfo PageInfo! Information to aid in pagination.
totalSpentTime BigInt! Total time spent in seconds.

WorkItemTimelogEdge

The edge type for WorkItemTimelog.

Fields
Name Type Description
cursor String! A cursor for use in pagination.
node WorkItemTimelog The item at the end of the edge.

WorkItemTypeConnection

The connection type for WorkItemType.

Fields
Name Type Description
edges [WorkItemTypeEdge] A list of edges.
nodes [WorkItemType] A list of nodes.
pageInfo PageInfo! Information to aid in pagination.

WorkItemTypeEdge

The edge type for WorkItemType.

Fields
Name Type Description
cursor String! A cursor for use in pagination.
node WorkItemType The item at the end of the edge.

WorkspaceConnection

The connection type for Workspace.

Fields
Name Type Description
edges [WorkspaceEdge] A list of edges.
nodes [Workspace] A list of nodes.
pageInfo PageInfo! Information to aid in pagination.

WorkspaceEdge

The edge type for Workspace.

Fields
Name Type Description
cursor String! A cursor for use in pagination.
node Workspace The item at the end of the edge.

WorkspaceVariableConnection

The connection type for WorkspaceVariable.

Fields
Name Type Description
edges [WorkspaceVariableEdge] A list of edges.
nodes [WorkspaceVariable] A list of nodes.
pageInfo PageInfo! Information to aid in pagination.

WorkspaceVariableEdge

The edge type for WorkspaceVariable.

Fields
Name Type Description
cursor String! A cursor for use in pagination.
node WorkspaceVariable The item at the end of the edge.

Object types

Object types represent the resources that the GitLab GraphQL API can return. They contain fields. Each field has its own type, which will either be one of the basic GraphQL scalar types (e.g.: String or Boolean) or other object types. Fields may have arguments. Fields with arguments are exactly like top-level queries, and are listed beneath the table of fields for each object type.

For more information, see Object Types and Fields on graphql.org.

AbuseReport

An abuse report.

Fields

Name Type Description
discussions AbuseReportDiscussionConnection! All discussions on the noteable. (see Connections)
id AbuseReportID! Global ID of the abuse report.
labels AbuseReportLabelConnection Labels of the abuse report. (see Connections)
notes AbuseReportNoteConnection! All notes on the noteable. (see Connections)

AbuseReportDiscussion

Fields

Name Type Description
abuseReport AbuseReport Abuse report which the discussion belongs to.
createdAt Time! Timestamp of the discussion’s creation.
id DiscussionID! ID of the discussion.
notes AbuseReportNoteConnection! All notes in the discussion. (see Connections)
replyId DiscussionID! ID used to reply to the discussion.
resolvable Boolean! Indicates if the object can be resolved.
resolved Boolean! Indicates if the object is resolved.
resolvedAt Time Timestamp of when the object was resolved.
resolvedBy UserCore User who resolved the object.

AbuseReportLabel

Fields

Name Type Description
color String! Background color of the label.
createdAt Time! When the label was created.
description String Description of the label (Markdown rendered as HTML for caching).
descriptionHtml String GitLab Flavored Markdown rendering of description.
id AntiAbuseReportsLabelID! Global ID of the abuse report label.
textColor String! Text color of the label.
title String! Content of the label.
updatedAt Time! When the label was last updated.

AbuseReportNote

Fields

Name Type Description
author UserCore User who wrote the note.
awardEmoji AwardEmojiConnection List of emoji reactions associated with the note. (see Connections)
body String! Content of the note.
bodyFirstLineHtml String! First line of the note content.
bodyHtml String GitLab Flavored Markdown rendering of the content of the note.
createdAt Time! Timestamp of the note creation.
discussion AbuseReportDiscussion Discussion the note is a part of.
id AntiAbuseReportsNoteID! ID of the note.
lastEditedAt Time Timestamp when note was last edited.
lastEditedBy UserCore User who last edited the note.
resolvable Boolean! Indicates if the object can be resolved.
resolved Boolean! Indicates if the object is resolved.
resolvedAt Time Timestamp of when the object was resolved.
resolvedBy UserCore User who resolved the object.
updatedAt Time! Timestamp of the note’s last activity.
url String URL 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

Name Type Description
humanAccess String Human-readable display name for the access level.
integerValue Int Integer number of the access level.
stringValue AccessLevelEnum Enum string of the the access level.

AccessLevelDeployKey

Representation of a GitLab deploy key.

Fields

Name Type Description
expiresAt Date Expiration date of the deploy key.
id ID! ID of the deploy key.
title String! Title of the deploy key.
user AccessLevelUser! User assigned to the deploy key.

AccessLevelGroup

Representation of a GitLab group.

Fields

Name Type Description
avatarUrl String Avatar URL of the group.
id ID! ID of the group.
name String! Name of the group.
parent AccessLevelGroup Parent group.
webUrl String! Web URL of the group.

AccessLevelUser

Representation of a GitLab user.

Fields

Name Type Description
avatarUrl String URL of the user’s avatar.
id ID! ID of the user.
name String! Human-readable name of the user. Returns **** if the user is a project bot and the requester does not have permission to view the project.
publicEmail String User’s public email.
username String! Username of the user.
webPath String! Web path of the user.
webUrl String! Web URL of the user.

Achievement

Fields

Name Type Description
avatarUrl String URL to avatar of the achievement.
createdAt Time! Timestamp the achievement was created.
description String Description or notes for the achievement.
id AchievementsAchievementID! ID of the achievement.
name String! Name of the achievement.
namespace Namespace Namespace of the achievement.
updatedAt Time! Timestamp the achievement was last updated.
userAchievements {{< icon name=”warning-solid” >}} UserAchievementConnection Introduced in GitLab 15.10. Status: Experiment. Recipients for the achievement.

ActivityStream

Activity streams associated with a user.

Fields with arguments

ActivityStream.followedUsersActivity

Activity from users followed by the current user.

{{< details >}} Introduced in GitLab 17.10. Status: Experiment. {{< /details >}}

Returns EventConnection.

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

Arguments
Name Type Description
target EventTarget! Event target.

AddOnPurchase

Represents AddOn purchase for Namespace.

Fields

Name Type Description
assignedQuantity Int! Number of seats assigned.
id GitlabSubscriptionsAddOnPurchaseID! ID of AddOnPurchase.
name String! Name of AddOn.
purchasedQuantity Int! Number of seats purchased.

AddOnUser

A user with add-on data.

Fields

Name Type Description
active Boolean Indicates if the user is active.
avatarUrl String URL of the user’s avatar.
bio String Bio of the user.
bot Boolean! Indicates if the user is a bot.
callouts UserCalloutConnection User callouts that belong to the user. (see Connections)
commitEmail String User’s default commit email.
createdAt Time Timestamp of when the user was created.
discord String Discord ID of the user.
email {{< icon name=”warning-solid” >}} String Deprecated in GitLab 13.7. This was renamed. Use: User.publicEmail.
emails EmailConnection User’s email addresses. (see Connections)
gitpodEnabled Boolean Whether Gitpod is enabled at the user level.
groupCount Int Group count for the user.
groupMemberships GroupMemberConnection Group memberships of the user. (see Connections)
human Boolean Indicates if the user is a regular user.
id UserID! Global ID of the user.
ide Ide IDE settings.
jobTitle String Job title of the user.
lastActivityOn Date Date the user last performed any actions.
lastDuoActivityOn Date Date of the last Duo activity of the user. Refreshed on any GitLab Duo activity.
lastLoginAt Time Timestamp of the last sign in.
linkedin String LinkedIn profile name of the user.
location String Location of the user.
name String! Human-readable name of the user. Returns **** if the user is a project bot and the requester does not have permission to view the project.
namespace Namespace Personal namespace of the user.
namespaceCommitEmails NamespaceCommitEmailConnection User’s custom namespace commit emails. (see Connections)
organization String Who the user represents or works for.
preferencesGitpodPath String Web path to the Gitpod section within user preferences.
profileEnableGitpodPath String Web path to enable Gitpod for the user.
projectMemberships ProjectMemberConnection Project memberships of the user. (see Connections)
pronouns String Pronouns of the user.
publicEmail String User’s public email.
savedReplies SavedReplyConnection Saved replies authored by the user. (see Connections)
state UserState! State of the user.
status UserStatus User status.
twitter String X (formerly Twitter) username of the user.
type UserType! Type of the user.
userPermissions UserPermissions! Permissions for the current user on the resource.
userPreferences UserPreferences Preferences for the user.
username String! Username of the user. Unique within the instance of GitLab.
webPath String! Web path of the user.
webUrl String! Web URL of the user.

Fields with arguments

AddOnUser.addOnAssignments

Add-on purchase assignments for the user.

{{< details >}} Introduced in GitLab 16.4. Status: Experiment. {{< /details >}}

Returns UserAddOnAssignmentConnection.

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

Arguments
Name Type Description
addOnPurchaseIds [GitlabSubscriptionsAddOnPurchaseID!]! Global IDs of the add on purchases to find assignments for.
AddOnUser.assignedMergeRequests

Merge requests assigned to the user.

Returns MergeRequestConnection.

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

Arguments
Name Type Description
approved Boolean Limit results to approved merge requests. Available only when the feature flag mr_approved_filter is enabled.
approvedBy [String!] Usernames of the approvers.
approver [String!] Usernames of possible approvers.
authorUsername String Username of the author.
blobPath {{< icon name=”warning-solid” >}} String Introduced 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.
createdAfter Time Merge requests created after the timestamp.
createdBefore Time Merge requests created before the timestamp.
deployedAfter Time Merge requests deployed after the timestamp.
deployedBefore Time Merge requests deployed before the timestamp.
deploymentId String ID of the deployment.
draft Boolean Limit result to draft merge requests.
environmentName String Environment merge requests have been deployed to.
groupId GroupID The global ID of the group the authored merge requests should be in. Merge requests in subgroups are included.
ignoredReviewerUsername {{< icon name=”warning-solid” >}} String Introduced in GitLab 18.0. Status: Experiment. Username of the reviewer to ignore when searching by reviewer state.
iids [String!] Array of IIDs of merge requests, for example [1, 2].
in [IssuableSearchableField!] Specify the fields to perform the search in. Defaults to [TITLE, DESCRIPTION]. Requires the search argument.’.
includeArchived Boolean Merge requests from archived projects.
labelName [String] Labels applied to the merge request.
labels {{< icon name=”warning-solid” >}} [String!] Deprecated in GitLab 17.1. Use labelName.
mergedAfter Time Merge requests merged after the date.
mergedBefore Time Merge requests merged before the date.
mergedBy String Username of the merger.
milestoneTitle String Title of the milestone. Incompatible with milestoneWildcardId.
milestoneWildcardId MilestoneWildcardId Filter issues by milestone ID wildcard. Incompatible with milestoneTitle.
myReactionEmoji String Filter by your reaction emoji.
not MergeRequestsResolverNegatedParams List of negated arguments. Warning: this argument is experimental and a subject to change in future.
or UnionedMergeRequestFilterInput List of arguments with inclusive OR.
projectId ProjectID The global ID of the project the authored merge requests should be in. Incompatible with projectPath.
projectPath String The full-path of the project the authored merge requests should be in. Incompatible with projectId.
releaseTag String Filter by release tag.
reviewState {{< icon name=”warning-solid” >}} MergeRequestReviewState Introduced in GitLab 17.0. Status: Experiment. Reviewer state of the merge request.
reviewStates {{< icon name=”warning-solid” >}} [MergeRequestReviewState!] Introduced in GitLab 17.0. Status: Experiment. Reviewer states of the merge request.
reviewerUsername String Username of the reviewer.
reviewerWildcardId ReviewerWildcardId Filter by reviewer presence. Incompatible with reviewerUsername.
search String Search query for title or description.
sort MergeRequestSort Sort merge requests by the criteria.
sourceBranches [String!] Array of source branch names. All resolved merge requests will have one of these branches as their source.
state MergeRequestState Merge request state. If provided, all resolved merge requests will have the state.
subscribed SubscriptionStatus Merge requests the current user is subscribed to.
targetBranches [String!] Array of target branch names. All resolved merge requests will have one of these branches as their target.
updatedAfter Time Merge requests updated after the timestamp.
updatedBefore Time Merge requests updated before the timestamp.
AddOnUser.authoredMergeRequests

Merge requests authored by the user.

Returns MergeRequestConnection.

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

Arguments
Name Type Description
approved Boolean Limit results to approved merge requests. Available only when the feature flag mr_approved_filter is enabled.
approvedBy [String!] Usernames of the approvers.
approver [String!] Usernames of possible approvers.
assigneeUsername String Username of the assignee.
assigneeUsernames [String!] Usernames of users assigned to the merge request.
assigneeWildcardId AssigneeWildcardId Filter by assignee presence. Incompatible with assigneeUsernames and assigneeUsername.
blobPath {{< icon name=”warning-solid” >}} String Introduced 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.
createdAfter Time Merge requests created after the timestamp.
createdBefore Time Merge requests created before the timestamp.
deployedAfter Time Merge requests deployed after the timestamp.
deployedBefore Time Merge requests deployed before the timestamp.
deploymentId String ID of the deployment.
draft Boolean Limit result to draft merge requests.
environmentName String Environment merge requests have been deployed to.
groupId GroupID The global ID of the group the authored merge requests should be in. Merge requests in subgroups are included.
ignoredReviewerUsername {{< icon name=”warning-solid” >}} String Introduced in GitLab 18.0. Status: Experiment. Username of the reviewer to ignore when searching by reviewer state.
iids [String!] Array of IIDs of merge requests, for example [1, 2].
in [IssuableSearchableField!] Specify the fields to perform the search in. Defaults to [TITLE, DESCRIPTION]. Requires the search argument.’.
includeArchived Boolean Merge requests from archived projects.
includeAssigned Boolean Include merge requests the user is assigned to.
labelName [String] Labels applied to the merge request.
labels {{< icon name=”warning-solid” >}} [String!] Deprecated in GitLab 17.1. Use labelName.
mergedAfter Time Merge requests merged after the date.
mergedBefore Time Merge requests merged before the date.
mergedBy String Username of the merger.
milestoneTitle String Title of the milestone. Incompatible with milestoneWildcardId.
milestoneWildcardId MilestoneWildcardId Filter issues by milestone ID wildcard. Incompatible with milestoneTitle.
myReactionEmoji String Filter by your reaction emoji.
not MergeRequestsResolverNegatedParams List of negated arguments. Warning: this argument is experimental and a subject to change in future.
or UnionedMergeRequestFilterInput List of arguments with inclusive OR.
projectId ProjectID The global ID of the project the authored merge requests should be in. Incompatible with projectPath.
projectPath String The full-path of the project the authored merge requests should be in. Incompatible with projectId.
releaseTag String Filter by release tag.
reviewState {{< icon name=”warning-solid” >}} MergeRequestReviewState Introduced in GitLab 17.0. Status: Experiment. Reviewer state of the merge request.
reviewStates {{< icon name=”warning-solid” >}} [MergeRequestReviewState!] Introduced in GitLab 17.0. Status: Experiment. Reviewer states of the merge request.
reviewerUsername String Username of the reviewer.
reviewerWildcardId ReviewerWildcardId Filter by reviewer presence. Incompatible with reviewerUsername.
search String Search query for title or description.
sort MergeRequestSort Sort merge requests by the criteria.
sourceBranches [String!] Array of source branch names. All resolved merge requests will have one of these branches as their source.
state MergeRequestState Merge request state. If provided, all resolved merge requests will have the state.
subscribed SubscriptionStatus Merge requests the current user is subscribed to.
targetBranches [String!] Array of target branch names. All resolved merge requests will have one of these branches as their target.
updatedAfter Time Merge requests updated after the timestamp.
updatedBefore Time Merge requests updated before the timestamp.
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
Name Type Description
includePersonal Boolean Include personal projects.
minAccessLevel AccessLevelEnum Return only projects where current user has at least the specified access level.
programmingLanguageName String Filter projects by programming language name (case insensitive). For example: “css” or “ruby”.
search String Search query.
sort ProjectSort Sort contributed projects.
AddOnUser.groups

Groups where the user has access.

Returns GroupConnection.

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

Arguments
Name Type Description
permissionScope GroupPermission Filter by permissions the user has on groups.
search String Search by group name or path.
sort GroupSort Sort groups by given criteria.
AddOnUser.organizations

Organizations where the user has access.

{{< details >}} Introduced in GitLab 16.6. Status: Experiment. {{< /details >}}

Returns OrganizationConnection.

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

Arguments
Name Type Description
search String Search query, which can be for the organization name or a path.
soloOwned Boolean When 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
Name Type Description
approved Boolean Limit 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.
assigneeUsername String Username of the assignee.
assigneeUsernames [String!] Usernames of users assigned to the merge request.
assigneeWildcardId AssigneeWildcardId Filter by assignee presence. Incompatible with assigneeUsernames and assigneeUsername.
authorUsername String Username of the author.
blobPath {{< icon name=”warning-solid” >}} String Introduced 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.
createdAfter Time Merge requests created after the timestamp.
createdBefore Time Merge requests created before the timestamp.
deployedAfter Time Merge requests deployed after the timestamp.
deployedBefore Time Merge requests deployed before the timestamp.
deploymentId String ID of the deployment.
draft Boolean Limit result to draft merge requests.
environmentName String Environment merge requests have been deployed to.
groupId GroupID The global ID of the group the authored merge requests should be in. Merge requests in subgroups are included.
ignoredReviewerUsername {{< icon name=”warning-solid” >}} String Introduced in GitLab 18.0. Status: Experiment. Username of the reviewer to ignore when searching by reviewer state.
iids [String!] Array of IIDs of merge requests, for example [1, 2].
in [IssuableSearchableField!] Specify the fields to perform the search in. Defaults to [TITLE, DESCRIPTION]. Requires the search argument.’.
includeArchived Boolean Merge requests from archived projects.
labelName [String] Labels applied to the merge request.
labels {{< icon name=”warning-solid” >}} [String!] Deprecated in GitLab 17.1. Use labelName.
mergedAfter Time Merge requests merged after the date.
mergedBefore Time Merge requests merged before the date.
mergedBy String Username of the merger.
milestoneTitle String Title of the milestone. Incompatible with milestoneWildcardId.
milestoneWildcardId MilestoneWildcardId Filter issues by milestone ID wildcard. Incompatible with milestoneTitle.
myReactionEmoji String Filter by your reaction emoji.
not MergeRequestsResolverNegatedParams List of negated arguments. Warning: this argument is experimental and a subject to change in future.
or UnionedMergeRequestFilterInput List of arguments with inclusive OR.
projectId ProjectID The global ID of the project the authored merge requests should be in. Incompatible with projectPath.
projectPath String The full-path of the project the authored merge requests should be in. Incompatible with projectId.
releaseTag String Filter by release tag.
reviewState {{< icon name=”warning-solid” >}} MergeRequestReviewState Introduced in GitLab 17.0. Status: Experiment. Reviewer state of the merge request.
reviewStates {{< icon name=”warning-solid” >}} [MergeRequestReviewState!] Introduced in GitLab 17.0. Status: Experiment. Reviewer states of the merge request.
search String Search query for title or description.
sort MergeRequestSort Sort merge requests by the criteria.
sourceBranches [String!] Array of source branch names. All resolved merge requests will have one of these branches as their source.
state MergeRequestState Merge request state. If provided, all resolved merge requests will have the state.
subscribed SubscriptionStatus Merge requests the current user is subscribed to.
targetBranches [String!] Array of target branch names. All resolved merge requests will have one of these branches as their target.
updatedAfter Time Merge requests updated after the timestamp.
updatedBefore Time Merge requests updated before the timestamp.
AddOnUser.savedReply

Saved reply authored by the user.

Returns SavedReply.

Arguments
Name Type Description
id UsersSavedReplyID! ID of a saved reply.
AddOnUser.snippets

Snippets authored by the user.

Returns SnippetConnection.

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

Arguments
Name Type Description
ids [SnippetID!] Array of global snippet IDs. For example, gid://gitlab/ProjectSnippet/1.
type TypeEnum Type of snippet.
visibility VisibilityScopesEnum Visibility of the snippet.
AddOnUser.starredProjects

Projects starred by the user.

Returns ProjectConnection.

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

Arguments
Name Type Description
minAccessLevel AccessLevelEnum Return only projects where current user has at least the specified access level.
programmingLanguageName String Filter projects by programming language name (case insensitive). For example: “css” or “ruby”.
search String Search query.
sort ProjectSort List starred projects by sort order.
AddOnUser.timelogs

Time logged by the user.

Returns TimelogConnection.

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

Arguments
Name Type Description
endDate Time List timelogs within a date range where the logged date is equal to or before endDate.
endTime Time List timelogs within a time range where the logged time is equal to or before endTime.
groupId GroupID List timelogs for a group.
projectId ProjectID List timelogs for a project.
sort TimelogSort List timelogs in a particular order.
startDate Time List timelogs within a date range where the logged date is equal to or after startDate.
startTime Time List timelogs within a time range where the logged time is equal to or after startTime.
username String List timelogs for a user.
AddOnUser.todos

To-do items of the user.

Returns TodoConnection.

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

Arguments
Name Type Description
action [TodoActionEnum!] Action to be filtered.
authorId [ID!] ID of an author.
groupId [ID!] ID of a group.
isSnoozed Boolean Whether the to-do item is snoozed.
projectId [ID!] ID of a project.
sort TodoSort Sort todos by given criteria.
state [TodoStateEnum!] State of the todo.
type [TodoTargetEnum!] Type of the todo.
AddOnUser.userAchievements

Achievements for the user. Only returns for namespaces where the achievements feature flag is enabled.

{{< details >}} Introduced in GitLab 15.10. Status: Experiment. {{< /details >}}

Returns UserAchievementConnection.

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

Arguments
Name Type Description
includeHidden Boolean Indicates 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
Name Type Description
actualStates [String!] Filter workspaces by actual states.
agentIds [ClustersAgentID!] Filter workspaces by agent GlobalIDs.
ids [RemoteDevelopmentWorkspaceID!] Filter workspaces by workspace GlobalIDs. For example, ["gid://gitlab/RemoteDevelopment::Workspace/1"].
includeActualStates {{< icon name=”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

Name Type Description
createdAt Time! Timestamp of when the member role was created.
description String Role description.
detailsPath {{< icon name=”warning-solid” >}} String Introduced in GitLab 17.4. Status: Experiment. URL path to the role details webpage.
editPath {{< icon name=”warning-solid” >}} String! Introduced in GitLab 16.11. Status: Experiment. Web UI path to edit the custom role.
enabledPermissions {{< icon name=”warning-solid” >}} CustomizableAdminPermissionConnection! Introduced in GitLab 17.7. Status: Experiment. Array of all permissions enabled for the custom role.
id ID! Role ID.
membersCount {{< icon name=”warning-solid” >}} Int Introduced in GitLab 17.3. Status: Experiment. Number of times the role has been directly assigned to a group or project member.
name String Role name.
usersCount {{< icon name=”warning-solid” >}} Int Introduced 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

Name Type Description
agentName String Name of the agent.

AgentMetadata

Information about a connected Agent.

Fields

Name Type Description
commit String Agent version commit.
podName String Name of the pod running the Agent.
podNamespace String Namespace of the pod running the Agent.
version String Agent version tag.

AgentVersionWarning

Version-related warning for a connected Agent.

Fields

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

AgentWarning

Warning object for a connected Agent.

Fields

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

AggregationStatus

Fields

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

AiAdditionalContext

Additional context for AI message.

Fields

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

AiAgent

An AI agent.

Fields

Name Type Description
createdAt Time! Date of creation.
id ID! ID of the agent.
latestVersion AiAgentVersion Latest version of the agent.
name String! Name of the agent.
routeId Int! Route ID of the agent.
versions [AiAgentVersion!] Versions of the agent.

AiAgentVersion

Version of an AI Agent.

Fields

Name Type Description
createdAt Time! Timestamp when the agent version was created.
id ID! ID of the agent version.
model String! Model of the agent.
prompt String! Prompt of the agent.

AiConversationsThread

Conversation thread of the AI feature.

Fields

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

AiFeatureSetting

Duo Chat feature setting.

Fields

Name Type Description
compatibleLlms [String!] LLMs Compatible with the feature.
feature String! Identifier for the AI feature.
mainFeature String Displayed name of the main feature.
provider String! Humanized name for the AI feature, e.g “Code Completion”.
releaseState String Current release state of the feature.
selfHostedModel AiSelfHostedModel Self-hosted model selected for use with the AI feature.
title String Displayed AI feature name.
validModels AiSelfHostedModelConnection! Compatible self-hosted models for the feature. (see Connections)

AiMessage

AI features communication message.

Fields

Name Type Description
agentVersionId AiAgentVersionID Global ID of the agent version to answer the message.
chunkId Int Incremental ID for a chunk from a streamed message. Null when it is not a streamed message.
content String Raw response content.
contentHtml String Response content as HTML.
errors [String!] Message errors.
extras AiMessageExtras Extra message metadata.
id ID UUID of the message.
requestId String UUID of the original request. Shared between chat prompt and response.
role AiMessageRole! Message owner role.
threadId AiConversationThreadID Global ID of the existing thread for the Chat conversation.
timestamp Time! Message creation timestamp.
type AiMessageType Message type.

AiMessageExtras

Extra metadata for AI message.

Fields

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

AiMetrics

Requires ClickHouse. Premium and Ultimate with GitLab Duo Pro and Enterprise only.

Fields

Name Type Description
codeContributorsCount Int Number of code contributors.
codeSuggestionsAcceptedCount {{< icon name=”warning-solid” >}} Int Deprecated in GitLab 18.0. moved to codeSuggestions field.
codeSuggestionsContributorsCount {{< icon name=”warning-solid” >}} Int Deprecated in GitLab 18.0. moved to codeSuggestions field.
codeSuggestionsShownCount {{< icon name=”warning-solid” >}} Int Deprecated in GitLab 18.0. moved to codeSuggestions field.
duoAssignedUsersCount Int Total assigned Duo Pro and Enterprise seats. Ignores time period filter. Returns current data.
duoChatContributorsCount Int Number of contributors who used GitLab Duo Chat features.
duoUsedCount Int Number of contributors who used any GitLab Duo feature.
rootCauseAnalysisUsersCount Int Number of users using troubleshoot within a failed pipeline.

Fields with arguments

AiMetrics.codeSuggestions

Code suggestions metrics.

Returns codeSuggestionMetrics.

Arguments
Name Type Description
languages [String!] Filter code suggestion metrics by one or more languages.

AiSelfHostedModel

Self-hosted LLM servers.

Fields

Name Type Description
apiToken String Optional API key for the self-hosted model server.
createdAt Time! Timestamp of creation.
endpoint String! Endpoint of the self-hosted model server.
featureSettings AiFeatureSettingConnection AI feature settings using the self-hosted model. (see Connections)
hasApiToken Boolean! Indicates if an API key is set for the self-hosted model server.
id AiSelfHostedModelID! ID of the self-hosted model server.
identifier String Identifier for 3rd party model provider.
model String! AI model deployed.
modelDisplayName String! Display name of the AI model deployed.
name String! Deployment name of the self-hosted model.
releaseState AiSelfHostedModelReleaseState! GitLab release status of the model.
updatedAt Time Timestamp 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

Name Type Description
codeSuggestionEvents CodeSuggestionEventConnection Events 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

Name Type Description
codeSuggestionsAcceptedCount Int Total count of code suggestions accepted by the user.
duoChatInteractionsCount Int Number of user interactions with GitLab Duo Chat.
user AddOnUser! User associated with metrics.

AiXrayReport

Fields

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

AlertManagementAlert

Describes an alert from the project’s Alert Management.

Fields

Name Type Description
assignees UserCoreConnection Assignees of the alert. (see Connections)
commenters UserCoreConnection! All commenters on the noteable. (see Connections)
createdAt Time Timestamp the alert was created.
description String Description of the alert.
details JSON Alert details.
detailsUrl String! URL of the alert detail page.
discussions DiscussionConnection! All discussions on the noteable. (see Connections)
endedAt Time Timestamp the alert ended.
environment Environment Environment for the alert.
eventCount Int Number of events of the alert.
hosts [String!] List of hosts the alert came from.
id ID! ID of the alert.
iid String! Internal ID of the alert.
issue Issue Issue attached to the alert.
issueIid {{< icon name=”warning-solid” >}} String Deprecated in GitLab 13.10. Use issue field.
metricsDashboardUrl {{< icon name=”warning-solid” >}} String Deprecated in GitLab 16.0. Returns no data. Underlying feature was removed in 16.0.
monitoringTool String Monitoring tool the alert came from.
name String Name or title of the object.
prometheusAlert {{< icon name=”warning-solid” >}} PrometheusAlert Deprecated in GitLab 17.3. Returns no data. Underlying feature was removed in 16.0.
runbook String Runbook for the alert as defined in alert details.
service String Service the alert came from.
severity AlertManagementSeverity Severity of the alert.
startedAt Time Timestamp the alert was raised.
status AlertManagementStatus Status of the alert.
title String Title of the alert.
updatedAt Time Timestamp the alert was last updated.
webUrl String! URL of the alert.

Fields with arguments

AlertManagementAlert.notes

All notes on this noteable.

Returns NoteConnection!.

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

Arguments
Name Type Description
filter NotesFilterType Type of notes collection: ALL_NOTES, ONLY_COMMENTS, ONLY_ACTIVITY.
AlertManagementAlert.todos

To-do items of the current user for the alert.

Returns TodoConnection.

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

Arguments
Name Type Description
action [TodoActionEnum!] Action to be filtered.
authorId [ID!] ID of an author.
groupId [ID!] ID of a group.
isSnoozed Boolean Whether the to-do item is snoozed.
projectId [ID!] ID of a project.
sort TodoSort Sort todos by given criteria.
state [TodoStateEnum!] State of the todo.
type [TodoTargetEnum!] Type of the todo.

AlertManagementAlertStatusCountsType

Represents total number of alerts for the represented categories.

Fields

Name Type Description
acknowledged Int Number of alerts with status ACKNOWLEDGED for the project.
all Int Total number of alerts for the project.
ignored Int Number of alerts with status IGNORED for the project.
open Int Number of alerts with status TRIGGERED or ACKNOWLEDGED for the project.
resolved Int Number of alerts with status RESOLVED for the project.
triggered Int Number of alerts with status TRIGGERED for the project.

AlertManagementHttpIntegration

An endpoint and credentials used to accept alerts for a project.

Fields

Name Type Description
active Boolean Whether the endpoint is currently accepting alerts.
apiUrl String URL at which Prometheus metrics can be queried to populate the metrics dashboard.
id ID! ID of the integration.
name String Name of the integration.
payloadAlertFields [AlertManagementPayloadAlertField!] Extract alert fields from payload example for custom mapping.
payloadAttributeMappings [AlertManagementPayloadAlertMappingField!] The custom mapping of GitLab alert attributes to fields from the payload_example.
payloadExample JsonString Example of an alert payload.
token String Token used to authenticate alert notification requests.
type AlertManagementIntegrationType! Type of integration.
url String Endpoint which accepts alert notifications.

AlertManagementPayloadAlertField

Parsed field from an alert used for custom mappings.

Fields

Name Type Description
label String Human-readable label of the payload path.
path [PayloadAlertFieldPathSegment!] Path to value inside payload JSON.
type AlertManagementPayloadAlertFieldType Type of the parsed value.

AlertManagementPayloadAlertMappingField

Parsed field (with its name) from an alert used for custom mappings.

Fields

Name Type Description
fieldName AlertManagementPayloadAlertFieldName GitLab alert field name.
label String Human-readable label of the payload path.
path [PayloadAlertFieldPathSegment!] Path to value inside payload JSON.
type AlertManagementPayloadAlertFieldType Type of the parsed value.

AlertManagementPrometheusIntegration

An endpoint and credentials used to accept Prometheus alerts for a project.

Fields

Name Type Description
active Boolean Whether the endpoint is currently accepting alerts.
apiUrl String URL at which Prometheus metrics can be queried to populate the metrics dashboard.
id ID! ID of the integration.
name String Name of the integration.
token String Token used to authenticate alert notification requests.
type AlertManagementIntegrationType! Type of integration.
url String Endpoint which accepts alert notifications.

AmazonS3ConfigurationType

Stores Amazon S3 configurations for audit event streaming.

Fields

Name Type Description
accessKeyXid String! Access key ID of the Amazon S3 account.
awsRegion String! AWS region where the bucket is created.
bucketName String! Name of the bucket where the audit events would be logged.
group Group! Group the configuration belongs to.
id ID! ID of the configuration.
name String! Name of the external destination to send audit events to.

AncestorType

Fields

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

ApiFuzzingCiConfiguration

Data associated with configuring API fuzzing scans in GitLab CI.

Fields

Name Type Description
scanModes [ApiFuzzingScanMode!] All available scan modes.
scanProfiles [ApiFuzzingScanProfile!] All default scan profiles.

ApiFuzzingScanProfile

An API Fuzzing scan profile.

Fields

Name Type Description
description String Short description of the profile.
name String Unique name of the profile.
yaml String Syntax highlighted HTML representation of the YAML.

ApprovalPolicy

Represents the approval policy.

Fields

Name Type Description
actionApprovers [PolicyApproversType!] Multiple approvers action.
allGroupApprovers [PolicyApprovalGroup!] All potential approvers of the group type, including groups inaccessible to the user.
customRoles [MemberRole!] Approvers of the custom role type. Users belonging to these role(s) alone will be approvers.
deprecatedProperties {{< icon name=”warning-solid” >}} [String!] Introduced in GitLab 16.10. Status: Experiment. All deprecated properties in the policy.
description String! Description of the policy.
editPath String! URL of policy edit page.
enabled Boolean! Indicates whether the policy is enabled.
name String! Name of the policy.
policyScope PolicyScope Scope of the policy.
roleApprovers [MemberAccessLevelName!] Approvers of the role type. Users belonging to these role(s) alone will be approvers.
source SecurityPolicySource! Source of the policy. Its fields depend on the source type.
updatedAt Time! Timestamp of when the policy YAML was last updated.
userApprovers [UserCore!] Approvers of the user type.
yaml String! YAML definition of the policy.

ApprovalProjectRule

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

Fields

Name Type Description
approvalsRequired Int Number of required approvals.
eligibleApprovers UserCoreConnection List of users eligible to approve merge requests for the approval rule. (see Connections)
id GlobalID! ID of the rule.
name String Name of the rule.
type ApprovalRuleType Type of the rule.

ApprovalRule

Describes a rule for who can approve merge requests.

Fields

Name Type Description
allowMergeWhenInvalid Boolean Indicates if the rule can be ignored if it is invalid.
approvalsRequired Int Number of required approvals.
approved Boolean Indicates if the rule is satisfied.
approvedBy UserCoreConnection List of users defined in the rule that approved the merge request. (see Connections)
commentedBy UserCoreConnection List of users, defined in the rule, who commented on the merge request. (see Connections)
containsHiddenGroups Boolean Indicates if the rule contains approvers from a hidden group.
eligibleApprovers [UserCore!] List of all users eligible to approve the merge request (defined explicitly and from associated groups).
groups GroupConnection List of groups added as approvers for the rule. (see Connections)
id GlobalID! ID of the rule.
invalid Boolean Indicates if the rule is invalid and cannot be approved.
name String Name of the rule.
overridden Boolean Indicates if the rule was overridden for the merge request.
scanResultPolicies [ApprovalScanResultPolicy!] List of scan result policies associated with the rule.
section String Named section of the Code Owners file that the rule applies to.
sourceRule ApprovalRule Source rule used to create the rule.
type ApprovalRuleType Type of the rule.
users UserCoreConnection List of users added as approvers for the rule. (see Connections)

ApprovalScanResultPolicy

Represents the scan result policy.

Fields

Name Type Description
approvalsRequired Int! Represents the required approvals defined in the policy.
name String! Represents the name of the policy.
reportType ApprovalReportType! Represents the report_type of the approval rule.

AssetType

Represents a vulnerability asset type.

Fields

Name Type Description
name String! Name of the asset.
type String! Type of the asset.
url String! URL of the asset.

AuditEventDefinition

Represents the YAML definitions for audit events defined in ee/config/audit_events/types/<event-type-name>.yml and config/audit_events/types/<event-type-name>.yml.

Fields

Name Type Description
description String! Description of what action the audit event tracks.
featureCategory String! Feature category associated with the event.
introducedByIssue String Link to the issue introducing the event. For olderaudit events, it can be a commit URL rather than amerge request URL.
introducedByMr String Link to the merge request introducing the event. Forolder audit events, it can be a commit URL rather thana merge request URL.
milestone String! Milestone the event was introduced in.
name String! Key name of the audit event.
savedToDatabase Boolean! Indicates if the event is saved to PostgreSQL database.
streamed Boolean! Indicates if the event is streamed to an external destination.

AuditEventStreamingHTTPNamespaceFilter

Represents a subgroup or project filter that belongs to an external audit event streaming destination.

Fields

Name Type Description
externalAuditEventDestination ExternalAuditEventDestination! Destination to which the filter belongs.
id ID! ID of the filter.
namespace Namespace! Group or project namespace the filter belongs to.

AuditEventStreamingHeader

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

Fields

Name Type Description
active Boolean! Header is active or not.
id ID! ID of the header.
key String! Key of the header.
value String! Value of the header.

AuditEventsStreamingHTTPNamespaceFiltersAddPayload

Autogenerated return type of AuditEventsStreamingHTTPNamespaceFiltersAdd.

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.
namespaceFilter AuditEventStreamingHTTPNamespaceFilter Namespace filter created.

AuditEventsStreamingHTTPNamespaceFiltersDeletePayload

Autogenerated return type of AuditEventsStreamingHTTPNamespaceFiltersDelete.

Fields

Name Type Description
clientMutationId String A unique identifier for the client performing the mutation.
errors [String!]! Errors encountered during execution of the mutation.

AuditEventsStreamingInstanceHeader

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

Fields

Name Type Description
active Boolean! Header is active or not.
id ID! ID of the header.
key String! Key of the header.
value String! Value of the header.

AutocompletedUser

Core representation of a GitLab user.

Fields

Name Type Description
active Boolean Indicates if the user is active.
avatarUrl String URL of the user’s avatar.
bio String Bio of the user.
bot Boolean! Indicates if the user is a bot.
callouts UserCalloutConnection User callouts that belong to the user. (see Connections)
commitEmail String User’s default commit email.
createdAt Time Timestamp of when the user was created.
discord String Discord ID of the user.
email {{< icon name=”warning-solid” >}} String Deprecated in GitLab 13.7. This was renamed. Use: User.publicEmail.
emails EmailConnection User’s email addresses. (see Connections)
gitpodEnabled Boolean Whether Gitpod is enabled at the user level.
groupCount Int Group count for the user.
groupMemberships GroupMemberConnection Group memberships of the user. (see Connections)
human Boolean Indicates if the user is a regular user.
id UserID! Global ID of the user.
ide Ide IDE settings.
jobTitle String Job title of the user.
lastActivityOn Date Date the user last performed any actions.
linkedin String LinkedIn profile name of the user.
location String Location of the user.
name String! Human-readable name of the user. Returns **** if the user is a project bot and the requester does not have permission to view the project.
namespace Namespace Personal namespace of the user.
namespaceCommitEmails NamespaceCommitEmailConnection User’s custom namespace commit emails. (see Connections)
organization String Who the user represents or works for.
preferencesGitpodPath String Web path to the Gitpod section within user preferences.
profileEnableGitpodPath String Web path to enable Gitpod for the user.
projectMemberships ProjectMemberConnection Project memberships of the user. (see Connections)
pronouns String Pronouns of the user.
publicEmail String User’s public email.
savedReplies SavedReplyConnection Saved replies authored by the user. (see Connections)
state UserState! State of the user.
status UserStatus User status.
twitter String X (formerly Twitter) username of the user.
type UserType! Type of the user.
userPermissions UserPermissions! Permissions for the current user on the resource.
userPreferences UserPreferences Preferences for the user.
username String! Username of the user. Unique within the instance of GitLab.
webPath String! Web path of the user.
webUrl String! Web URL of the user.

Fields with arguments

AutocompletedUser.assignedMergeRequests

Merge requests assigned to the user.

Returns MergeRequestConnection.

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

Arguments
Name Type Description
approved Boolean Limit results to approved merge requests. Available only when the feature flag mr_approved_filter is enabled.
approvedBy [String!] Usernames of the approvers.
approver [String!] Usernames of possible approvers.
authorUsername String Username of the author.
blobPath {{< icon name=”warning-solid” >}} String Introduced 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.
createdAfter Time Merge requests created after the timestamp.
createdBefore Time Merge requests created before the timestamp.
deployedAfter Time Merge requests deployed after the timestamp.
deployedBefore Time Merge requests deployed before the timestamp.
deploymentId String ID of the deployment.
draft Boolean Limit result to draft merge requests.
environmentName String Environment merge requests have been deployed to.
groupId GroupID The global ID of the group the authored merge requests should be in. Merge requests in subgroups are included.
ignoredReviewerUsername {{< icon name=”warning-solid” >}} String Introduced in GitLab 18.0. Status: Experiment. Username of the reviewer to ignore when searching by reviewer state.
iids [String!] Array of IIDs of merge requests, for example [1, 2].
in [IssuableSearchableField!] Specify the fields to perform the search in. Defaults to [TITLE, DESCRIPTION]. Requires the search argument.’.
includeArchived Boolean Merge requests from archived projects.
labelName [String] Labels applied to the merge request.
labels {{< icon name=”warning-solid” >}} [String!] Deprecated in GitLab 17.1. Use labelName.
mergedAfter Time Merge requests merged after the date.
mergedBefore Time Merge requests merged before the date.
mergedBy String Username of the merger.
milestoneTitle String Title of the milestone. Incompatible with milestoneWildcardId.
milestoneWildcardId MilestoneWildcardId Filter issues by milestone ID wildcard. Incompatible with milestoneTitle.
myReactionEmoji String Filter by your reaction emoji.
not MergeRequestsResolverNegatedParams List of negated arguments. Warning: this argument is experimental and a subject to change in future.
or UnionedMergeRequestFilterInput List of arguments with inclusive OR.
projectId ProjectID The global ID of the project the authored merge requests should be in. Incompatible with projectPath.
projectPath String The full-path of the project the authored merge requests should be in. Incompatible with projectId.
releaseTag String Filter by release tag.
reviewState {{< icon name=”warning-solid” >}} MergeRequestReviewState Introduced in GitLab 17.0. Status: Experiment. Reviewer state of the merge request.
reviewStates {{< icon name=”warning-solid” >}} [MergeRequestReviewState!] Introduced in GitLab 17.0. Status: Experiment. Reviewer states of the merge request.
reviewerUsername String Username of the reviewer.
reviewerWildcardId ReviewerWildcardId Filter by reviewer presence. Incompatible with reviewerUsername.
search String Search query for title or description.
sort MergeRequestSort Sort merge requests by the criteria.
sourceBranches [String!] Array of source branch names. All resolved merge requests will have one of these branches as their source.
state MergeRequestState Merge request state. If provided, all resolved merge requests will have the state.
subscribed SubscriptionStatus Merge requests the current user is subscribed to.
targetBranches [String!] Array of target branch names. All resolved merge requests will have one of these branches as their target.
updatedAfter Time Merge requests updated after the timestamp.
updatedBefore Time Merge requests updated before the timestamp.
AutocompletedUser.authoredMergeRequests

Merge requests authored by the user.

Returns MergeRequestConnection.

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

Arguments
Name Type Description
approved Boolean Limit results to approved merge requests. Available only when the feature flag mr_approved_filter is enabled.
approvedBy [String!] Usernames of the approvers.
approver [String!] Usernames of possible approvers.
assigneeUsername String Username of the assignee.
assigneeUsernames [String!] Usernames of users assigned to the merge request.
assigneeWildcardId AssigneeWildcardId Filter by assignee presence. Incompatible with assigneeUsernames and assigneeUsername.
blobPath {{< icon name=”warning-solid” >}} String Introduced 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.
createdAfter Time Merge requests created after the timestamp.
createdBefore Time Merge requests created before the timestamp.
deployedAfter Time Merge requests deployed after the timestamp.
deployedBefore Time Merge requests deployed before the timestamp.
deploymentId String ID of the deployment.
draft Boolean Limit result to draft merge requests.
environmentName String Environment merge requests have been deployed to.
groupId GroupID The global ID of the group the authored merge requests should be in. Merge requests in subgroups are included.
ignoredReviewerUsername {{< icon name=”warning-solid” >}} String Introduced in GitLab 18.0. Status: Experiment. Username of the reviewer to ignore when searching by reviewer state.
iids [String!] Array of IIDs of merge requests, for example [1, 2].
in [IssuableSearchableField!] Specify the fields to perform the search in. Defaults to [TITLE, DESCRIPTION]. Requires the search argument.’.
includeArchived Boolean Merge requests from archived projects.
includeAssigned Boolean Include merge requests the user is assigned to.
labelName [String] Labels applied to the merge request.
labels {{< icon name=”warning-solid” >}} [String!] Deprecated in GitLab 17.1. Use labelName.
mergedAfter Time Merge requests merged after the date.
mergedBefore Time Merge requests merged before the date.
mergedBy String Username of the merger.
milestoneTitle String Title of the milestone. Incompatible with milestoneWildcardId.
milestoneWildcardId MilestoneWildcardId Filter issues by milestone ID wildcard. Incompatible with milestoneTitle.
myReactionEmoji String Filter by your reaction emoji.
not MergeRequestsResolverNegatedParams List of negated arguments. Warning: this argument is experimental and a subject to change in future.
or UnionedMergeRequestFilterInput List of arguments with inclusive OR.
projectId ProjectID The global ID of the project the authored merge requests should be in. Incompatible with projectPath.
projectPath String The full-path of the project the authored merge requests should be in. Incompatible with projectId.
releaseTag String Filter by release tag.
reviewState {{< icon name=”warning-solid” >}} MergeRequestReviewState Introduced in GitLab 17.0. Status: Experiment. Reviewer state of the merge request.
reviewStates {{< icon name=”warning-solid” >}} [MergeRequestReviewState!] Introduced in GitLab 17.0. Status: Experiment. Reviewer states of the merge request.
reviewerUsername String Username of the reviewer.
reviewerWildcardId ReviewerWildcardId Filter by reviewer presence. Incompatible with reviewerUsername.
search String Search query for title or description.
sort MergeRequestSort Sort merge requests by the criteria.
sourceBranches [String!] Array of source branch names. All resolved merge requests will have one of these branches as their source.
state MergeRequestState Merge request state. If provided, all resolved merge requests will have the state.
subscribed SubscriptionStatus Merge requests the current user is subscribed to.
targetBranches [String!] Array of target branch names. All resolved merge requests will have one of these branches as their target.
updatedAfter Time Merge requests updated after the timestamp.
updatedBefore Time Merge requests updated before the timestamp.
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
Name Type Description
includePersonal Boolean Include personal projects.
minAccessLevel AccessLevelEnum Return only projects where current user has at least the specified access level.
programmingLanguageName String Filter projects by programming language name (case insensitive). For example: “css” or “ruby”.
search String Search query.
sort ProjectSort Sort contributed projects.
AutocompletedUser.groups

Groups where the user has access.

Returns GroupConnection.

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

Arguments
Name Type Description
permissionScope GroupPermission Filter by permissions the user has on groups.
search String Search by group name or path.
sort GroupSort Sort groups by given criteria.
AutocompletedUser.mergeRequestInteraction

Merge request state related to the user.

Returns UserMergeRequestInteraction.

Arguments
Name Type Description
id MergeRequestID! Global ID of the merge request.
AutocompletedUser.organizations

Organizations where the user has access.

{{< details >}} Introduced in GitLab 16.6. Status: Experiment. {{< /details >}}

Returns OrganizationConnection.

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

Arguments
Name Type Description
search String Search query, which can be for the organization name or a path.
soloOwned Boolean When 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
Name Type Description
approved Boolean Limit 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.
assigneeUsername String Username of the assignee.
assigneeUsernames [String!] Usernames of users assigned to the merge request.
assigneeWildcardId AssigneeWildcardId Filter by assignee presence. Incompatible with assigneeUsernames and assigneeUsername.
authorUsername String Username of the author.
blobPath {{< icon name=”warning-solid” >}} String Introduced 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.
createdAfter Time Merge requests created after the timestamp.
createdBefore Time Merge requests created before the timestamp.
deployedAfter Time Merge requests deployed after the timestamp.
deployedBefore Time Merge requests deployed before the timestamp.
deploymentId String ID of the deployment.
draft Boolean Limit result to draft merge requests.
environmentName String Environment merge requests have been deployed to.
groupId GroupID The global ID of the group the authored merge requests should be in. Merge requests in subgroups are included.
ignoredReviewerUsername {{< icon name=”warning-solid” >}} String Introduced in GitLab 18.0. Status: Experiment. Username of the reviewer to ignore when searching by reviewer state.
iids [String!] Array of IIDs of merge requests, for example [1, 2].
in [IssuableSearchableField!] Specify the fields to perform the search in. Defaults to [TITLE, DESCRIPTION]. Requires the search argument.’.
includeArchived Boolean Merge requests from archived projects.
labelName [String] Labels applied to the merge request.
labels {{< icon name=”warning-solid” >}} [String!] Deprecated in GitLab 17.1. Use labelName.
mergedAfter Time Merge requests merged after the date.
mergedBefore Time Merge requests merged before the date.
mergedBy String Username of the merger.
milestoneTitle String Title of the milestone. Incompatible with milestoneWildcardId.
milestoneWildcardId MilestoneWildcardId Filter issues by milestone ID wildcard. Incompatible with milestoneTitle.
myReactionEmoji String Filter by your reaction emoji.
not MergeRequestsResolverNegatedParams List of negated arguments. Warning: this argument is experimental and a subject to change in future.
or UnionedMergeRequestFilterInput List of arguments with inclusive OR.
projectId ProjectID The global ID of the project the authored merge requests should be in. Incompatible with projectPath.
projectPath String The full-path of the project the authored merge requests should be in. Incompatible with projectId.
releaseTag String Filter by release tag.
reviewState {{< icon name=”warning-solid” >}} MergeRequestReviewState Introduced in GitLab 17.0. Status: Experiment. Reviewer state of the merge request.
reviewStates {{< icon name=”warning-solid” >}} [MergeRequestReviewState!] Introduced in GitLab 17.0. Status: Experiment. Reviewer states of the merge request.
search String Search query for title or description.
sort MergeRequestSort Sort merge requests by the criteria.
sourceBranches [String!] Array of source branch names. All resolved merge requests will have one of these branches as their source.
state MergeRequestState Merge request state. If provided, all resolved merge requests will have the state.
subscribed SubscriptionStatus Merge requests the current user is subscribed to.
targetBranches [String!] Array of target branch names. All resolved merge requests will have one of these branches as their target.
updatedAfter Time Merge requests updated after the timestamp.
updatedBefore Time Merge requests updated before the timestamp.
AutocompletedUser.savedReply

Saved reply authored by the user.

Returns SavedReply.

Arguments
Name Type Description
id UsersSavedReplyID! ID of a saved reply.
AutocompletedUser.snippets

Snippets authored by the user.

Returns SnippetConnection.

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

Arguments
Name Type Description
ids [SnippetID!] Array of global snippet IDs. For example, gid://gitlab/ProjectSnippet/1.
type TypeEnum Type of snippet.
visibility VisibilityScopesEnum Visibility of the snippet.
AutocompletedUser.starredProjects

Projects starred by the user.

Returns ProjectConnection.

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

Arguments
Name Type Description
minAccessLevel AccessLevelEnum Return only projects where current user has at least the specified access level.
programmingLanguageName String Filter projects by programming language name (case insensitive). For example: “css” or “ruby”.
search String Search query.
sort ProjectSort List starred projects by sort order.
AutocompletedUser.timelogs

Time logged by the user.

Returns TimelogConnection.

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

Arguments
Name Type Description
endDate Time List timelogs within a date range where the logged date is equal to or before endDate.
endTime Time List timelogs within a time range where the logged time is equal to or before endTime.
groupId GroupID List timelogs for a group.
projectId ProjectID List timelogs for a project.
sort TimelogSort List timelogs in a particular order.
startDate Time List timelogs within a date range where the logged date is equal to or after startDate.
startTime Time List timelogs within a time range where the logged time is equal to or after startTime.
username String List timelogs for a user.
AutocompletedUser.todos

To-do items of the user.

Returns TodoConnection.

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

Arguments
Name Type Description
action [TodoActionEnum!] Action to be filtered.
authorId [ID!] ID of an author.
groupId [ID!] ID of a group.
isSnoozed Boolean Whether the to-do item is snoozed.
projectId [ID!] ID of a project.
sort TodoSort Sort todos by given criteria.
state [TodoStateEnum!] State of the todo.
type [TodoTargetEnum!] Type of the todo.
AutocompletedUser.userAchievements

Achievements for the user. Only returns for namespaces where the achievements feature flag is enabled.

{{< details >}} Introduced in GitLab 15.10. Status: Experiment. {{< /details >}}

Returns UserAchievementConnection.

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

Arguments
Name Type Description
includeHidden Boolean Indicates 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
Name Type Description
actualStates [String!] Filter workspaces by actual states.
agentIds [ClustersAgentID!] Filter workspaces by agent GlobalIDs.
ids [RemoteDevelopmentWorkspaceID!] Filter workspaces by workspace GlobalIDs. For example, ["gid://gitlab/RemoteDevelopment::Workspace/1"].
includeActualStates {{< icon name=”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

Name Type Description
description String! Emoji description.
emoji String! Emoji as an icon.
name String! Emoji name.
unicode String! Emoji in Unicode.
unicodeVersion String! Unicode version for the emoji.
user UserCore! User who awarded the emoji.

BaseService

Fields

Name Type Description
active Boolean Indicates if the service is active.
serviceType ServiceType Type of the service.
type String Class name of the service.

Blame

Fields

Name Type Description
firstLine String First line of Git Blame for given range.
groups [Groups!] Git Blame grouped by contiguous lines for commit.

Blob

Fields

Name Type Description
flatPath String! Flat path of the entry.
id ID! ID of the entry.
lfsOid String LFS ID of the blob.
mode String Blob mode in numeric format.
name String! Name of the entry.
path String! Path of the entry.
sha String! SHA of the entry.
type EntryType! Type of tree entry.
webPath String Web path of the blob.
webUrl String Web URL of the blob.

BlobSearch

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

Fields

Name Type Description
fileCount {{< icon name=”warning-solid” >}} Int Introduced in GitLab 17.2. Status: Experiment. Total number of files with matches.
files {{< icon name=”warning-solid” >}} [SearchBlobFileType!] Introduced in GitLab 17.2. Status: Experiment. List of files with matches.
matchCount {{< icon name=”warning-solid” >}} Int Introduced in GitLab 17.2. Status: Experiment. Total number of matches.
perPage {{< icon name=”warning-solid” >}} Int Introduced in GitLab 17.2. Status: Experiment. Total number of files per page.
searchLevel {{< icon name=”warning-solid” >}} SearchLevel Introduced in GitLab 17.2. Status: Experiment. Level of search performed.
searchType {{< icon name=”warning-solid” >}} SearchType Introduced in GitLab 17.2. Status: Experiment. Type of search performed.

BlobViewer

Represents how the blob content should be displayed.

Fields

Name Type Description
collapsed Boolean! Shows whether the blob should be displayed collapsed.
fileType String! Content file type.
loadAsync Boolean! Shows whether the blob content is loaded asynchronously.
loadingPartialName String! Loading partial name.
renderError String Error rendering the blob content.
tooLarge Boolean! Shows whether the blob is too large to be displayed.
type BlobViewersType! Type of blob viewer.

BlockingMergeRequests

Information about the rules that must be satisfied to merge this merge request.

Fields

Name Type Description
hiddenCount Int! Blocking merge requests not visible to the user.
totalCount Int! Total number of blocking merge requests.
visibleMergeRequests [MergeRequest!] Blocking merge requests visible to the user.

Board

Represents a project or group issue board.

Fields

Name Type Description
assignee UserCore Board assignee.
createdAt Time! Timestamp of when the board was created.
hideBacklogList Boolean Whether or not backlog list is hidden.
hideClosedList Boolean Whether or not closed list is hidden.
id ID! ID (global ID) of the board.
iteration Iteration Board iteration.
iterationCadence IterationCadence Board iteration cadence.
labels LabelConnection Labels of the board. (see Connections)
milestone Milestone Board milestone.
name String Name of the board.
updatedAt Time! Timestamp of when the board was last updated.
webPath String! Web path of the board.
webUrl String! Web URL of the board.
weight Int Weight of the board.

Fields with arguments

Board.epics

Epics associated with board issues.

Returns BoardEpicConnection.

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

Arguments
Name Type Description
issueFilters BoardIssueInput Filters applied when selecting issues on the board.
Board.lists

Lists of the board.

Returns BoardListConnection.

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

Arguments
Name Type Description
id ListID Find a list by its global ID.
issueFilters BoardIssueInput Filters applied when getting issue metadata in the board list.

BoardEpic

Represents an epic on an issue board.

Fields

Name Type Description
author UserCore! Author of the epic.
awardEmoji AwardEmojiConnection List of emoji reactions associated with the epic. (see Connections)
blocked Boolean Indicates the epic is blocked.
blockedByCount Int Count of epics blocking the epic.
blockedByEpics EpicConnection Epics blocking the epic. (see Connections)
blockingCount Int Count of epics that the epic is blocking.
closedAt Time Timestamp of when the epic was closed.
color String Color of the epic.
commenters UserCoreConnection! All commenters on the noteable. (see Connections)
confidential Boolean Indicates if the epic is confidential.
createdAt Time Timestamp of when the epic was created.
defaultProjectForIssueCreation Project Default Project for issue creation. Based on the project the user created the last issue in.
descendantCounts EpicDescendantCount Number of open and closed descendant epics and issues.
descendantWeightSum EpicDescendantWeights Total weight of open and closed issues in the epic and its descendants.
description String Description of the epic.
descriptionHtml String GitLab Flavored Markdown rendering of description.
discussions DiscussionConnection! All discussions on the noteable. (see Connections)
downvotes Int! Number of downvotes the epic has received.
dueDate Time Due date of the epic.
dueDateFixed Time Fixed due date of the epic.
dueDateFromInheritedSource Time Inherited due date of the epic from child epics or milestones.
dueDateFromMilestones Time Inherited due date of the epic from milestones.
dueDateIsFixed Boolean Indicates if the due date has been manually set.
events EventConnection List of events associated with the object. (see Connections)
group Group! Group to which the epic belongs.
hasChildren Boolean! Indicates if the epic has children.
hasChildrenWithinTimeframe Boolean! Indicates if the epic has children in the specified timeframe.
hasIssues Boolean! Indicates if the epic has direct issues.
hasParent Boolean! Indicates if the epic has a parent epic.
healthStatus EpicHealthStatus Current health status of the epic.
id ID! ID of the epic.
iid String! Internal ID of the epic.
issues EpicIssueConnection A list of issues associated with the epic. (see Connections)
labels LabelConnection Labels assigned to the epic. (see Connections)
name String Name or title of the object.
parent Epic Parent epic of the epic.
participants UserCoreConnection List of participants for the epic. (see Connections)
relationPath String URI path of the epic-issue relationship.
relativePosition Int Relative position of the epic in the epic tree.
startDate Time Start date of the epic.
startDateFixed Time Fixed start date of the epic.
startDateFromInheritedSource Time Inherited start date of the epic from child epics or milestones.
startDateFromMilestones Time Inherited start date of the epic from milestones.
startDateIsFixed Boolean Indicates if the start date has been manually set.
state EpicState! State of the epic.
subscribed Boolean! Indicates the currently logged in user is subscribed to the epic.
textColor String Text color generated for the epic.
title String Title of the epic.
titleHtml String GitLab Flavored Markdown rendering of title.
updatedAt Time Timestamp of when the epic was updated.
upvotes Int! Number of upvotes the epic has received.
userDiscussionsCount Int! Number of user discussions in the epic.
userNotesCount Int! Number of user notes of the epic.
userPermissions EpicPermissions! Permissions for the current user on the resource.
userPreferences BoardEpicUserPreferences User preferences for the epic on the issue board.
webPath String! Web path of the epic.
webUrl String! Web URL of the epic.

Fields with arguments

BoardEpic.ancestors

Ancestors (parents) of the epic.

Returns EpicConnection.

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

Arguments
Name Type Description
authorUsername String Filter epics by author.
confidential Boolean Filter epics by given confidentiality.
createdAfter Time Epics created after the date.
createdBefore Time Epics created before the date.
customField {{< icon name=”warning-solid” >}} [WorkItemWidgetCustomFieldFilterInputType!] Introduced in GitLab 17.10. Status: Experiment. Filter by custom fields.
iid ID IID of the epic, e.g., “1”.
iidStartsWith String Filter epics by IID for autocomplete.
iids [ID!] List of IIDs of epics, e.g., [1, 2].
in [IssuableSearchableField!] Specify the fields to perform the search in. Defaults to [TITLE, DESCRIPTION]. Requires the search argument.’.
includeAncestorGroups Boolean Include epics from ancestor groups.
includeDescendantGroups Boolean Include epics from descendant groups.
labelName [String!] Filter epics by labels.
milestoneTitle String Filter epics by milestone title, computed from epic’s issues.
myReactionEmoji String Filter by reaction emoji applied by the current user.
not NegatedEpicFilterInput Negated epic arguments.
or UnionedEpicFilterInput List of arguments with inclusive OR.
search String Search query for title or description.
sort EpicSort List epics by sort order.
state EpicState Filter epics by state.
subscribed SubscriptionStatus Epics the current user is subscribed to.
timeframe Timeframe List items overlapping the given timeframe.
topLevelHierarchyOnly Boolean Filter epics with a top-level hierarchy.
updatedAfter Time Epics updated after the date.
updatedBefore Time Epics updated before the date.
BoardEpic.children

Children (sub-epics) of the epic.

Returns EpicConnection.

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

Arguments
Name Type Description
authorUsername String Filter epics by author.
confidential Boolean Filter epics by given confidentiality.
createdAfter Time Epics created after the date.
createdBefore Time Epics created before the date.
customField {{< icon name=”warning-solid” >}} [WorkItemWidgetCustomFieldFilterInputType!] Introduced in GitLab 17.10. Status: Experiment. Filter by custom fields.
iid ID IID of the epic, e.g., “1”.
iidStartsWith String Filter epics by IID for autocomplete.
iids [ID!] List of IIDs of epics, e.g., [1, 2].
in [IssuableSearchableField!] Specify the fields to perform the search in. Defaults to [TITLE, DESCRIPTION]. Requires the search argument.’.
includeAncestorGroups Boolean Include child epics from ancestor groups.
includeDescendantGroups Boolean Include epics from descendant groups.
labelName [String!] Filter epics by labels.
milestoneTitle String Filter epics by milestone title, computed from epic’s issues.
myReactionEmoji String Filter by reaction emoji applied by the current user.
not NegatedEpicFilterInput Negated epic arguments.
or UnionedEpicFilterInput List of arguments with inclusive OR.
search String Search query for title or description.
sort EpicSort List epics by sort order.
state EpicState Filter epics by state.
subscribed SubscriptionStatus Epics the current user is subscribed to.
timeframe Timeframe List items overlapping the given timeframe.
topLevelHierarchyOnly Boolean Filter epics with a top-level hierarchy.
updatedAfter Time Epics updated after the date.
updatedBefore Time Epics updated before the date.
BoardEpic.currentUserTodos

To-do items for the current user.

Returns TodoConnection!.

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

Arguments
Name Type Description
state TodoStateEnum State of the to-do items.
BoardEpic.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
Name Type Description
filter WorkItemRelatedLinkType Filter 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
Name Type Description
filter NotesFilterType Type of notes collection: ALL_NOTES, ONLY_COMMENTS, ONLY_ACTIVITY.
BoardEpic.reference

Internal reference of the epic. Returned in shortened format by default.

Returns String!.

Arguments
Name Type Description
full Boolean Indicates if the reference should be returned in full.

BoardEpicUserPreferences

Represents user preferences for a board epic.

Fields

Name Type Description
collapsed Boolean! Indicates epic should be displayed as collapsed.

BoardList

Represents a list for an issue board.

Fields

Name Type Description
assignee UserCore Assignee in the list.
collapsed Boolean Indicates if the list is collapsed for the user.
id ID! ID (global ID) of the list.
issuesCount Int Count of issues in the list.
iteration Iteration Iteration of the list.
label Label Label of the list.
limitMetric ListLimitMetric Current limit metric for the list.
listType String! Type of the list.
maxIssueCount Int Maximum number of issues in the list.
maxIssueWeight Int Maximum weight of issues in the list.
milestone Milestone Milestone of the list.
position Int Position of list within the board.
title String! Title of the list.
totalIssueWeight BigInt Total weight of all issues in the list, encoded as a string.

Fields with arguments

BoardList.issues

Board issues.

Returns IssueConnection.

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

Arguments
Name Type Description
filters BoardIssueInput Filters applied when selecting issues in the board list.

BooleanExpression

an expression with a boolean value.

Fields

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

Branch

Fields

Name Type Description
commit Commit Commit for the branch.
name String! Name of the branch.

BranchProtection

Branch protection details for a branch rule.

Fields

Name Type Description
allowForcePush Boolean! Toggle force push to the branch for users with write access.
codeOwnerApprovalRequired Boolean! Enforce code owner approvals before allowing a merge.
mergeAccessLevels MergeAccessLevelConnection Details about who can merge when the branch is the source branch. (see Connections)
pushAccessLevels PushAccessLevelConnection Details about who can push when the branch is the source branch. (see Connections)
unprotectAccessLevels UnprotectAccessLevelConnection Details about who can unprotect the branch. (see Connections)

BranchRule

Branch rules configured for a rule target.

Fields

Name Type Description
approvalRules ApprovalProjectRuleConnection Merge request approval rules configured for the branch rule. (see Connections)
branchProtection BranchProtection Branch protections configured for the branch rule.
createdAt Time Timestamp of when the branch rule was created.
externalStatusChecks ExternalStatusCheckConnection External status checks configured for the branch rule. (see Connections)
id ProjectsBranchRuleID ID of the branch rule.
isDefault Boolean! Check if the branch rule protects the project’s default branch.
isProtected Boolean! Check if the branch rule protects access for the branch.
matchingBranchesCount Int! Number of existing branches that match the branch rule.
name String! Name of the branch rule target. Includes wildcards.
squashOption {{< icon name=”warning-solid” >}} SquashOption Introduced in GitLab 17.9. Status: Experiment. Default behavior for squashing in merge requests.
updatedAt Time Timestamp of when the branch rule was last updated.

BurnupChartDailyTotals

Represents the total number of issues and their weights for a particular day.

Fields

Name Type Description
completedCount Int! Number of closed issues as of the day.
completedWeight Int! Total weight of closed issues as of the day.
date ISO8601Date! Date for burnup totals.
scopeCount Int! Number of issues as of the day.
scopeWeight Int! Total weight of issues as of the day.

CarPermissions

Check user’s permission for the car.

Fields

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

CiApplicationSettings

Fields

Name Type Description
keepLatestArtifact Boolean Whether to keep the latest jobs artifacts.

CiBuildNeed

Fields

Name Type Description
id ID! ID of the BuildNeed.
name String Name of the job we need to complete.

CiCatalogResource

Fields

Name Type Description
description String Description of the catalog resource.
fullPath {{< icon name=”warning-solid” >}} ID Introduced in GitLab 16.11. Status: Experiment. Full project path of the catalog resource.
icon String Icon for the catalog resource.
id ID! ID of the catalog resource.
last30DayUsageCount {{< icon name=”warning-solid” >}} Int! 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 {{< icon name=”warning-solid” >}} Time Introduced in GitLab 16.5. Status: Experiment. Release date of the catalog resource’s latest version.
name String Name of the catalog resource.
starCount Int! Number of times the catalog resource has been starred.
starrersPath String Relative path to the starrers page for the catalog resource project.
topics [String!] Topics for the catalog resource.
verificationLevel CiCatalogResourceVerificationLevel Verification level of the catalog resource.
visibilityLevel VisibilityLevelsEnum Visibility level of the catalog resource.
webPath {{< icon name=”warning-solid” >}} String Introduced 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
Name Type Description
name String Name of the version.

CiCatalogResourceComponent

Fields

Name Type Description
id CiCatalogResourcesComponentID! ID of the component.
includePath String Path used to include the component.
inputs [CiInputsSpec!] Inputs for the component.
name String Name of the component.

CiCatalogResourceComponentUsage

Represents a component usage in a project.

Fields

Name Type Description
lastUsedDate ISO8601Date When the component was last used.
name String Name of the component.
version String Version of the component.

CiCatalogResourceVersion

Fields

Name Type Description
author UserCore User that created the version.
commit Commit Commit associated with the version.
components CiCatalogResourceComponentConnection Components belonging to the catalog resource. (see Connections)
createdAt Time Timestamp of when the version was created.
id CiCatalogResourcesVersionID! Global ID of the version.
name String Name that uniquely identifies the version within the catalog resource.
path String Relative web path to the version.
readme String Readme data.
readmeHtml String GitLab Flavored Markdown rendering of readme.
releasedAt {{< icon name=”warning-solid” >}} Time Introduced in GitLab 16.7. Status: Experiment. Timestamp of when the version was released.

CiCdSettings

Fields

Name Type Description
pipelineVariablesDefaultRole String Indicates the default minimum role required to override pipeline variables in the namespace.

CiConfig

Fields

Name Type Description
errors [String!] Linting errors.
includes [CiConfigInclude!] List of included files.
mergedYaml String Merged CI configuration YAML.
stages CiConfigStageConnection Stages of the pipeline. (see Connections)
status CiConfigStatus Status of linting, can be either valid or invalid.
warnings [String!] Linting warnings.

CiConfigGroup

Fields

Name Type Description
jobs CiConfigJobConnection Jobs in group. (see Connections)
name String Name of the job group.
size Int Size of the job group.

CiConfigInclude

Fields

Name Type Description
blob String File blob location. It can be masked if it contains masked variables. For example, "https://gitlab.com/gitlab-org/gitlab/-/blob/e52d6d0246d7375291850e61f0abc101fbda9dc2/.gitlab/ci/build-images.gitlab-ci.yml".
contextProject String Current project scope, e.g., “gitlab-org/gitlab”.
contextSha String Current sha scope.
extra JSON Extra information for the include, which can contain job_name, project, and ref. Values can be masked if they contain masked variables.
location String File location. It can be masked if it contains masked variables. For example, ".gitlab/ci/build-images.gitlab-ci.yml".
raw String File raw location. It can be masked if it contains masked variables. For example, "https://gitlab.com/gitlab-org/gitlab/-/raw/e52d6d0246d7375291850e61f0abc101fbda9dc2/.gitlab/ci/build-images.gitlab-ci.yml".
type CiConfigIncludeType Include type.

CiConfigJob

Fields

Name Type Description
afterScript [String!] Override a set of commands that are executed after the job.
allowFailure Boolean Allow job to fail.
beforeScript [String!] Override a set of commands that are executed before the job.
environment String Name of an environment to which the job deploys.
except CiConfigJobRestriction Limit when jobs are not created.
groupName String Name of the job group.
name String Name of the job.
needs CiConfigNeedConnection Builds that must complete before the jobs run. (see Connections)
only CiConfigJobRestriction Jobs are created when these conditions do not apply.
script [String!] Shell script that is executed by a runner.
stage String Name of the job stage.
tags [String!] List of tags that are used to select a runner.
when String When to run the job.

CiConfigJobRestriction

Fields

Name Type Description
refs [String!] Git refs the job restriction applies to.

CiConfigNeed

Fields

Name Type Description
name String Name of the need.

CiConfigStage

Fields

Name Type Description
groups CiConfigGroupConnection Groups of jobs for the stage. (see Connections)
name String Name of the stage.

CiConfigVariable

CI/CD config variables.

Fields

Name Type Description
description String Description for the CI/CD config variable.
key String Name of the variable.
value String Value of the variable.
valueOptions [String!] Value options for the variable.

CiDedicatedHostedRunnerFilters

Filter options available for GitLab Dedicated runner usage data.

Fields

Name Type Description
deletedRunners CiDeletedRunnerConnection List of runner IDs from usage data without associated runner records. (see Connections)
runners CiRunnerConnection List of unique runners with usage data. (see Connections)
years [Int!] List of years with available usage data.

CiDedicatedHostedRunnerUsage

Compute usage data for hosted runners on GitLab Dedicated.

Fields

Name Type Description
billingMonth String! Month of the usage data.
billingMonthIso8601 ISO8601Date! Timestamp of the billing month in ISO 8601 format.
computeMinutes Int! Total compute minutes used across all namespaces.
durationSeconds Int! Total duration in seconds of runner usage.
rootNamespace NamespaceUnion Namespace associated with the usage data. Null for instance aggregate data.

CiDeletedNamespace

Reference to a namespace that no longer exists.

Fields

Name Type Description
id NamespaceID ID of the deleted namespace.

CiDeletedRunner

Reference to a deleted runner.

Fields

Name Type Description
id CiRunnerID! Global ID of the deleted runner.

CiDurationStatistics

Histogram of durations for a group of CI/CD jobs or pipelines.

Fields

Name Type Description
p50 {{< icon name=”warning-solid” >}} Duration Introduced in GitLab 15.8. Status: Experiment. 50th percentile. 50% of the durations are lower than this value.
p75 {{< icon name=”warning-solid” >}} Duration Introduced in GitLab 15.8. Status: Experiment. 75th percentile. 75% of the durations are lower than this value.
p90 {{< icon name=”warning-solid” >}} Duration Introduced in GitLab 15.8. Status: Experiment. 90th percentile. 90% of the durations are lower than this value.
p95 {{< icon name=”warning-solid” >}} Duration Introduced in GitLab 15.8. Status: Experiment. 95th percentile. 95% of the durations are lower than this value.
p99 {{< icon name=”warning-solid” >}} Duration Introduced 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

Name Type Description
cronTimezone String Time zone for the cron fields, defaults to UTC if not provided.
endCron String! End of the freeze period in cron format.
endTime Time Timestamp (UTC) of when the current/next active period ends.
startCron String! Start of the freeze period in cron format.
startTime Time Timestamp (UTC) of when the current/next active period starts.
status CiFreezePeriodStatus! Freeze period status.

CiGroup

Fields

Name Type Description
detailedStatus DetailedStatus Detailed status of the group.
id String! ID for a group.
jobs CiJobConnection Jobs in group. (see Connections)
name String Name of the job group.
size Int Size of the group.

CiGroupEnvironmentScope

CI/CD environment scope for a group.

Fields

Name Type Description
name String Scope name defininig the enviromnments that can use the variable.

CiGroupVariable

CI/CD variables for a group.

Fields

Name Type Description
description String Description of the variable.
environmentScope String Scope defining the environments that can use the variable.
hidden Boolean Indicates whether the variable is hidden.
id ID! ID of the variable.
key String Name of the variable.
masked Boolean Indicates whether the variable is masked.
protected Boolean Indicates whether the variable is protected.
raw Boolean Indicates whether the variable is raw.
value String Value of the variable.
variableType CiVariableType Type of the variable.

CiInputsField

CI input saved for a pipeline schedule.

Fields

Name Type Description
name String! Name of the input.
value CiInputsValue Value of the input.

CiInputsSpec

Input for pipeline creation.

Fields

Name Type Description
default CiInputsValue Default value for the input, if provided.
description String Description of the input.
name String! Name of the input.
options CiInputsValue Possible values that the input can take, if provided.
regex String Regular expression pattern that the input value must match if provided.
required Boolean! Indicates whether the input is required.
type CiInputsType! Input data type.

CiInstanceVariable

CI/CD variables for a GitLab instance.

Fields

Name Type Description
description String Description of the variable.
environmentScope {{< icon name=”warning-solid” >}} String Deprecated in GitLab 15.3. No longer used, only available for GroupVariableType and ProjectVariableType.
id ID! ID of the variable.
key String Name of the variable.
masked Boolean Indicates whether the variable is masked.
protected Boolean Indicates whether the variable is protected.
raw Boolean Indicates whether the variable is raw.
value String Value of the variable.
variableType CiVariableType Type of the variable.

CiJob

Fields

Name Type Description
active Boolean! Indicates the job is active.
allowFailure Boolean! Whether the job is allowed to fail.
artifacts CiJobArtifactConnection Artifacts generated by the job. (see Connections)
browseArtifactsPath String URL for browsing the artifact’s archive.
canPlayJob Boolean! Indicates whether the current user can play the job.
cancelable Boolean! Indicates the job can be canceled.
commitPath String Path to the commit that triggered the job.
coverage Float Coverage level of the job.
createdAt Time! When the job was created.
createdByTag Boolean! Whether the job was created by a tag.
detailedStatus DetailedStatus Detailed status of the job.
downstreamPipeline Pipeline Downstream pipeline for a bridge.
duration Int Duration of the job in seconds.
erasedAt Time When the job was erased.
exitCode Int Exit code of the job. Available for jobs that started after upgrading to GitLab 16.10 and failed with an exit code.
failureMessage String Message on why the job failed.
finishedAt Time When a job has finished running.
id JobID ID of the job.
kind CiJobKind! Indicates the type of job.
manualJob Boolean Whether the job has a manual action.
manualVariables CiManualVariableConnection Variables added to a manual job when the job is triggered. (see Connections)
name String Name of the job.
needs CiBuildNeedConnection References to builds that must complete before the jobs run. (see Connections)
pipeline PipelineInterface Pipeline the job belongs to.
playPath String Play path of the job.
playable Boolean! Indicates the job can be played.
previousStageJobs CiJobConnection Jobs from the previous stage. (see Connections)
previousStageJobsOrNeeds {{< icon name=”warning-solid” >}} JobNeedUnionConnection Deprecated in GitLab 16.4. Replaced by previousStageJobs and needs fields.
project Project Project that the job belongs to.
queuedAt Time When the job was enqueued and marked as pending.
queuedDuration Duration How long the job was enqueued before starting.
refName String Ref name of the job.
refPath String Path to the ref.
retried Boolean Indicates that the job has been retried.
retryable Boolean! Indicates the job can be retried.
runner CiRunner Runner assigned to execute the job.
runnerManager CiRunnerManager Runner manager assigned to the job.
scheduled Boolean! Indicates the job is scheduled.
scheduledAt Time Schedule for the build.
schedulingType String Type of job scheduling. Value is dag if the job uses the needs keyword, and stage otherwise.
shortSha String! Short SHA1 ID of the commit.
source String Policy or action that initiated the job. If not set, the value is inherited from the pipeline.
stage CiStage Stage of the job.
startedAt Time When the job was started.
status CiJobStatus Status of the job.
stuck Boolean! Indicates the job is stuck.
tags [String!] Tags for the current job.
trace CiJobTrace Trace generated by the job.
triggered Boolean Whether the job was triggered.
userPermissions JobPermissions! Permissions for the current user on the resource.
webPath String Web path of the job.

CiJobArtifact

Fields

Name Type Description
downloadPath String URL for downloading the artifact’s file.
expireAt Time Expiry date of the artifact.
fileType JobArtifactFileType File type of the artifact.
id CiJobArtifactID! ID of the artifact.
name String File name of the artifact.
size BigInt! Size of the artifact in bytes.

CiJobMinimalAccess

Fields

Name Type Description
active Boolean! Indicates the job is active.
allowFailure Boolean! Whether the job is allowed to fail.
artifacts CiJobArtifactConnection Artifacts generated by the job. (see Connections)
browseArtifactsPath String URL for browsing the artifact’s archive.
canPlayJob Boolean Indicates whether the current user can play the job.
cancelable Boolean Indicates the job can be canceled.
commitPath String Path to the commit that triggered the job.
coverage Float Coverage level of the job.
createdAt Time When the job was created.
createdByTag Boolean! Whether the job was created by a tag.
detailedStatus DetailedStatus Detailed status of the job.
duration Int Duration of the job in seconds.
erasedAt Time When the job was erased.
exitCode Int Exit code of the job. Available for jobs that started after upgrading to GitLab 16.10 and failed with an exit code.
failureMessage String Message on why the job failed.
finishedAt Time When a job has finished running.
id JobID ID of the job.
kind CiJobKind Indicates the type of job.
manualJob Boolean Whether the job has a manual action.
name String Name of the job.
pipeline PipelineInterface Pipeline the job belongs to.
playPath String Play path of the job.
playable Boolean Indicates the job can be played.
project ProjectInterface Project that the job belongs to.
queuedAt Time When the job was enqueued and marked as pending.
queuedDuration Duration How long the job was enqueued before starting.
refName String Ref name of the job.
refPath String Path to the ref.
retried Boolean Indicates that the job has been retried.
retryable Boolean Indicates the job can be retried.
runner CiRunner Runner assigned to execute the job.
scheduled Boolean Indicates the job is scheduled.
scheduledAt Time Schedule for the build.
schedulingType String Type of job scheduling. Value is dag if the job uses the needs keyword, and stage otherwise.
shortSha String! Short SHA1 ID of the commit.
source String Policy or action that initiated the job. If not set, the value is inherited from the pipeline.
stage CiStage Stage of the job.
startedAt Time When the job was started.
status CiJobStatus Status of the job.
stuck Boolean! Indicates the job is stuck.
tags [String!] Tags for the current job.
trace CiJobTrace Trace generated by the job.
triggered Boolean Whether the job was triggered.
userPermissions JobPermissions Permissions for the current user on the job.
webPath String Web path of the job.

CiJobTokenAccessibleGroup

Group that can access the current project by authenticating with a CI/CD job token.

Fields

Name Type Description
avatarUrl String Avatar URL of the group.
fullPath ID! Full path of the group.
id ID! ID of the group.
name String! Name of the group.
path String! Path of the group.
webUrl String Web URL of the group.

CiJobTokenAccessibleProject

Project that can access the current project by authenticating with a CI/CD job token.

Fields

Name Type Description
avatarUrl String URL to avatar image file of the project.
fullPath ID! Full path of the project.
id ID! ID of the project.
name String! Name of the project (without namespace).
path String! Path of the project.
webUrl String Web URL of the project.

CiJobTokenAuthLog

Fields

Name Type Description
lastAuthorizedAt {{< icon name=”warning-solid” >}} Time! Introduced in GitLab 17.6. Status: Experiment. Last authorization date time.
originProject {{< icon name=”warning-solid” >}} CiJobTokenAccessibleProject! Introduced in GitLab 17.6. Status: Experiment. Origin project.

CiJobTokenScopeAllowlist

Fields

Name Type Description
groupsAllowlist CiJobTokenScopeAllowlistEntryConnection Allowlist of groups that can access the current project by authenticating with a CI/CD job token. (see Connections)
projectsAllowlist CiJobTokenScopeAllowlistEntryConnection Allowlist 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

Name Type Description
addedBy UserCore User that added the entry.
autopopulated Boolean Indicates whether the entry is created by the autopopulation process.
createdAt Time! When the entry was created.
defaultPermissions Boolean Indicates whether default permissions are enabled (true) or fine-grained permissions are enabled (false).
direction {{< icon name=”warning-solid” >}} String Deprecated in GitLab 18.0. Outbound job token scope is being removed. This field can only be INBOUND.
jobTokenPolicies {{< icon name=”warning-solid” >}} [CiJobTokenScopePolicies!] Introduced in GitLab 17.5. Status: Experiment. List of policies for the entry.
sourceProject Project! Project that owns the allowlist entry.
target CiJobTokenScopeTarget Group or project allowed by the entry.

CiJobTokenScopeType

Fields

Name Type Description
groupAllowlistAutopopulatedIds [GroupID!]! List of IDs of groups which have been created by the autopopulation process.
groupsAllowlist CiJobTokenAccessibleGroupConnection! Allowlist of groups that can access the current project by authenticating with a CI/CD job token. (see Connections)
groupsAllowlistCount Int! Count of groups that can access the current project by authenticating with a CI/CD job token. The count does not include subgroups.
inboundAllowlist CiJobTokenAccessibleProjectConnection! Allowlist of projects that can access the current project by authenticating with a CI/CD job token. (see Connections)
inboundAllowlistAutopopulatedIds [ProjectID!]! List of IDs of projects which have been created by the autopopulation process.
inboundAllowlistCount Int! Count of projects that can access the current project by authenticating with a CI/CD job token. The count does not include nested projects.
outboundAllowlist {{< icon name=”warning-solid” >}} ProjectConnection! Deprecated in GitLab 18.0. Outbound job token scope is being removed. Only inbound allowlist is supported.
projects {{< icon name=”warning-solid” >}} ProjectConnection! 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.

{{< details >}} Introduced in GitLab 15.11. Status: Experiment. {{< /details >}}

Returns String!.

Arguments
Name Type Description
lastLines Int Number of tail lines to return, up to a maximum of 100 lines.

CiJobsStatistics

Statistics for a group of CI jobs.

Fields

Name Type Description
queuedDuration CiDurationStatistics Statistics for the amount of time that jobs were waiting to be picked up. The calculation is based on the 100 most recent jobs run by the 5000 most recently created runners in context. If no filter is applied to runners, the calculation uses the 100 most recent jobs globally.

CiManualVariable

CI/CD variables given to a manual job.

Fields

Name Type Description
environmentScope {{< icon name=”warning-solid” >}} String Deprecated in GitLab 15.3. No longer used, only available for GroupVariableType and ProjectVariableType.
id ID! ID of the variable.
key String Name of the variable.
raw Boolean Indicates whether the variable is raw.
value String Value of the variable.
variableType CiVariableType Type of the variable.

CiMinutesNamespaceMonthlyUsage

Fields

Name Type Description
minutes Int Total number of compute minutes used by all projects in the namespace.
month String Month related to the usage data.
monthIso8601 ISO8601Date Month related to the usage data in ISO 8601 date format.
projects CiMinutesProjectMonthlyUsageConnection Compute usage data for projects in the namespace. (see Connections)
sharedRunnersDuration Int Total duration (in seconds) of shared runners use by the namespace for the month.

CiMinutesProjectMonthlyUsage

Fields

Name Type Description
minutes Int Number of compute minutes used by the project in the month.
project Project Project having the recorded usage.
sharedRunnersDuration Int Total duration (in seconds) of shared runners use by the project for the month.

CiPipelineCreationRequest

Information about an asynchronous pipeline creation request.

Fields

Name Type Description
error String Error message if pipeline creation failed.
pipelineId CiPipelineID ID of the created pipeline if creation was successful.
status CiPipelineCreationStatus! Current status of the pipeline creation.

CiProjectSubscription

Fields

Name Type Description
author UserCore Author of the subscription.
downstreamProject CiSubscriptionsProjectDetails Downstream project of the subscription.When an upstream project’s pipeline completes, a pipeline is triggered in the downstream project.
id CiSubscriptionsProjectID Global ID of the subscription.
upstreamProject CiSubscriptionsProjectDetails Upstream project of the subscription.When an upstream project’s pipeline completes, a pipeline is triggered in the downstream project.

CiProjectVariable

CI/CD variables for a project.

Fields

Name Type Description
description String Description of the variable.
environmentScope String Scope defining the environments that can use the variable.
hidden Boolean Indicates whether the variable is hidden.
id ID! ID of the variable.
key String Name of the variable.
masked Boolean Indicates whether the variable is masked.
protected Boolean Indicates whether the variable is protected.
raw Boolean Indicates whether the variable is raw.
value String Value of the variable.
variableType CiVariableType Type of the variable.

CiRunner

Fields

Name Type Description
accessLevel CiRunnerAccessLevel! Access level of the runner.
active {{< icon name=”warning-solid” >}} Boolean! Deprecated in GitLab 14.8. Use paused.
adminUrl String Admin URL of the runner. Only available for administrators.
contactedAt Time Timestamp of last contact from the runner.
createdAt Time Timestamp of creation of the runner.
createdBy UserCore User that created the runner.
creationMethod {{< icon name=”warning-solid” >}} CiRunnerCreationMethod Introduced in GitLab 17.0. Status: Experiment. Type of runner registration.
creationState {{< icon name=”warning-solid” >}} CiRunnerCreationState Introduced in GitLab 17.11. Status: Experiment. Runner creation state. Used to determine if a runner has been registered and has contacted the GitLab instance.
description String Description of the runner.
editAdminUrl String Admin form URL of the runner. Only available for administrators.
ephemeralAuthenticationToken {{< icon name=”warning-solid” >}} String Introduced 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 {{< icon name=”warning-solid” >}} String Introduced 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.
groups GroupInterfaceConnection Groups the runner is associated with. For group runners only. (see Connections)
id CiRunnerID! ID of the runner.
jobExecutionStatus {{< icon name=”warning-solid” >}} CiRunnerJobExecutionStatus Introduced in GitLab 15.7. Status: Experiment. Job execution status of the runner.
locked Boolean Indicates the runner is locked.
maintenanceNote String Runner’s maintenance notes.
maintenanceNoteHtml String GitLab Flavored Markdown rendering of maintenance_note.
maximumTimeout Int Maximum timeout (in seconds) for jobs processed by the runner.
ownerProject ProjectInterface Project that owns the runner. For project runners only.
paused Boolean! Indicates the runner is paused and not available to run jobs.
privateProjectsMinutesCostFactor Float Private projects’ “compute cost factor” associated with the runner (GitLab.com only).
projectCount Int Number of projects that the runner is associated with.
publicProjectsMinutesCostFactor Float Public projects’ “compute cost factor” associated with the runner (GitLab.com only).
registerAdminUrl String URL of the temporary registration page of the runner. Only available before the runner is registered. Only available for administrators.
runUntagged Boolean! Indicates the runner is able to run untagged jobs.
runnerType CiRunnerType! Type of the runner.
shortSha String First eight characters of the runner’s token used to authenticate new job requests. Used as the runner’s unique ID.
status CiRunnerStatus! Status of the runner.
tagList [String!] Tags associated with the runner.
tokenExpiresAt Time Runner token expiration time.
upgradeStatus CiRunnerUpgradeStatus Availability of upgrades for the runner.
userPermissions RunnerPermissions! 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
Name Type Description
statuses {{< icon name=”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 CiJobInterfaceConnection.

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

Arguments
Name Type Description
statuses [CiJobStatus!] Filter jobs by status.
CiRunner.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
Name Type Description
status CiRunnerStatus Filter runner managers by status.
systemId String Filter 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
Name Type Description
membership Boolean Return only projects that the current user is a member of.
personal Boolean Return only personal projects.
search String Search query, which can be for the project name, a path, or a description.
searchNamespaces Boolean Include namespace in project search.
sort String Sort order of results. Format: <field_name>_<sort_direction>, for example: id_desc or name_asc.
topics [String!] Filter projects by topics.

CiRunnerCloudProvisioningStep

Step used to provision the runner to Google Cloud.

Fields

Name Type Description
instructions String Instructions to provision the runner.
languageIdentifier String Identifier of the language used for the instructions field. This identifier can be any of the identifiers specified in the list of supported languages and lexers.
title String Title of the step.

CiRunnerGkeProvisioning

Information used for GKE runner provisioning.

Fields

Name Type Description
projectSetupShellScript String Instructions for setting up a Google Cloud project.

Fields with arguments

CiRunnerGkeProvisioning.provisioningSteps

Steps used to provision a runner in GKE.

Returns [CiRunnerGkeProvisioningStep!].

Arguments
Name Type Description
nodePools [GoogleCloudNodePool!] Configuration for the node pools of the runner.
region GoogleCloudRegion! Name of the region to provision the runner in.
runnerToken String! Authentication token of the runner.
zone GoogleCloudZone! Name of the zone to provision the runner in.

CiRunnerGkeProvisioningStep

Step used to provision the runner to GKE.

Fields

Name Type Description
instructions String Instructions to provision the runner.
languageIdentifier String Identifier of the language used for the instructions field. This identifier can be any of the identifiers specified in the list of supported languages and lexers.
title String Title of the step.

CiRunnerGoogleCloudProvisioning

Information used for runner Google Cloud provisioning.

Fields

Name Type Description
projectSetupShellScript String Instructions for setting up a Google Cloud project.

Fields with arguments

CiRunnerGoogleCloudProvisioning.provisioningSteps

Steps used to provision a runner in the cloud.

Returns [CiRunnerCloudProvisioningStep!].

Arguments
Name Type Description
ephemeralMachineType GoogleCloudMachineType! Name of the machine type to use for running jobs.
region GoogleCloudRegion! Name of the region to provision the runner in.
runnerToken String Authentication token of the runner.
zone GoogleCloudZone! Name of the zone to provision the runner in.

CiRunnerManager

Fields

Name Type Description
architectureName String Architecture provided by the runner manager.
contactedAt Time Timestamp of last contact from the runner manager.
createdAt Time Timestamp of creation of the runner manager.
executorName String Executor last advertised by the runner.
id CiRunnerManagerID! ID of the runner manager.
ipAddress String IP address of the runner manager.
jobExecutionStatus {{< icon name=”warning-solid” >}} CiRunnerJobExecutionStatus Introduced in GitLab 16.3. Status: Experiment. Job execution status of the runner manager.
platformName String Platform provided by the runner manager.
revision String Revision of the runner.
runner CiRunner Runner configuration for the runner manager.
status CiRunnerStatus! Status of the runner manager.
systemId String! System ID associated with the runner manager.
upgradeStatus CiRunnerUpgradeStatus Availability of upgrades for the runner manager.
version String Version of the runner.

CiRunnerUsage

Runner usage in minutes.

Fields

Name Type Description
ciBuildCount BigInt! Amount of builds executed during the selected period. Encoded as a string.
ciDuration BigInt! Number of minutes spent to process jobs during the selected period. Encoded as a string.
ciMinutesUsed {{< icon name=”warning-solid” >}} BigInt! Deprecated in GitLab 17.5. Use ciDuration.
runner CiRunner Runner that the usage refers to. Null means “Other runners”.

CiRunnerUsageByProject

Runner usage in minutes by project.

Fields

Name Type Description
ciBuildCount BigInt! Amount of builds executed during the selected period. Encoded as a string.
ciDuration BigInt! Number of minutes spent to process jobs during the selected period. Encoded as a string.
ciMinutesUsed {{< icon name=”warning-solid” >}} BigInt! Deprecated in GitLab 17.5. Use ciDuration.
project Project Project that the usage refers to. Null means “Other projects”.

CiSecureFileRegistry

Represents the Geo replication and verification state of a ci_secure_file.

Fields

Name Type Description
checksumMismatch Boolean Indicate if the checksums of the CiSecureFileRegistry do not match on the primary and secondary.
ciSecureFileId ID! ID of the Ci Secure File.
createdAt Time Timestamp when the CiSecureFileRegistry was created.
forceToRedownload {{< icon name=”warning-solid” >}} Boolean Deprecated in GitLab 17.10. Removed from registry tables in the database in favor of the newer reusable framework.
id ID! ID of the CiSecureFileRegistry.
lastSyncFailure String Error message during sync of the CiSecureFileRegistry.
lastSyncedAt Time Timestamp of the most recent successful sync of the CiSecureFileRegistry.
missingOnPrimary Boolean Indicate if the CiSecureFileRegistry is missing on primary.
modelRecordId Int ID of the CiSecureFileRegistry’s model record.
retryAt Time Timestamp after which the CiSecureFileRegistry is resynced.
retryCount Int Number of consecutive failed sync attempts of the CiSecureFileRegistry.
state RegistryState Sync state of the CiSecureFileRegistry.
verificationChecksum String The local checksum of the CiSecureFileRegistry.
verificationChecksumMismatched String The expected checksum of the CiSecureFileRegistry in case of mismatch.
verificationFailure String Error message during verification of the CiSecureFileRegistry.
verificationRetryAt Time Timestamp after which the CiSecureFileRegistry is reverified.
verificationRetryCount Int Number of consecutive failed verification attempts of the CiSecureFileRegistry.
verificationStartedAt Time Timestamp when the verification of CiSecureFileRegistry started.
verificationState VerificationStateEnum Verification state of the CiSecureFileRegistry.
verifiedAt Time Timestamp of the most recent successful verification of the CiSecureFileRegistry.

CiStage

Fields

Name Type Description
detailedStatus DetailedStatus Detailed status of the stage.
groups CiGroupConnection Group of jobs for the stage. (see Connections)
id ID! ID of the stage.
jobs CiJobConnection Jobs for the stage. (see Connections)
name String Name of the stage.
status String Status of the pipeline stage.

CiSubscriptionsProject

Fields

Name Type Description
author UserCore Author of the subscription.
downstreamProject Project Downstream project of the subscription.
id CiSubscriptionsProjectID Global ID of the subscription.
upstreamProject Project Upstream project of the subscription.

CiSubscriptionsProjectDetails

Fields

Name Type Description
id ID! ID of the project.
name ID! Full path of the project.
namespace CiSubscriptionsProjectNamespaceDetails! Namespace of the project.
webUrl String Web URL of the project.

CiSubscriptionsProjectNamespaceDetails

Fields

Name Type Description
id ID! ID of the project.
name ID! Full path of the project.

CiTemplate

GitLab CI/CD configuration template.

Fields

Name Type Description
content String! Contents of the CI template.
name String! Name of the CI template.

CloudConnectorProbeResult

Fields

Name Type Description
details JSON Additional details about the probe result.
errors [String!] Full list of errors about the probe result.
message String Additional message or details about the probe result.
name String Name of the probe.
success Boolean Indicates if the probe was successful.

CloudConnectorStatus

Fields

Name Type Description
probeResults [CloudConnectorProbeResult!] Results of individual probes run during verification.
success Boolean Indicates if the setup verification was successful.

ClusterAgent

Fields

Name Type Description
activityEvents ClusterAgentActivityEventConnection Recent activity for the cluster agent. (see Connections)
connections ConnectedAgentConnection Active connections for the cluster agent. (see Connections)
createdAt Time Timestamp the cluster agent was created.
createdByUser UserCore User object, containing information about the person who created the agent.
id ID! ID of the cluster agent.
isReceptive Boolean Whether the cluster agent is receptive or not.
name String Name of the cluster agent.
project Project Project the cluster agent is associated with.
tokens ClusterAgentTokenConnection Tokens associated with the cluster agent. (see Connections)
updatedAt Time Timestamp the cluster agent was updated.
urlConfigurations ClusterAgentUrlConfigurationConnection URL configurations for the cluster agent in case it is a receptive agent. (see Connections)
userAccessAuthorizations ClusterAgentAuthorizationUserAccess User access config for the cluster agent.
vulnerabilityImages VulnerabilityContainerImageConnection Container images reported on the agent vulnerabilities. (see Connections)
webPath String Web path of the cluster agent.
workspacesAgentConfig {{< icon name=”warning-solid” >}} WorkspacesAgentConfig Introduced 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
Name Type Description
actualStates [String!] Filter workspaces by actual states.
ids [RemoteDevelopmentWorkspaceID!] Filter workspaces by workspace GlobalIDs. For example, ["gid://gitlab/RemoteDevelopment::Workspace/1"].
projectIds [ProjectID!] Filter workspaces by project GlobalIDs.

ClusterAgentActivityEvent

Fields

Name Type Description
agentToken ClusterAgentToken Agent token associated with the event.
kind String Type of event.
level String Severity of the event.
recordedAt Time Timestamp the event was recorded.
user UserCore User associated with the event.

ClusterAgentAuthorizationCiAccess

Fields

Name Type Description
agent ClusterAgent Authorized cluster agent.
config JSON Configuration for the authorized project.

ClusterAgentAuthorizationUserAccess

Fields

Name Type Description
agent ClusterAgent Authorized cluster agent.
config JSON Configuration for the authorized project.

ClusterAgentToken

Fields

Name Type Description
clusterAgent ClusterAgent Cluster agent the token is associated with.
createdAt Time Timestamp the token was created.
createdByUser UserCore User who created the token.
description String Description of the token.
id ClustersAgentTokenID! Global ID of the token.
lastUsedAt Time Timestamp the token was last used.
name String Name given to the token.
status AgentTokenStatus Current status of the token.

ClusterAgentUrlConfiguration

Fields

Name Type Description
caCert String CA certificate of the URL configuration. It is used to verify the agent endpoint.
clientCert String Client certificate if JWT authentication is used.
clusterAgent ClusterAgent Cluster agent of the URL configuration.
id ClustersAgentsUrlConfigurationID! Global ID of the URL configuration.
publicKey String Public key if JWT authentication is used.
tlsHost String TLS host of the URL configuration. It is used to verify the server name in the agent endpoint certificate.
url String URL of the URL configuration.

CodeCoverageActivity

Represents the code coverage activity for a group.

Fields

Name Type Description
averageCoverage Float Average percentage of the different code coverage results available for the group.
coverageCount Int Number of different code coverage results available for the group.
date Date! Date when the code coverage was created.
projectCount Int Number of projects with code coverage results for the group.

CodeCoverageSummary

Represents the code coverage summary for a project.

Fields

Name Type Description
averageCoverage Float Average percentage of the different code coverage results available for the project.
coverageCount Int Number of different code coverage results available.
lastUpdatedOn Date Latest date when the code coverage was created for the project.

CodeQualityDegradation

Represents a code quality degradation on the pipeline.

Fields

Name Type Description
description String! Description of the code quality degradation.
engineName String! Code Quality plugin that reported the finding.
fingerprint String! Unique fingerprint to identify the code quality degradation. For example, an MD5 hash.
line Int! Line on which the code quality degradation occurred.
path String! Relative path to the file containing the code quality degradation.
severity CodeQualityDegradationSeverity! Status of the degradation (BLOCKER, CRITICAL, MAJOR, MINOR, INFO, UNKNOWN).
webUrl String URL to the file along with line number.

CodeQualityReportSummary

Code Quality report for a pipeline.

Fields

Name Type Description
blocker Int Total number of blocker status.
count Int Total number of Code Quality reports.
critical Int Total number of critical status.
info Int Total number of info status.
major Int Total number of major status.
minor Int Total number of minor status.
unknown Int Total number of unknown status.

CodeSuggestionEvent

Fields

Name Type Description
event AiUsageCodeSuggestionEvent! Type of the event.
id ID! ID of the code suggestion event.
language String Programming language in the context of the suggestion.
suggestionSize String Size of the code suggestion measured in lines of code.
timestamp Time! When the event happened.
uniqueTrackingId String Unique tracking number of sequence of events for one suggestion.
user UserCore! User associated with the event.

CodequalityReportsComparer

Represents reports comparison for code quality.

Fields

Name Type Description
report CodequalityReportsComparerReport Compared codequality report.
status CodequalityReportsComparerReportGenerationStatus Compared codequality report generation status.

CodequalityReportsComparerReport

Represents compared code quality report.

Fields

Name Type Description
existingErrors [CodequalityReportsComparerReportDegradation!] All code quality degradations.
newErrors [CodequalityReportsComparerReportDegradation!]! New code quality degradations.
resolvedErrors [CodequalityReportsComparerReportDegradation!] Resolved code quality degradations.
status CodequalityReportsComparerStatus! Status of report.
summary CodequalityReportsComparerReportSummary! Codequality report summary.

CodequalityReportsComparerReportDegradation

Represents a degradation on the compared codequality report.

Fields

Name Type Description
description String! Description of the code quality degradation.
engineName String Code quality plugin that reported the degradation.
filePath String! Relative path to the file containing the code quality degradation.
fingerprint String! Unique fingerprint to identify the code quality degradation. For example, an MD5 hash.
line Int! Line on which the code quality degradation occurred.
severity CodeQualityDegradationSeverity! Severity of the code quality degradation (BLOCKER, CRITICAL, MAJOR, MINOR, INFO, UNKNOWN).
webUrl String URL to the file along with line number.

CodequalityReportsComparerReportSummary

Represents a summary of the compared codequality report.

Fields

Name Type Description
errored Int Count of code quality errors.
resolved Int Count of resolved code quality degradations.
total Int Total count of code quality degradations.

Commit

Fields

Name Type Description
author UserCore Author of the commit.
authorEmail String Commit author’s email.
authorGravatar String Commit authors gravatar.
authorName String Commit authors name.
authoredDate Time Timestamp of when the commit was authored.
committedDate Time Timestamp of when the commit was committed.
committerEmail String Email of the committer.
committerName String Name of the committer.
description String Description of the commit message.
descriptionHtml String GitLab Flavored Markdown rendering of description.
diffs [Diff!] Diffs contained within the commit. This field can only be resolved for 10 diffs in any single request.
fullTitle String Full title of the commit message.
fullTitleHtml String GitLab Flavored Markdown rendering of full_title.
id ID! ID (global ID) of the commit.
message String Raw commit message.
name String Name or title of the object.
sha String! SHA1 ID of the commit.
shortId String! Short SHA1 ID of the commit.
signature CommitSignature Signature of the commit.
signatureHtml String Rendered HTML of the commit signature.
title String Title of the commit message.
titleHtml String GitLab Flavored Markdown rendering of title.
webPath String! Web path of the commit.
webUrl String! Web URL of the commit.

Fields with arguments

Commit.pipelines

Pipelines of the commit ordered latest first.

Returns PipelineConnection.

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

Arguments
Name Type Description
ref String Filter pipelines by the ref they are run for.
scope PipelineScopeEnum Filter pipelines by scope.
sha String Filter pipelines by the sha of the commit they are run for.
source String Filter pipelines by their source.
status PipelineStatusEnum Filter pipelines by their status.
updatedAfter Time Pipelines updated after the date.
updatedBefore Time Pipelines updated before the date.
username String Filter pipelines by the user that triggered the pipeline.

CommitData

Fields

Name Type Description
ageMapClass String! CSS class for age of commit.
authorAvatar String! Link to author avatar.
commitAuthorLink String! Link to the commit author.
commitLink String! Link to the commit.
projectBlameLink String Link to blame prior to the change.
timeAgoTooltip String! Time of commit.

CommitParentNames

Fields

Name Type Description
names [String!] Names of the commit parent (branch or tag).

CommitReferences

Fields with arguments

CommitReferences.containingBranches

Get branch names containing a given commit.

Returns CommitParentNames.

Arguments
Name Type Description
excludeTipped Boolean! Exclude tipping refs. WARNING: This argument can be confusing, if there is a limit. for example set the limit to 5 and in the 5 out a total of 25 refs there is 2 tipped refs, then the method will only 3 refs, even though there is more.
limit Int! Number of ref names to return.
CommitReferences.containingTags

Get tag names containing a given commit.

Returns CommitParentNames.

Arguments
Name Type Description
excludeTipped Boolean! Exclude tipping refs. WARNING: This argument can be confusing, if there is a limit. for example set the limit to 5 and in the 5 out a total of 25 refs there is 2 tipped refs, then the method will only 3 refs, even though there is more.
limit Int! Number of ref names to return.
CommitReferences.tippingBranches

Get branch names tipping at a given commit.

Returns CommitParentNames.

Arguments
Name Type Description
limit Int! Number of ref names to return.
CommitReferences.tippingTags

Get tag names tipping at a given commit.

Returns CommitParentNames.

Arguments
Name Type Description
limit Int! Number of ref names to return.

ComparedSecurityReport

Represents compared security report.

Fields

Name Type Description
added {{< icon name=”warning-solid” >}} [ComparedSecurityReportFinding!] Introduced in GitLab 16.1. Status: Experiment. New vulnerability findings.
baseReportCreatedAt Time Time of the base report creation.
baseReportOutOfDate Boolean Indicates whether the base report out of date.
fixed {{< icon name=”warning-solid” >}} [ComparedSecurityReportFinding!] Introduced in GitLab 16.1. Status: Experiment. Fixed vulnerability findings.
headReportCreatedAt Time Time of the base report creation.

ComparedSecurityReportFinding

Represents finding.

Fields

Name Type Description
description String Description of the vulnerability finding.
details {{< icon name=”warning-solid” >}} [VulnerabilityDetail!]! Introduced in GitLab 17.6. Status: Experiment. Details of the vulnerability finding.
foundByPipelineIid String IID of the pipeline.
identifiers {{< icon name=”warning-solid” >}} [VulnerabilityIdentifier!] Introduced in GitLab 16.3. Status: Experiment. Identifiers of the vulnerability finding.
location {{< icon name=”warning-solid” >}} VulnerabilityLocation Introduced in GitLab 16.3. Status: Experiment. Location of the vulnerability finding.
scanner ComparedSecurityReportScanner Compared report vulnerability scanner.
severity VulnerabilitySeverity Severity of the vulnerability finding.
state VulnerabilityState Finding status.
title String Title of the vulnerability finding.
uuid String UUIDv5 digest based on the vulnerability’s report type, primary identifier, location, fingerprint, project identifier.

ComparedSecurityReportScanner

Represents a compared report vulnerability scanner.

Fields

Name Type Description
externalId String External ID of the vulnerability scanner.
name String Name of the vulnerability scanner.
vendor String Vendor of the vulnerability scanner.

ComplianceFramework

Represents a ComplianceFramework associated with a Project.

Fields

Name Type Description
color String! Hexadecimal representation of compliance framework’s label color.
complianceRequirements ComplianceRequirementConnection Compliance requirements of the compliance framework. (see Connections)
default Boolean Default compliance framework for the group.
description String! Description of the compliance framework.
editPath String! Web UI path to edit the compliance framework.
id ID! Compliance framework ID.
name String! Name of the compliance framework.
pipelineConfigurationFullPath {{< icon name=”warning-solid” >}} String Deprecated in GitLab 17.4. Use pipeline execution policies instead.
pipelineExecutionPolicies PipelineExecutionPolicyConnection Pipeline Execution Policies of the compliance framework. (see Connections)
projects ProjectConnection Projects associated with the compliance framework. (see Connections)
scanExecutionPolicies ScanExecutionPolicyConnection Scan Execution Policies of the compliance framework. (see Connections)
scanResultPolicies ScanResultPolicyConnection Scan Result Policies of the compliance framework. (see Connections)
vulnerabilityManagementPolicies VulnerabilityManagementPolicyConnection Vulnerability Management Policies of the compliance framework. (see Connections)

Fields with arguments

ComplianceFramework.pipelineExecutionSchedulePolicies

Pipeline Execution Schedule Policies of the compliance framework.

Returns PipelineExecutionSchedulePolicyConnection.

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

Arguments
Name Type Description
includeUnscoped Boolean Filter policies that are scoped to the project.
relationship SecurityPolicyRelationType Filter policies by the given policy relationship. Default is DIRECT.

ComplianceRequirement

Represents a ComplianceRequirement associated with a ComplianceFramework.

Fields

Name Type Description
complianceRequirementsControls ComplianceRequirementsControlConnection Compliance controls of the compliance requirement. (see Connections)
description String! Description of the compliance requirement.
id ID! Compliance requirement ID.
name String! Name of the compliance requirement.

ComplianceRequirementControl

Lists down all the possible types of requirement controls.

Fields

Name Type Description
controlExpressions [ControlExpression!]! List of requirement controls.

ComplianceRequirementsControl

Represents a ComplianceRequirementsControl associated with a ComplianceRequirement.

Fields

Name Type Description
controlType String! Type of the compliance control.
expression String Expression of the compliance control.
externalUrl String URL of the external control.
id ID! Compliance requirements control ID.
name String! Name of the compliance control.

ComplianceStandardsAdherence

Compliance standards adherence for a project.

Fields

Name Type Description
checkName ComplianceStandardsAdherenceCheckName! Name of the check for the compliance standard.
id ID! Compliance standards adherence ID.
project Project! Project adhering to the compliance standard.
standard ComplianceStandardsAdherenceStandard! Name of the compliance standard.
status ComplianceStandardsAdherenceStatus! Status of the compliance standards adherence.
updatedAt Time! Timestamp when the adherence was updated.

ComplianceViolation

Compliance violation associated with a merged merge request.

Fields

Name Type Description
id ID! Compliance violation ID.
mergeRequest MergeRequest! Merge request the compliance violation occurred in.
reason ComplianceViolationReason! Reason the compliance violation occurred.
severityLevel ComplianceViolationSeverity! Severity of the compliance violation.
violatingUser UserCore! User suspected of causing the compliance violation.

Component

A software dependency used by a project.

Fields

Name Type Description
id SbomComponentID! ID of the dependency.
name String! Name of the dependency.

ComponentVersion

A software dependency version used by a project.

Fields

Name Type Description
id SbomComponentVersionID! ID of the dependency version.
version String! Version of the dependency.

ComposerMetadata

Composer metadata.

Fields

Name Type Description
composerJson PackageComposerJsonType! Data of the Composer JSON file.
targetSha String! Target SHA of the package.

ConanFileMetadata

Conan file metadata.

Fields

Name Type Description
conanFileType ConanMetadatumFileTypeEnum! Type of the Conan file.
conanPackageReference String Reference of the Conan package.
createdAt Time! Date of creation.
id PackagesConanFileMetadatumID! ID of the metadatum.
packageRevision String Revision of the package.
recipeRevision String! Revision of the Conan recipe.
updatedAt Time! Date of most recent update.

ConanMetadata

Conan metadata.

Fields

Name Type Description
createdAt Time! Date of creation.
id PackagesConanMetadatumID! ID of the metadatum.
packageChannel String! Channel of the Conan package.
packageUsername String! Username of the Conan package.
recipe String! Recipe of the Conan package.
recipePath String! Recipe path of the Conan package.
updatedAt Time! Date of most recent update.

ConnectedAgent

Connection details for an Agent.

Fields

Name Type Description
connectedAt Time When the connection was established.
connectionId BigInt ID of the connection.
metadata AgentMetadata Information about the Agent.
warnings [AgentWarning!] Agent warnings list.

ContactStateCounts

Represents the total number of contacts for the represented states.

Fields

Name Type Description
active Int Number of contacts with state ACTIVE.
all Int Number of contacts with state ALL.
inactive Int Number of contacts with state INACTIVE.

ContainerExpirationPolicy

A tag expiration policy designed to keep only the images that matter most.

Fields

Name Type Description
cadence ContainerExpirationPolicyCadenceEnum! This container expiration policy schedule.
createdAt Time! Timestamp of when the container expiration policy was created.
enabled Boolean! Indicates whether the container expiration policy is enabled.
keepN ContainerExpirationPolicyKeepEnum Number of tags to retain.
nameRegex UntrustedRegexp Tags with names matching the regex pattern will expire.
nameRegexKeep UntrustedRegexp Tags with names matching the regex pattern will be preserved.
nextRunAt Time Next time that the container expiration policy will get executed.
olderThan ContainerExpirationPolicyOlderThanEnum Tags older than the given age will expire.
updatedAt Time! Timestamp of when the container expiration policy was updated.

ContainerProtectionAccessLevel

Represents the most restrictive permissions for a container image tag.

Fields

Name Type Description
immutable {{< icon name=”warning-solid” >}} Boolean! Introduced in GitLab 17.11. Status: Experiment. Returns true when tag rule is for tag immutability. Otherwise, false.
minimumAccessLevelForDelete {{< icon name=”warning-solid” >}} ContainerProtectionTagRuleAccessLevel Introduced 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 access level can delete tags.
minimumAccessLevelForPush {{< icon name=”warning-solid” >}} ContainerProtectionTagRuleAccessLevel Introduced 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 access level can push tags.

ContainerProtectionRepositoryRule

A container repository protection rule designed to prevent users with a certain access level or lower from altering the container registry.

Fields

Name Type Description
id ContainerRegistryProtectionRuleID! ID of the container repository protection rule.
minimumAccessLevelForDelete ContainerProtectionRepositoryRuleAccessLevel Minimum GitLab access level required to delete container images from the container repository. Valid values include MAINTAINER, OWNER, or ADMIN. If the value is nil, the default minimum access level is DEVELOPER.
minimumAccessLevelForPush ContainerProtectionRepositoryRuleAccessLevel Minimum GitLab access level required to push container images to the container repository. Valid values include MAINTAINER, OWNER, or ADMIN. If the value is nil, the default minimum access level is DEVELOPER.
repositoryPathPattern String! Container repository path pattern protected by the protection rule. Must start with the project’s full path. For example: my-project/*-prod-*. Wildcard character * is allowed anywhere after the project’s full path.

ContainerProtectionTagRule

A container repository tag protection rule designed to prevent users with a certain access level or lower from altering the container registry.

Fields

Name Type Description
id {{< icon name=”warning-solid” >}} ContainerRegistryProtectionTagRuleID! Introduced in GitLab 17.8. Status: Experiment. ID of the container repository tag protection rule.
immutable {{< icon name=”warning-solid” >}} Boolean! Introduced in GitLab 17.11. Status: Experiment. Returns true when tag rule is for tag immutability. Otherwise, false.
minimumAccessLevelForDelete {{< icon name=”warning-solid” >}} ContainerProtectionTagRuleAccessLevel Introduced 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 access level can delete tags.
minimumAccessLevelForPush {{< icon name=”warning-solid” >}} ContainerProtectionTagRuleAccessLevel Introduced 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 access level can push tags.
tagNamePattern {{< icon name=”warning-solid” >}} String! Introduced in GitLab 17.8. Status: Experiment. The pattern that matches container image tags to protect. For example, v1.*. Wildcard character * allowed.
userPermissions ContainerRegistryProtectionTagRulePermissions! Permissions for the current user on the resource.

ContainerRegistryProtectionTagRulePermissions

Fields

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

ContainerRepository

A container repository.

Fields

Name Type Description
createdAt Time! Timestamp when the container repository was created.
expirationPolicyCleanupStatus ContainerRepositoryCleanupStatus Tags cleanup status for the container repository.
expirationPolicyStartedAt Time Timestamp when the cleanup done by the expiration policy was started on the container repository.
id ID! ID of the container repository.
lastCleanupDeletedTagsCount Int Number of deleted tags from the last cleanup.
location String! URL of the container repository.
migrationState {{< icon name=”warning-solid” >}} String! Deprecated in GitLab 17.0. Returns an empty string. This was used for the migration of GitLab.com, which is now complete. Not used by Self-managed instances.
name String! Name of the container repository.
path String! Path of the container repository.
project Project! Project of the container registry.
protectionRuleExists Boolean! Whether any matching container protection rule exists for the container repository.
status ContainerRepositoryStatus Status of the container repository.
tagsCount Int! Number of tags associated with the image.
updatedAt Time! Timestamp when the container repository was updated.
userPermissions ContainerRepositoryPermissions! Permissions for the current user on the resource.

ContainerRepositoryDetails

Details of a container repository.

Fields

Name Type Description
createdAt Time! Timestamp when the container repository was created.
expirationPolicyCleanupStatus ContainerRepositoryCleanupStatus Tags cleanup status for the container repository.
expirationPolicyStartedAt Time Timestamp when the cleanup done by the expiration policy was started on the container repository.
id ID! ID of the container repository.
lastCleanupDeletedTagsCount Int Number of deleted tags from the last cleanup.
lastPublishedAt Time Timestamp when a repository tag was last created or updated. Only present for repositories that had tags created or updated after GitLab 16.11.
location String! URL of the container repository.
migrationState {{< icon name=”warning-solid” >}} String! Deprecated in GitLab 17.0. Returns an empty string. This was used for the migration of GitLab.com, which is now complete. Not used by Self-managed instances.
name String! Name of the container repository.
path String! Path of the container repository.
project Project! Project of the container registry.
protectionRuleExists Boolean! Whether any matching container protection rule exists for the container repository.
size Float Deduplicated size of the image repository in bytes. This is only available on GitLab.com for repositories created after 2021-11-04.
status ContainerRepositoryStatus Status of the container repository.
tagsCount Int! Number of tags associated with the image.
updatedAt Time! Timestamp when the container repository was updated.
userPermissions ContainerRepositoryPermissions! Permissions for the current user on the resource.

Fields with arguments

ContainerRepositoryDetails.manifest

An image manifest from the container repository.

Returns String.

Arguments
Name Type Description
reference String! 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
Name Type Description
name String Search by tag name.
referrerType String Comma-separated list of artifact types used to filter referrers. Applies only when referrers is set to true.
referrers Boolean Include tag referrers.
sort ContainerRepositoryTagSort Sort tags by these criteria.

ContainerRepositoryPermissions

Fields

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

ContainerRepositoryReferrer

A referrer for a container repository tag.

Fields

Name Type Description
artifactType String Artifact type of the referrer.
digest String Digest of the referrer.
userPermissions ContainerRepositoryTagPermissions! Permissions for the current user on the resource.

ContainerRepositoryRegistry

Represents the Geo replication and verification state of an Container Repository.

Fields

Name Type Description
checksumMismatch Boolean Indicate if the checksums of the ContainerRepositoryRegistry do not match on the primary and secondary.
containerRepositoryId ID! ID of the ContainerRepository.
createdAt Time Timestamp when the ContainerRepositoryRegistry was created.
forceToRedownload {{< icon name=”warning-solid” >}} Boolean Deprecated in GitLab 17.10. Removed from registry tables in the database in favor of the newer reusable framework.
id ID! ID of the ContainerRepositoryRegistry.
lastSyncFailure String Error message during sync of the ContainerRepositoryRegistry.
lastSyncedAt Time Timestamp of the most recent successful sync of the ContainerRepositoryRegistry.
missingOnPrimary Boolean Indicate if the ContainerRepositoryRegistry is missing on primary.
modelRecordId Int ID of the ContainerRepositoryRegistry’s model record.
retryAt Time Timestamp after which the ContainerRepositoryRegistry is resynced.
retryCount Int Number of consecutive failed sync attempts of the ContainerRepositoryRegistry.
state RegistryState Sync state of the ContainerRepositoryRegistry.
verificationChecksum String The local checksum of the ContainerRepositoryRegistry.
verificationChecksumMismatched String The expected checksum of the ContainerRepositoryRegistry in case of mismatch.
verificationFailure String Error message during verification of the ContainerRepositoryRegistry.
verificationRetryAt Time Timestamp after which the ContainerRepositoryRegistry is reverified.
verificationRetryCount Int Number of consecutive failed verification attempts of the ContainerRepositoryRegistry.
verificationStartedAt Time Timestamp when the verification of ContainerRepositoryRegistry started.
verificationState VerificationStateEnum Verification state of the ContainerRepositoryRegistry.
verifiedAt Time Timestamp of the most recent successful verification of the ContainerRepositoryRegistry.

ContainerRepositoryTag

A tag from a container repository.

Fields

Name Type Description
createdAt Time Timestamp when the tag was created.
digest String Digest of the tag.
location String! URL of the tag.
mediaType String Media type of the tag.
name String! Name of the tag.
path String! Path of the tag.
protection {{< icon name=”warning-solid” >}} ContainerProtectionAccessLevel Introduced in GitLab 17.9. Status: Experiment. Minimum GitLab access level required to push and delete container image tags. If the value is nil, no minimum access level is enforced. Users with the Developer role or higher can push tags by default.
publishedAt Time Timestamp when the tag was published.
referrers [ContainerRepositoryReferrer!] Referrers for the tag.
revision String Revision of the tag.
shortRevision String Short revision of the tag.
totalSize BigInt Size of the tag.
userPermissions ContainerRepositoryTagPermissions! Permissions for the current user on the resource.

ContainerRepositoryTagPermissions

Fields

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

ContainerTagsExpirationPolicy

A tag expiration policy using regex patterns to control which images to keep or expire.

Fields

Name Type Description
cadence ContainerExpirationPolicyCadenceEnum Schedule of the container expiration policy.
createdAt Time Timestamp of when the container expiration policy was created.
enabled Boolean! Indicates whether the container expiration policy is enabled.
keepN ContainerExpirationPolicyKeepEnum Number of tags to retain.
nameRegex UntrustedRegexp Tags with names matching the regex pattern will expire.
nameRegexKeep UntrustedRegexp Tags with names matching the regex pattern will be preserved.
nextRunAt Time Next time that the container expiration policy will get executed.
olderThan ContainerExpirationPolicyOlderThanEnum Tags older than the given age will expire.
updatedAt Time Timestamp of when the container expiration policy was updated.

ContextPreset

Presets for GitLab Duo Chat window based on current context.

Fields

Name Type Description
questions [String!] Array of questions that the user can ask GitLab Duo Chat from the current page.

ContributionAnalyticsContribution

Represents the contributions of a user.

Fields

Name Type Description
issuesClosed Int Number of issues closed by the user.
issuesCreated Int Number of issues created by the user.
mergeRequestsApproved Int Number of merge requests approved by the user.
mergeRequestsClosed Int Number of merge requests closed by the user.
mergeRequestsCreated Int Number of merge requests created by the user.
mergeRequestsMerged Int Number of merge requests merged by the user.
repoPushed Int Number of repository pushes the user made.
totalEvents Int Total number of events contributed by the user.
user UserCore Contributor User object.

ControlExpression

Represents a control expression.

Fields

Name Type Description
expression ExpressionValue! Expression details for the control.
id ID! ID for the control.
name String! Name of the control.

CoverageFuzzingCorpus

Corpus for a coverage fuzzing job.

Fields

Name Type Description
id AppSecFuzzingCoverageCorpusID! ID of the corpus.
package PackageDetailsType! Package of the corpus.

CurrentLicense

Represents the current license.

Fields

Name Type Description
activatedAt Date Date when the license was activated.
billableUsersCount Int Number of billable users on the system.
blockChangesAt Date Date, including grace period, when licensed features will be blocked.
company String Company of the licensee.
createdAt Date Date when the license was added.
email String Email of the licensee.
expiresAt Date Date when the license expires.
id ID! ID of the license extracted from the license data.
lastSync Time Date when the license was last synced.
maximumUserCount Int Highest number of billable users on the system during the term of the current license.
name String Name of the licensee.
plan String! Name of the subscription plan.
startsAt Date Date when the license started.
trial Boolean Indicates if the license is a trial.
type String! Type of the license.
usersInLicenseCount Int Number of paid users in the license.
usersOverLicenseCount Int Number of users over the paid users in the license.

CurrentUser

The currently authenticated GitLab user.

Fields

Name Type Description
active Boolean Indicates if the user is active.
activity {{< icon name=”warning-solid” >}} ActivityStream Introduced in GitLab 17.10. Status: Experiment. Recent user activity.
avatarUrl String URL of the user’s avatar.
bio String Bio of the user.
bot Boolean! Indicates if the user is a bot.
callouts UserCalloutConnection User callouts that belong to the user. (see Connections)
codeSuggestionsContexts {{< icon name=”warning-solid” >}} [String!]! Introduced in GitLab 17.9. Status: Experiment. List of additional contexts enabled for Code Suggestions.
commitEmail String User’s default commit email.
createdAt Time Timestamp of when the user was created.
discord String Discord ID of the user.
duoChatAvailable {{< icon name=”warning-solid” >}} Boolean! Introduced in GitLab 16.8. Status: Experiment. User access to AI chat feature.
duoChatAvailableFeatures {{< icon name=”warning-solid” >}} [String!]! Introduced in GitLab 17.6. Status: Experiment. List of available features for AI chat.
duoCodeSuggestionsAvailable {{< icon name=”warning-solid” >}} Boolean! Introduced in GitLab 16.8. Status: Experiment. User access to code suggestions feature.
email {{< icon name=”warning-solid” >}} String Deprecated in GitLab 13.7. This was renamed. Use: User.publicEmail.
emails EmailConnection User’s email addresses. (see Connections)
gitpodEnabled Boolean Whether Gitpod is enabled at the user level.
groupCount Int Group count for the user.
groupMemberships GroupMemberConnection Group memberships of the user. (see Connections)
human Boolean Indicates if the user is a regular user.
id UserID! Global ID of the user.
ide Ide IDE settings.
jobTitle String Job title of the user.
lastActivityOn Date Date the user last performed any actions.
linkedin String LinkedIn profile name of the user.
location String Location of the user.
name String! Human-readable name of the user. Returns **** if the user is a project bot and the requester does not have permission to view the project.
namespace Namespace Personal namespace of the user.
namespaceCommitEmails NamespaceCommitEmailConnection User’s custom namespace commit emails. (see Connections)
organization String Who the user represents or works for.
preferencesGitpodPath String Web path to the Gitpod section within user preferences.
profileEnableGitpodPath String Web path to enable Gitpod for the user.
projectMemberships ProjectMemberConnection Project memberships of the user. (see Connections)
pronouns String Pronouns of the user.
publicEmail String User’s public email.
recentlyViewedIssues {{< icon name=”warning-solid” >}} [Issue!] Introduced in GitLab 17.9. Status: Experiment. Most-recently viewed issues for the current user.
recentlyViewedMergeRequests {{< icon name=”warning-solid” >}} [MergeRequest!] Introduced in GitLab 17.10. Status: Experiment. Most-recently viewed merge requests for the current user.
savedReplies SavedReplyConnection Saved replies authored by the user. (see Connections)
state UserState! State of the user.
status UserStatus User status.
twitter String X (formerly Twitter) username of the user.
type UserType! Type of the user.
userPermissions UserPermissions! Permissions for the current user on the resource.
userPreferences UserPreferences Preferences for the user.
username String! Username of the user. Unique within the instance of GitLab.
webPath String! Web path of the user.
webUrl String! Web URL of the user.

Fields with arguments

CurrentUser.assignedMergeRequests

Merge requests assigned to the user.

Returns MergeRequestConnection.

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

Arguments
Name Type Description
approved Boolean Limit results to approved merge requests. Available only when the feature flag mr_approved_filter is enabled.
approvedBy [String!] Usernames of the approvers.
approver [String!] Usernames of possible approvers.
authorUsername String Username of the author.
blobPath {{< icon name=”warning-solid” >}} String Introduced 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.
createdAfter Time Merge requests created after the timestamp.
createdBefore Time Merge requests created before the timestamp.
deployedAfter Time Merge requests deployed after the timestamp.
deployedBefore Time Merge requests deployed before the timestamp.
deploymentId String ID of the deployment.
draft Boolean Limit result to draft merge requests.
environmentName String Environment merge requests have been deployed to.
groupId GroupID The global ID of the group the authored merge requests should be in. Merge requests in subgroups are included.
ignoredReviewerUsername {{< icon name=”warning-solid” >}} String Introduced in GitLab 18.0. Status: Experiment. Username of the reviewer to ignore when searching by reviewer state.
iids [String!] Array of IIDs of merge requests, for example [1, 2].
in [IssuableSearchableField!] Specify the fields to perform the search in. Defaults to [TITLE, DESCRIPTION]. Requires the search argument.’.
includeArchived Boolean Merge requests from archived projects.
labelName [String] Labels applied to the merge request.
labels {{< icon name=”warning-solid” >}} [String!] Deprecated in GitLab 17.1. Use labelName.
mergedAfter Time Merge requests merged after the date.
mergedBefore Time Merge requests merged before the date.
mergedBy String Username of the merger.
milestoneTitle String Title of the milestone. Incompatible with milestoneWildcardId.
milestoneWildcardId MilestoneWildcardId Filter issues by milestone ID wildcard. Incompatible with milestoneTitle.
myReactionEmoji String Filter by your reaction emoji.
not MergeRequestsResolverNegatedParams List of negated arguments. Warning: this argument is experimental and a subject to change in future.
or UnionedMergeRequestFilterInput List of arguments with inclusive OR.
projectId ProjectID The global ID of the project the authored merge requests should be in. Incompatible with projectPath.
projectPath String The full-path of the project the authored merge requests should be in. Incompatible with projectId.
releaseTag String Filter by release tag.
reviewState {{< icon name=”warning-solid” >}} MergeRequestReviewState Introduced in GitLab 17.0. Status: Experiment. Reviewer state of the merge request.
reviewStates {{< icon name=”warning-solid” >}} [MergeRequestReviewState!] Introduced in GitLab 17.0. Status: Experiment. Reviewer states of the merge request.
reviewerUsername String Username of the reviewer.
reviewerWildcardId ReviewerWildcardId Filter by reviewer presence. Incompatible with reviewerUsername.
search String Search query for title or description.
sort MergeRequestSort Sort merge requests by the criteria.
sourceBranches [String!] Array of source branch names. All resolved merge requests will have one of these branches as their source.
state MergeRequestState Merge request state. If provided, all resolved merge requests will have the state.
subscribed SubscriptionStatus Merge requests the current user is subscribed to.
targetBranches [String!] Array of target branch names. All resolved merge requests will have one of these branches as their target.
updatedAfter Time Merge requests updated after the timestamp.
updatedBefore Time Merge requests updated before the timestamp.
CurrentUser.assigneeOrReviewerMergeRequests

Merge requests the current user is an assignee or a reviewer of.Ignored if merge_request_dashboard feature flag is disabled.

{{< details >}} Introduced in GitLab 17.4. Status: Experiment. {{< /details >}}

Returns MergeRequestConnection.

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

Arguments
Name Type Description
approved Boolean Limit results to approved merge requests. Available only when the feature flag mr_approved_filter is enabled.
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 {{< icon name=”warning-solid” >}} String Introduced 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.
createdAfter Time Merge requests created after the timestamp.
createdBefore Time Merge requests created before the timestamp.
deployedAfter Time Merge requests deployed after the timestamp.
deployedBefore Time Merge requests deployed before the timestamp.
deploymentId String ID of the deployment.
draft Boolean Limit result to draft merge requests.
environmentName String Environment merge requests have been deployed to.
groupId GroupID The global ID of the group the authored merge requests should be in. Merge requests in subgroups are included.
ignoredReviewerUsername {{< icon name=”warning-solid” >}} String Introduced in GitLab 18.0. Status: Experiment. Username of the reviewer to ignore when searching by reviewer state.
iids [String!] Array of IIDs of merge requests, for example [1, 2].
in [IssuableSearchableField!] Specify the fields to perform the search in. Defaults to [TITLE, DESCRIPTION]. Requires the search argument.’.
includeArchived Boolean Merge requests from archived projects.
labelName [String] Labels applied to the merge request.
labels {{< icon name=”warning-solid” >}} [String!] Deprecated in GitLab 17.1. Use labelName.
mergedAfter Time Merge requests merged after the date.
mergedBefore Time Merge requests merged before the date.
mergedBy String Username of the merger.
milestoneTitle String Title of the milestone. Incompatible with milestoneWildcardId.
milestoneWildcardId MilestoneWildcardId Filter issues by milestone ID wildcard. Incompatible with milestoneTitle.
myReactionEmoji String Filter by your reaction emoji.
not MergeRequestsResolverNegatedParams List of negated arguments. Warning: this argument is experimental and a subject to change in future.
or UnionedMergeRequestFilterInput List of arguments with inclusive OR.
projectId ProjectID The global ID of the project the authored merge requests should be in. Incompatible with projectPath.
projectPath String The full-path of the project the authored merge requests should be in. Incompatible with projectId.
releaseTag String Filter by release tag.
reviewState {{< icon name=”warning-solid” >}} MergeRequestReviewState Introduced in GitLab 17.0. Status: Experiment. Reviewer state of the merge request.
reviewStates {{< icon name=”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.
search String Search query for title or description.
sort MergeRequestSort Sort merge requests by the criteria.
sourceBranches [String!] Array of source branch names. All resolved merge requests will have one of these branches as their source.
state MergeRequestState Merge request state. If provided, all resolved merge requests will have the state.
subscribed SubscriptionStatus Merge requests the current user is subscribed to.
targetBranches [String!] Array of target branch names. All resolved merge requests will have one of these branches as their target.
updatedAfter Time Merge requests updated after the timestamp.
updatedBefore Time Merge requests updated before the timestamp.
CurrentUser.authoredMergeRequests

Merge requests authored by the user.

Returns MergeRequestConnection.

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

Arguments
Name Type Description
approved Boolean Limit results to approved merge requests. Available only when the feature flag mr_approved_filter is enabled.
approvedBy [String!] Usernames of the approvers.
approver [String!] Usernames of possible approvers.
assigneeUsername String Username of the assignee.
assigneeUsernames [String!] Usernames of users assigned to the merge request.
assigneeWildcardId AssigneeWildcardId Filter by assignee presence. Incompatible with assigneeUsernames and assigneeUsername.
blobPath {{< icon name=”warning-solid” >}} String Introduced 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.
createdAfter Time Merge requests created after the timestamp.
createdBefore Time Merge requests created before the timestamp.
deployedAfter Time Merge requests deployed after the timestamp.
deployedBefore Time Merge requests deployed before the timestamp.
deploymentId String ID of the deployment.
draft Boolean Limit result to draft merge requests.
environmentName String Environment merge requests have been deployed to.
groupId GroupID The global ID of the group the authored merge requests should be in. Merge requests in subgroups are included.
ignoredReviewerUsername {{< icon name=”warning-solid” >}} String Introduced in GitLab 18.0. Status: Experiment. Username of the reviewer to ignore when searching by reviewer state.
iids [String!] Array of IIDs of merge requests, for example [1, 2].
in [IssuableSearchableField!] Specify the fields to perform the search in. Defaults to [TITLE, DESCRIPTION]. Requires the search argument.’.
includeArchived Boolean Merge requests from archived projects.
includeAssigned Boolean Include merge requests the user is assigned to.
labelName [String] Labels applied to the merge request.
labels {{< icon name=”warning-solid” >}} [String!] Deprecated in GitLab 17.1. Use labelName.
mergedAfter Time Merge requests merged after the date.
mergedBefore Time Merge requests merged before the date.
mergedBy String Username of the merger.
milestoneTitle String Title of the milestone. Incompatible with milestoneWildcardId.
milestoneWildcardId MilestoneWildcardId Filter issues by milestone ID wildcard. Incompatible with milestoneTitle.
myReactionEmoji String Filter by your reaction emoji.
not MergeRequestsResolverNegatedParams List of negated arguments. Warning: this argument is experimental and a subject to change in future.
or UnionedMergeRequestFilterInput List of arguments with inclusive OR.
projectId ProjectID The global ID of the project the authored merge requests should be in. Incompatible with projectPath.
projectPath String The full-path of the project the authored merge requests should be in. Incompatible with projectId.
releaseTag String Filter by release tag.
reviewState {{< icon name=”warning-solid” >}} MergeRequestReviewState Introduced in GitLab 17.0. Status: Experiment. Reviewer state of the merge request.
reviewStates {{< icon name=”warning-solid” >}} [MergeRequestReviewState!] Introduced in GitLab 17.0. Status: Experiment. Reviewer states of the merge request.
reviewerUsername String Username of the reviewer.
reviewerWildcardId ReviewerWildcardId Filter by reviewer presence. Incompatible with reviewerUsername.
search String Search query for title or description.
sort MergeRequestSort Sort merge requests by the criteria.
sourceBranches [String!] Array of source branch names. All resolved merge requests will have one of these branches as their source.
state MergeRequestState Merge request state. If provided, all resolved merge requests will have the state.
subscribed SubscriptionStatus Merge requests the current user is subscribed to.
targetBranches [String!] Array of target branch names. All resolved merge requests will have one of these branches as their target.
updatedAfter Time Merge requests updated after the timestamp.
updatedBefore Time Merge requests updated before the timestamp.
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
Name Type Description
includePersonal Boolean Include personal projects.
minAccessLevel AccessLevelEnum Return only projects where current user has at least the specified access level.
programmingLanguageName String Filter projects by programming language name (case insensitive). For example: “css” or “ruby”.
search String Search query.
sort ProjectSort Sort contributed projects.
CurrentUser.groups

Groups where the user has access.

Returns GroupConnection.

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

Arguments
Name Type Description
permissionScope GroupPermission Filter by permissions the user has on groups.
search String Search by group name or path.
sort GroupSort Sort groups by given criteria.
CurrentUser.organizations

Organizations where the user has access.

{{< details >}} Introduced in GitLab 16.6. Status: Experiment. {{< /details >}}

Returns OrganizationConnection.

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

Arguments
Name Type Description
search String Search query, which can be for the organization name or a path.
soloOwned Boolean When 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
Name Type Description
approved Boolean Limit 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.
assigneeUsername String Username of the assignee.
assigneeUsernames [String!] Usernames of users assigned to the merge request.
assigneeWildcardId AssigneeWildcardId Filter by assignee presence. Incompatible with assigneeUsernames and assigneeUsername.
authorUsername String Username of the author.
blobPath {{< icon name=”warning-solid” >}} String Introduced 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.
createdAfter Time Merge requests created after the timestamp.
createdBefore Time Merge requests created before the timestamp.
deployedAfter Time Merge requests deployed after the timestamp.
deployedBefore Time Merge requests deployed before the timestamp.
deploymentId String ID of the deployment.
draft Boolean Limit result to draft merge requests.
environmentName String Environment merge requests have been deployed to.
groupId GroupID The global ID of the group the authored merge requests should be in. Merge requests in subgroups are included.
ignoredReviewerUsername {{< icon name=”warning-solid” >}} String Introduced in GitLab 18.0. Status: Experiment. Username of the reviewer to ignore when searching by reviewer state.
iids [String!] Array of IIDs of merge requests, for example [1, 2].
in [IssuableSearchableField!] Specify the fields to perform the search in. Defaults to [TITLE, DESCRIPTION]. Requires the search argument.’.
includeArchived Boolean Merge requests from archived projects.
labelName [String] Labels applied to the merge request.
labels {{< icon name=”warning-solid” >}} [String!] Deprecated in GitLab 17.1. Use labelName.
mergedAfter Time Merge requests merged after the date.
mergedBefore Time Merge requests merged before the date.
mergedBy String Username of the merger.
milestoneTitle String Title of the milestone. Incompatible with milestoneWildcardId.
milestoneWildcardId MilestoneWildcardId Filter issues by milestone ID wildcard. Incompatible with milestoneTitle.
myReactionEmoji String Filter by your reaction emoji.
not MergeRequestsResolverNegatedParams List of negated arguments. Warning: this argument is experimental and a subject to change in future.
or UnionedMergeRequestFilterInput List of arguments with inclusive OR.
projectId ProjectID The global ID of the project the authored merge requests should be in. Incompatible with projectPath.
projectPath String The full-path of the project the authored merge requests should be in. Incompatible with projectId.
releaseTag String Filter by release tag.
reviewState {{< icon name=”warning-solid” >}} MergeRequestReviewState Introduced in GitLab 17.0. Status: Experiment. Reviewer state of the merge request.
reviewStates {{< icon name=”warning-solid” >}} [MergeRequestReviewState!] Introduced in GitLab 17.0. Status: Experiment. Reviewer states of the merge request.
search String Search query for title or description.
sort MergeRequestSort Sort merge requests by the criteria.
sourceBranches [String!] Array of source branch names. All resolved merge requests will have one of these branches as their source.
state MergeRequestState Merge request state. If provided, all resolved merge requests will have the state.
subscribed SubscriptionStatus Merge requests the current user is subscribed to.
targetBranches [String!] Array of target branch names. All resolved merge requests will have one of these branches as their target.
updatedAfter Time Merge requests updated after the timestamp.
updatedBefore Time Merge requests updated before the timestamp.
CurrentUser.savedReply

Saved reply authored by the user.

Returns SavedReply.

Arguments
Name Type Description
id UsersSavedReplyID! ID of a saved reply.
CurrentUser.snippets

Snippets authored by the user.

Returns SnippetConnection.

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

Arguments
Name Type Description
ids [SnippetID!] Array of global snippet IDs. For example, gid://gitlab/ProjectSnippet/1.
type TypeEnum Type of snippet.
visibility VisibilityScopesEnum Visibility of the snippet.
CurrentUser.starredProjects

Projects starred by the user.

Returns ProjectConnection.

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

Arguments
Name Type Description
minAccessLevel AccessLevelEnum Return only projects where current user has at least the specified access level.
programmingLanguageName String Filter projects by programming language name (case insensitive). For example: “css” or “ruby”.
search String Search query.
sort ProjectSort List starred projects by sort order.
CurrentUser.timelogs

Time logged by the user.

Returns TimelogConnection.

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

Arguments
Name Type Description
endDate Time List timelogs within a date range where the logged date is equal to or before endDate.
endTime Time List timelogs within a time range where the logged time is equal to or before endTime.
groupId GroupID List timelogs for a group.
projectId ProjectID List timelogs for a project.
sort TimelogSort List timelogs in a particular order.
startDate Time List timelogs within a date range where the logged date is equal to or after startDate.
startTime Time List timelogs within a time range where the logged time is equal to or after startTime.
username String List timelogs for a user.
CurrentUser.todos

To-do items of the user.

Returns TodoConnection.

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

Arguments
Name Type Description
action [TodoActionEnum!] Action to be filtered.
authorId [ID!] ID of an author.
groupId [ID!] ID of a group.
isSnoozed Boolean Whether the to-do item is snoozed.
projectId [ID!] ID of a project.
sort TodoSort Sort todos by given criteria.
state [TodoStateEnum!] State of the todo.
type [TodoTargetEnum!] Type of the todo.
CurrentUser.userAchievements

Achievements for the user. Only returns for namespaces where the achievements feature flag is enabled.

{{< details >}} Introduced in GitLab 15.10. Status: Experiment. {{< /details >}}

Returns UserAchievementConnection.

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

Arguments
Name Type Description
includeHidden Boolean Indicates whether or not achievements hidden from the profile should be included in the result.
CurrentUser.workItemPreferences

User preferences for the given work item type and namespace.

{{< details >}} Introduced in GitLab 17.10. Status: Experiment. {{< /details >}}

Returns WorkItemTypesUserPreference.

Arguments
Name Type Description
namespacePath ID! Full path of the namespace the work item is created in.
workItemTypeId WorkItemsTypeID Global ID of a work item type.
CurrentUser.workItems

Find work items visible to the current user.

{{< details >}} Introduced in GitLab 17.10. Status: Experiment. {{< /details >}}

Returns WorkItemConnection.

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

Arguments
Name Type Description
assigneeUsernames [String!] Usernames of users assigned to the work item.
assigneeWildcardId AssigneeWildcardId Filter by assignee wildcard. Incompatible with assigneeUsernames.
authorUsername String Filter work items by author username.
closedAfter Time Work items closed after the date.
closedBefore Time Work items closed before the date.
confidential Boolean Filter for confidential work items. If false, excludes confidential work items. If true, returns only confidential work items.
createdAfter Time Work items created after the timestamp.
createdBefore Time Work items created before the timestamp.
dueAfter Time Work items due after the timestamp.
dueBefore Time Work 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.
milestoneWildcardId MilestoneWildcardId Filter by milestone ID wildcard. Incompatible with milestoneTitle.
myReactionEmoji String Filter by reaction emoji applied by the current user. Wildcard values NONE and ANY are supported.
not NegatedWorkItemFilterInput Negated work item arguments.
or UnionedWorkItemFilterInput List of arguments with inclusive OR.
search String Search query for title or description.
sort WorkItemSort Sort work items by criteria.
state IssuableState Current state of the work item.
subscribed SubscriptionStatus Work items the current user is subscribed to.
types [IssueType!] Filter work items by the given work item types.
updatedAfter Time Work items updated after the timestamp.
updatedBefore Time Work items updated before the timestamp.
CurrentUser.workspaces

Workspaces owned by the current user.

Returns WorkspaceConnection.

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

Arguments
Name Type Description
actualStates [String!] Filter workspaces by actual states.
agentIds [ClustersAgentID!] Filter workspaces by agent GlobalIDs.
ids [RemoteDevelopmentWorkspaceID!] Filter workspaces by workspace GlobalIDs. For example, ["gid://gitlab/RemoteDevelopment::Workspace/1"].
includeActualStates {{< icon name=”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

Name Type Description
createdAt Time! Timestamp of when the custom emoji was created.
external Boolean! Whether the emoji is an external link.
id CustomEmojiID! ID of the emoji.
name String! Name of the emoji.
url String! Link to file of the emoji.
userPermissions CustomEmojiPermissions! Permissions for the current user on the resource.

CustomEmojiPermissions

Fields

Name Type Description
createCustomEmoji Boolean! If true, the user can perform create_custom_emoji on this resource.
deleteCustomEmoji Boolean! If true, the user can perform delete_custom_emoji on this resource.
readCustomEmoji Boolean! If true, the user can perform read_custom_emoji on this resource.

CustomField

Represents a custom field.

Fields

Name Type Description
active Boolean! Whether the custom field is active.
createdAt Time! Timestamp when the custom field was created.
createdBy UserCore User that created the custom field.
fieldType CustomFieldType! Type of custom field.
id IssuablesCustomFieldID! Global ID of the custom field.
name String! Name of the custom field.
selectOptions [CustomFieldSelectOption!] Available options for a select field.
updatedAt Time! Timestamp when the custom field was last updated.
updatedBy UserCore User that last updated the custom field.
workItemTypes [WorkItemType!] Work item types that the custom field is available on.

CustomFieldSelectOption

Represents a custom field select option.

Fields

Name Type Description
id IssuablesCustomFieldSelectOptionID! Global ID of the custom field select option.
value String! Value of the custom field select option.

CustomerRelationsContact

Fields

Name Type Description
active Boolean! State of the contact.
createdAt Time! Timestamp the contact was created.
description String Description of or notes for the contact.
email String Email address of the contact.
firstName String! First name of the contact.
id ID! Internal ID of the contact.
lastName String! Last name of the contact.
organization CustomerRelationsOrganization Organization of the contact.
phone String Phone number of the contact.
updatedAt Time! Timestamp the contact was last updated.

CustomerRelationsOrganization

Fields

Name Type Description
active Boolean! State of the organization.
createdAt Time! Timestamp the organization was created.
defaultRate Float Standard billing rate for the organization.
description String Description of or notes for the organization.
id ID! Internal ID of the organization.
name String! Name of the organization.
updatedAt Time! Timestamp the organization was last updated.

CustomizableAdminPermission

Fields

Name Type Description
description String Description of the permission.
name String! Localized name of the permission.
requirements [MemberRoleAdminPermission!] Requirements of the permission.
value MemberRoleAdminPermission! Value of the permission.

CustomizableDashboard

Represents a product analytics dashboard.

Fields

Name Type Description
category CustomizableDashboardCategory! Category of dashboard.
configurationProject Project Project which contains the dashboard definition.
description String Description of the dashboard.
errors [String!] Errors on yaml definition.
filters JSON Dashboard global filters.
panels CustomizableDashboardPanelConnection Panels shown on the dashboard. (see Connections)
slug String! Slug of the dashboard.
status {{< icon name=”warning-solid” >}} String Introduced in GitLab 17.0. Status: Experiment. Status of the dashboard.
title String Title of the dashboard.
userDefined Boolean! Indicates whether the dashboard is user-defined or provided by GitLab.

CustomizableDashboardPanel

Represents a product analytics dashboard panel.

Fields

Name Type Description
gridAttributes JSON Description of the position and size of the panel.
queryOverrides JSON Overrides for the visualization query object.
title String Title of the panel.
visualization CustomizableDashboardVisualization Visualization of the panel.

CustomizableDashboardVisualization

Represents a product analytics dashboard visualization.

Fields

Name Type Description
data JSON! Data of the visualization.
errors [String!] Validation errors in the visualization.
options JSON! Options of the visualization.
slug String! Slug of the visualization.
type String! Type of the visualization.

CustomizableStandardPermission

Fields

Name Type Description
availableFor [String!]! Objects the permission is available for.
description String Description of the permission.
enabledForGroupAccessLevels [AccessLevelEnum!] Group access levels from which the permission is allowed.
enabledForProjectAccessLevels [AccessLevelEnum!] Project access levels from which the permission is allowed.
name String! Localized name of the permission.
requirements [MemberRoleStandardPermission!] Requirements of the permission.
value MemberRoleStandardPermission! Value of the permission.

CveEnrichmentType

Represents a CVE’s Enrichment (EPSS score).

Fields

Name Type Description
cve String! CVE identifier of relevant vulnerability.
epssScore Float! EPSS score for the CVE.
isKnownExploit Boolean! Whether the CVE appears in the CISA KEV catalog.

CvssType

Represents a vulnerability’s CVSS score.

Fields

Name Type Description
baseScore Float! Base score of the CVSS.
overallScore Float! Overall score of the CVSS.
severity CvssSeverity! Severity calculated from the overall score.
vector String! CVSS vector string.
vendor String! Vendor who assigned the CVSS score.
version Float! Version of the CVSS.

DastPreScanVerification

Represents a DAST Pre Scan Verification.

Fields

Name Type Description
preScanVerificationSteps [DastPreScanVerificationStep!] Pre Scan Verifications Steps.
status DastPreScanVerificationStatus Status of the pre scan verification.
valid Boolean! Whether or not the configuration has changed after the last pre scan run.

DastPreScanVerificationStep

Represents a DAST Pre Scan Verification Step.

Fields

Name Type Description
checkType DastPreScanVerificationCheckType Type of the pre scan verification check.
errors [String!] Errors that occurred in the pre scan verification step.
name {{< icon name=”warning-solid” >}} String Deprecated in GitLab 15.10. This was renamed. Use: DastPreScanVerificationStep.checkType.
success Boolean! Whether or not the pre scan verification step has errors.

DastProfile

Represents a DAST Profile.

Fields

Name Type Description
branch DastProfileBranch Associated branch.
dastPreScanVerification DastPreScanVerification DAST Pre Scan Verification associated with the site profile. Will always return null if dast_on_demand_scans_scheduler feature flag is disabled.
dastProfileSchedule DastProfileSchedule Associated profile schedule.
dastScannerProfile DastScannerProfile Associated scanner profile.
dastSiteProfile DastSiteProfile Associated site profile.
description String Description of the scan.
editPath String Relative web path to the edit page of a profile.
id DastProfileID! ID of the profile.
name String Name of the profile.
tagList [String!] Runner tags associated with the profile.

DastProfileBranch

Represents a DAST Profile Branch.

Fields

Name Type Description
exists Boolean Indicates whether or not the branch exists.
name String Name of the branch.

DastProfileCadence

Represents DAST Profile Cadence.

Fields

Name Type Description
duration Int Duration of the DAST profile cadence.
unit DastProfileCadenceUnit Unit for the duration of DAST profile cadence.

DastProfileSchedule

Represents a DAST profile schedule.

Fields

Name Type Description
active Boolean Status of the DAST profile schedule.
cadence DastProfileCadence Cadence of the DAST profile schedule.
id DastProfileScheduleID! ID of the DAST profile schedule.
nextRunAt Time Next run time of the DAST profile schedule in the given timezone.
ownerValid Boolean Status of the current owner of the DAST profile schedule.
startsAt Time Start time of the DAST profile schedule in the given timezone.
timezone String Time zone of the start time of the DAST profile schedule.

DastScannerProfile

Represents a DAST scanner profile.

Fields

Name Type Description
editPath String Relative web path to the edit page of a scanner profile.
id DastScannerProfileID! ID of the DAST scanner profile.
profileName String Name of the DAST scanner profile.
referencedInSecurityPolicies [String!] List of security policy names that are referencing given project.
scanType DastScanTypeEnum Indicates the type of DAST scan that will run. Either a Passive Scan or an Active Scan.
showDebugMessages Boolean! Indicates if debug messages should be included in DAST console output. True to include the debug messages.
spiderTimeout Int Maximum number of minutes allowed for the spider to traverse the site.
tagList {{< icon name=”warning-solid” >}} [String!] Deprecated in GitLab 15.8. Moved to DastProfile.
targetTimeout Int Maximum number of seconds allowed for the site under test to respond to a request.
useAjaxSpider Boolean! Indicates if the AJAX spider should be used to crawl the target site. True to run the AJAX spider in addition to the traditional spider, and false to run only the traditional spider.

DastSiteProfile

Represents a DAST Site Profile.

Fields

Name Type Description
auth DastSiteProfileAuth Target authentication details.
editPath String Relative web path to the edit page of a site profile.
excludedUrls [String!] URLs to skip during an authenticated scan.
id DastSiteProfileID! ID of the site profile.
normalizedTargetUrl String Normalized URL of the target to be scanned.
optionalVariables [JSON!] Optional variables that can be configured for DAST scans.
profileName String Name of the site profile.
referencedInSecurityPolicies [String!] List of security policy names that are referencing given project.
requestHeaders String Comma-separated list of request header names and values to be added to every request made by DAST.
scanFilePath String Scan File Path used as input for the scanner.
scanMethod DastScanMethodType Scan method used by the scanner.
targetType DastTargetTypeEnum Type of target to be scanned.
targetUrl String URL of the target to be scanned.
userPermissions DastSiteProfilePermissions! Permissions for the current user on the resource.
validationStartedAt Time Site profile validation start time.
validationStatus DastSiteProfileValidationStatusEnum Current validation status of the site profile.

DastSiteProfileAuth

DastSiteProfile authentication.

Fields

Name Type Description
enabled Boolean Indicates whether authentication is enabled.
password String Redacted password to authenticate with on the target website.
passwordField String Name of password field at the sign-in HTML form.
submitField String Name or ID of sign-in submit button at the sign-in HTML form.
url String The URL of the page containing the sign-in HTML form on the target website.
username String Username to authenticate with on the target website.
usernameField String Name of username field at the sign-in HTML form.

DastSiteProfilePermissions

Check permissions for the current user on site profile.

Fields

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

DastSiteValidation

Represents a DAST Site Validation.

Fields

Name Type Description
id DastSiteValidationID! Global ID of the site validation.
normalizedTargetUrl String Normalized URL of the target to be validated.
status DastSiteProfileValidationStatusEnum! Status of the site validation.
validationStartedAt Time Timestamp of when the validation started.

DeleteJobsResponse

The response from the AdminSidekiqQueuesDeleteJobs mutation.

Fields

Name Type Description
completed Boolean Whether or not the entire queue was processed in time; if not, retrying the same request is safe.
deletedJobs Int Number of matching jobs deleted.
queueSize Int Queue size after processing.

DeletedNote

Fields

Name Type Description
discussionId DiscussionID ID of the discussion for the deleted note.
id NoteID! ID of the deleted note.
lastDiscussionNote Boolean Whether deleted note is the last note in the discussion.

Dependency

A software dependency used by a project.

Fields

Name Type Description
id GlobalID! ID of the dependency.
licenses [License!] Licenses associated to the dependency.
location Location Information about where the dependency is located.
name String! Name of the dependency.
packager PackageManager Description of the tool used to manage the dependency.
reachability ReachabilityType Information about reachability of a dependency.
version String Version of the dependency.
vulnerabilityCount Int! Number of vulnerabilities within the dependency.

DependencyAggregation

A software dependency aggregation used by a group.

Fields

Name Type Description
id GlobalID! ID of the dependency.
licenses [License!] Licenses associated to the dependency.
location Location Information about where the dependency is located.
name String! Name of the dependency.
occurrenceCount Int! Number of occurrences of the dependency across projects.
packager PackageManager Description of the tool used to manage the dependency.
reachability ReachabilityType Information about reachability of a dependency.
version String Version of the dependency.
vulnerabilityCount Int! Number of vulnerabilities within the dependency.

DependencyPath

Ancestor path of a given dependency.

Fields

Name Type Description
isCyclic Boolean! Indicates if the path is cyclic.
maxDepthReached Boolean! Indicates if the path reached the maximum depth (20).
path [DependencyPathPartial!]! Name of the dependency.

DependencyPathPartial

Ancestor path partial of a given dependency.

Fields

Name Type Description
name String! Name of the dependency.
version String! Version of the dependency.

DependencyProxyBlob

Dependency proxy blob.

Fields

Name Type Description
createdAt Time! Date of creation.
fileName String! Name of the blob.
size String! Size of the blob file.
updatedAt Time! Date of most recent update.

DependencyProxyBlobRegistry

Represents the Geo replication and verification state of a dependency_proxy_blob.

Fields

Name Type Description
checksumMismatch Boolean Indicate if the checksums of the DependencyProxyBlobRegistry do not match on the primary and secondary.
createdAt Time Timestamp when the DependencyProxyBlobRegistry was created.
dependencyProxyBlobId ID! ID of the Dependency Proxy Blob.
forceToRedownload {{< icon name=”warning-solid” >}} Boolean Deprecated in GitLab 17.10. Removed from registry tables in the database in favor of the newer reusable framework.
id ID! ID of the DependencyProxyBlobRegistry.
lastSyncFailure String Error message during sync of the DependencyProxyBlobRegistry.
lastSyncedAt Time Timestamp of the most recent successful sync of the DependencyProxyBlobRegistry.
missingOnPrimary Boolean Indicate if the DependencyProxyBlobRegistry is missing on primary.
modelRecordId Int ID of the DependencyProxyBlobRegistry’s model record.
retryAt Time Timestamp after which the DependencyProxyBlobRegistry is resynced.
retryCount Int Number of consecutive failed sync attempts of the DependencyProxyBlobRegistry.
state RegistryState Sync state of the DependencyProxyBlobRegistry.
verificationChecksum String The local checksum of the DependencyProxyBlobRegistry.
verificationChecksumMismatched String The expected checksum of the DependencyProxyBlobRegistry in case of mismatch.
verificationFailure String Error message during verification of the DependencyProxyBlobRegistry.
verificationRetryAt Time Timestamp after which the DependencyProxyBlobRegistry is reverified.
verificationRetryCount Int Number of consecutive failed verification attempts of the DependencyProxyBlobRegistry.
verificationStartedAt Time Timestamp when the verification of DependencyProxyBlobRegistry started.
verificationState VerificationStateEnum Verification state of the DependencyProxyBlobRegistry.
verifiedAt Time Timestamp of the most recent successful verification of the DependencyProxyBlobRegistry.

DependencyProxyImageTtlGroupPolicy

Group-level Dependency Proxy TTL policy settings.

Fields

Name Type Description
createdAt Time Timestamp of creation.
enabled Boolean! Indicates whether the policy is enabled or disabled.
ttl Int Number of days to retain a cached image file.
updatedAt Time Timestamp of the most recent update.

DependencyProxyManifest

Dependency proxy manifest.

Fields

Name Type Description
createdAt Time! Date of creation.
digest String! Digest of the manifest.
fileName String! Name of the manifest.
id DependencyProxyManifestID! ID of the manifest.
imageName String! Name of the image.
size String! Size of the manifest file.
status DependencyProxyManifestStatus! Status of the manifest (default, pending_destruction, processing, error).
updatedAt Time! Date of most recent update.

DependencyProxyManifestRegistry

Represents the Geo replication and verification state of a dependency_proxy_manifest.

Fields

Name Type Description
checksumMismatch Boolean Indicate if the checksums of the DependencyProxyManifestRegistry do not match on the primary and secondary.
createdAt Time Timestamp when the DependencyProxyManifestRegistry was created.
dependencyProxyManifestId ID! ID of the Dependency Proxy Manifest.
forceToRedownload {{< icon name=”warning-solid” >}} Boolean Deprecated in GitLab 17.10. Removed from registry tables in the database in favor of the newer reusable framework.
id ID! ID of the DependencyProxyManifestRegistry.
lastSyncFailure String Error message during sync of the DependencyProxyManifestRegistry.
lastSyncedAt Time Timestamp of the most recent successful sync of the DependencyProxyManifestRegistry.
missingOnPrimary Boolean Indicate if the DependencyProxyManifestRegistry is missing on primary.
modelRecordId Int ID of the DependencyProxyManifestRegistry’s model record.
retryAt Time Timestamp after which the DependencyProxyManifestRegistry is resynced.
retryCount Int Number of consecutive failed sync attempts of the DependencyProxyManifestRegistry.
state RegistryState Sync state of the DependencyProxyManifestRegistry.
verificationChecksum String The local checksum of the DependencyProxyManifestRegistry.
verificationChecksumMismatched String The expected checksum of the DependencyProxyManifestRegistry in case of mismatch.
verificationFailure String Error message during verification of the DependencyProxyManifestRegistry.
verificationRetryAt Time Timestamp after which the DependencyProxyManifestRegistry is reverified.
verificationRetryCount Int Number of consecutive failed verification attempts of the DependencyProxyManifestRegistry.
verificationStartedAt Time Timestamp when the verification of DependencyProxyManifestRegistry started.
verificationState VerificationStateEnum Verification state of the DependencyProxyManifestRegistry.
verifiedAt Time Timestamp of the most recent successful verification of the DependencyProxyManifestRegistry.

DependencyProxyPackagesSetting

Project-level Dependency Proxy for packages settings.

Fields

Name Type Description
enabled Boolean! Indicates whether the dependency proxy for packages is enabled for the project.
mavenExternalRegistryUrl String URL for the external Maven packages registry.
mavenExternalRegistryUsername String Username for the external Maven packages registry.

DependencyProxySetting

Group-level Dependency Proxy settings.

Fields

Name Type Description
enabled Boolean! Indicates whether the dependency proxy is enabled for the group.
identity String Identity credential used to authenticate with Docker Hub when pulling images. Can be a username (for password or personal access token (PAT)) or organization name (for organization access token (OAT)).

Deployment

The deployment of an environment.

Fields

Name Type Description
approvalSummary DeploymentApprovalSummary Approval summary of the deployment.This field can only be resolved for one deployment in any single request.
approvals [DeploymentApproval!] Current approvals of the deployment.
commit Commit Commit details of the deployment.
createdAt Time When the deployment record was created.
finishedAt Time When the deployment finished.
id ID Global ID of the deployment.
iid String Project-level internal ID of the deployment.
job CiJob Pipeline job of the deployment.
pendingApprovalCount Int Number of pending unified approvals on the deployment.
ref String Git-Ref that the deployment ran on.
refPath String Path to the Git-Ref that the deployment ran on.
sha String Git-SHA that the deployment ran on.
status DeploymentStatus Status of the deployment.
tag Boolean True or false if the deployment ran on a Git-tag.
tags [DeploymentTag!] Git tags that contain this deployment. This field can only be resolved for two deployments in any single request.
triggerer UserCore User who executed the deployment.
updatedAt Time When the deployment record was updated.
userPermissions DeploymentPermissions! Permissions for the current user on the resource.
webPath String Web path to the deployment page.

DeploymentApproval

Approval of the deployment.

Fields

Name Type Description
comment String Additional comment.
createdAt Time When the user approved/rejected first time.
status DeploymentsApprovalStatus Whether the deployment was approved/rejected.
updatedAt Time When the user updated the approval.
user UserCore User who approved or rejected the deployment.

DeploymentApprovalSummary

Approval summary of the deployment.

Fields

Name Type Description
rules [ProtectedEnvironmentApprovalRuleForSummary!] Approval Rules for the deployment.
status DeploymentApprovalSummaryStatus Status of the approvals.
totalPendingApprovalCount Int Total pending approval count.
totalRequiredApprovals Int Total number of required approvals.

DeploymentPermissions

Fields

Name Type Description
approveDeployment Boolean! Indicates the user can perform approve_deployment on this resource. This field can only be resolved for one environment in any single request.
destroyDeployment Boolean! If true, the user can perform destroy_deployment on this resource.
updateDeployment Boolean! If true, the user can perform update_deployment on this resource.

DeploymentTag

Tags for a given deployment.

Fields

Name Type Description
name String Name of the git tag.
path String Path for the tag.
webPath String Web path for the tag.

DescriptionVersion

Fields

Name Type Description
canDelete {{< icon name=”warning-solid” >}} Boolean Deprecated in GitLab 15.7. For backwards compatibility with REST API version and to be removed in a next iteration.
deletePath {{< icon name=”warning-solid” >}} String Deprecated in GitLab 15.7. For backwards compatibility with REST API version and to be removed in a next iteration.
deleted {{< icon name=”warning-solid” >}} Boolean Deprecated in GitLab 15.7. For backwards compatibility with REST API version and to be removed in a next iteration.
description String Content of the given description version.
diffPath {{< icon name=”warning-solid” >}} String Deprecated in GitLab 15.7. For backwards compatibility with REST API version and to be removed in a next iteration.
id DescriptionVersionID! ID of the description version.

Fields with arguments

DescriptionVersion.diff

Description diff between versions.

Returns String.

Arguments
Name Type Description
versionId DescriptionVersionID ID of a previous version to compare. If not specified first previous version is used.

Design

A single design.

Fields

Name Type Description
commenters UserCoreConnection! All commenters on the noteable. (see Connections)
description String Description of the design.
descriptionHtml String GitLab Flavored Markdown rendering of description.
diffRefs DiffRefs! Diff refs for the design.
discussions DiscussionConnection! All discussions on the noteable. (see Connections)
event DesignVersionEvent! How the design was changed in the current version.
filename String! Filename of the design.
fullPath ID! Full path to the design file.
id ID! ID of the design.
image String! URL of the full-sized image.
imageV432x230 String The URL of the design resized to fit within the bounds of 432x230. This will be null if the image has not been generated.
imported Boolean! Indicates whether the design was imported.
importedFrom ImportSource! Import source of the design.
issue Issue! Issue the design belongs to.
name String Name or title of the object.
notesCount Int! Total count of user-created notes for the design.
project Project! Project the design belongs to.
webUrl String! URL of the design.

Fields with arguments

Design.currentUserTodos

To-do items for the current user.

Returns TodoConnection!.

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

Arguments
Name Type Description
state TodoStateEnum State of the to-do items.
Design.notes

All notes on this noteable.

Returns NoteConnection!.

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

Arguments
Name Type Description
filter NotesFilterType Type of notes collection: ALL_NOTES, ONLY_COMMENTS, ONLY_ACTIVITY.
Design.versions

All versions related to this design ordered newest first.

Returns DesignVersionConnection!.

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

Arguments
Name Type Description
earlierOrEqualToId DesignManagementVersionID Global ID of the most recent acceptable version.
earlierOrEqualToSha String SHA256 of the most recent acceptable version.

DesignAtVersion

A design pinned to a specific version. The image field reflects the design as of the associated version.

Fields

Name Type Description
design Design! Underlying design.
diffRefs DiffRefs! Diff refs for the design.
event DesignVersionEvent! How the design was changed in the current version.
filename String! Filename of the design.
fullPath ID! Full path to the design file.
id ID! ID of the design.
image String! URL of the full-sized image.
imageV432x230 String The URL of the design resized to fit within the bounds of 432x230. This will be null if the image has not been generated.
issue Issue! Issue the design belongs to.
notesCount Int! Total count of user-created notes for the design.
project Project! Project the design belongs to.
version DesignVersion! Version the design-at-versions is pinned to.

DesignCollection

A collection of designs.

Fields

Name Type Description
copyState DesignCollectionCopyState Copy state of the design collection.
issue Issue! Issue associated with the design collection.
project Project! Project associated with the design collection.

Fields with arguments

DesignCollection.design

Find a specific design.

Returns Design.

Arguments
Name Type Description
filename String Find a design by its filename.
id DesignManagementDesignID Find a design by its ID.
DesignCollection.designAtVersion

Find a design as of a version.

Returns DesignAtVersion.

Arguments
Name Type Description
id DesignManagementDesignAtVersionID! Global ID of the design at 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
Name Type Description
atVersion DesignManagementVersionID Filters designs to only those that existed at the version. If argument is omitted or nil then all designs will reflect the latest version.
filenames [String!] Filters designs by their filename.
ids [DesignManagementDesignID!] Filters designs by their ID.
DesignCollection.version

A specific version.

Returns DesignVersion.

Arguments
Name Type Description
id DesignManagementVersionID Global ID of the version.
sha String SHA256 of a specific version.
DesignCollection.versions

All versions related to all designs, ordered newest first.

Returns DesignVersionConnection!.

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

Arguments
Name Type Description
earlierOrEqualToId DesignManagementVersionID Global ID of the most recent acceptable version.
earlierOrEqualToSha String SHA256 of the most recent acceptable version.

DesignManagement

Fields with arguments

DesignManagement.designAtVersion

Find a design as of a version.

Returns DesignAtVersion.

Arguments
Name Type Description
id DesignManagementDesignAtVersionID! Global ID of the design at the version.
DesignManagement.version

Find a version.

Returns DesignVersion.

Arguments
Name Type Description
id DesignManagementVersionID! Global ID of the version.

DesignManagementRepositoryRegistry

Represents the Geo replication and verification state of a Design Management Repository.

Fields

Name Type Description
checksumMismatch Boolean Indicate if the checksums of the DesignManagementRepositoryRegistry do not match on the primary and secondary.
createdAt Time Timestamp when the DesignManagementRepositoryRegistry was created.
designManagementRepositoryId ID! ID of the Design Management Repository.
forceToRedownload {{< icon name=”warning-solid” >}} Boolean Deprecated in GitLab 17.10. Removed from registry tables in the database in favor of the newer reusable framework.
id ID! ID of the DesignManagementRepositoryRegistry.
lastSyncFailure String Error message during sync of the DesignManagementRepositoryRegistry.
lastSyncedAt Time Timestamp of the most recent successful sync of the DesignManagementRepositoryRegistry.
missingOnPrimary Boolean Indicate if the DesignManagementRepositoryRegistry is missing on primary.
modelRecordId Int ID of the DesignManagementRepositoryRegistry’s model record.
retryAt Time Timestamp after which the DesignManagementRepositoryRegistry is resynced.
retryCount Int Number of consecutive failed sync attempts of the DesignManagementRepositoryRegistry.
state RegistryState Sync state of the DesignManagementRepositoryRegistry.
verificationChecksum String The local checksum of the DesignManagementRepositoryRegistry.
verificationChecksumMismatched String The expected checksum of the DesignManagementRepositoryRegistry in case of mismatch.
verificationFailure String Error message during verification of the DesignManagementRepositoryRegistry.
verificationRetryAt Time Timestamp after which the DesignManagementRepositoryRegistry is reverified.
verificationRetryCount Int Number of consecutive failed verification attempts of the DesignManagementRepositoryRegistry.
verificationStartedAt Time Timestamp when the verification of DesignManagementRepositoryRegistry started.
verificationState VerificationStateEnum Verification state of the DesignManagementRepositoryRegistry.
verifiedAt Time Timestamp of the most recent successful verification of the DesignManagementRepositoryRegistry.

DesignVersion

A specific version in which designs were added, modified or deleted.

Fields

Name Type Description
author UserCore! Author of the version.
createdAt Time! Timestamp of when the version was created.
designs DesignConnection! All designs that were changed in the version. (see Connections)
id ID! ID of the design version.
sha ID! SHA of the design version.

Fields with arguments

DesignVersion.designAtVersion

A particular design as of this version, provided it is visible at this version.

Returns DesignAtVersion!.

Arguments
Name Type Description
designId DesignManagementDesignID ID of a specific design.
filename String Filename of a specific design.
id DesignManagementDesignAtVersionID ID of the DesignAtVersion.
DesignVersion.designsAtVersion

All designs that are visible at this version, as of this version.

Returns DesignAtVersionConnection!.

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

Arguments
Name Type Description
filenames [String!] Filters designs by their filename.
ids [DesignManagementDesignID!] Filters designs by their ID.

DetailedImportStatus

Details of the import status of a project.

Fields

Name Type Description
id ProjectImportStateID ID of the import state.
lastError String Last error of the import.
lastSuccessfulUpdateAt Time Time of the last successful update.
lastUpdateAt Time Time of the last update.
lastUpdateStartedAt Time Time of the start of the last update.
status String Current status of the import.
url String Import url.

DetailedStatus

Fields

Name Type Description
action StatusAction Action information for the status. This includes method, button title, icon, path, and title.
deploymentDetailsPath String Path of the deployment details for the status.
detailsPath String Path of the details for the status.
favicon String Favicon of the status.
group {{< icon name=”warning-solid” >}} String Deprecated in GitLab 16.4. The group attribute is deprecated. Use name instead.
hasDetails Boolean Indicates if the status has further details.
icon {{< icon name=”warning-solid” >}} String Deprecated in GitLab 16.4. The icon attribute is deprecated. Use name to identify the status to display instead.
id String! ID for a detailed status.
label String Human-readable label of the status (e.g. success).
name String Machine-readable status name (e.g. SUCCESS).
text {{< icon name=”warning-solid” >}} String Deprecated in GitLab 16.4. The text attribute is being deprecated. Use label instead.
tooltip String Tooltip associated with the status.

DevopsAdoptionEnabledNamespace

Enabled namespace for DevopsAdoption.

Fields

Name Type Description
displayNamespace Namespace Namespace where data should be displayed.
id ID! ID of the enabled namespace.
latestSnapshot DevopsAdoptionSnapshot Metrics snapshot for previous month for the enabled namespace.
namespace Namespace Namespace which should be calculated.

Fields with arguments

DevopsAdoptionEnabledNamespace.snapshots

Data snapshots of the namespace.

Returns DevopsAdoptionSnapshotConnection.

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

Arguments
Name Type Description
endTimeAfter Time Filter to snapshots with month end after the provided date.
endTimeBefore Time Filter to snapshots with month end before the provided date.

DevopsAdoptionSnapshot

Snapshot.

Fields

Name Type Description
codeOwnersUsedCount Int Total number of projects with existing CODEOWNERS file.
coverageFuzzingEnabledCount Int Total number of projects with enabled coverage fuzzing.
dastEnabledCount Int Total number of projects with enabled DAST.
dependencyScanningEnabledCount Int Total number of projects with enabled dependency scanning.
deploySucceeded Boolean! At least one deployment succeeded.
endTime Time! End time for the snapshot where the data points were collected.
issueOpened Boolean! At least one issue was opened.
mergeRequestApproved Boolean! At least one merge request was approved.
mergeRequestOpened Boolean! At least one merge request was opened.
pipelineSucceeded Boolean! At least one pipeline succeeded.
recordedAt Time! Time the snapshot was recorded.
runnerConfigured Boolean! At least one runner was used.
sastEnabledCount Int Total number of projects with enabled SAST.
startTime Time! Start time for the snapshot where the data points were collected.
totalProjectsCount Int Total number of projects.
vulnerabilityManagementUsedCount Int Total number of projects with vulnerability management used at least once.

Diff

Fields

Name Type Description
aMode String Old file mode of the file.
bMode String New file mode of the file.
deletedFile String Indicates if the file has been removed.
diff String Diff representation of the changes made to the file.
newFile String Indicates if the file has just been added.
newPath String New path of the file.
oldPath String Old path of the file.
renamedFile String Indicates if the file has been renamed.

DiffPosition

Fields

Name Type Description
diffRefs DiffRefs! Information about the branch, HEAD, and base at the time of commenting.
filePath String! Path of the file that was changed.
height Int Total height of the image.
newLine Int Line on HEAD SHA that was changed.
newPath String Path of the file on the HEAD SHA.
oldLine Int Line on start SHA that was changed.
oldPath String Path of the file on the start SHA.
positionType DiffPositionType! Type of file the position refers to.
width Int Total width of the image.
x Int X position of the note.
y Int Y position of the note.

DiffRefs

Fields

Name Type Description
baseSha String Merge base of the branch the comment was made on.
headSha String! SHA of the HEAD at the time the comment was made.
startSha String! SHA of the branch being compared against.

DiffStats

Changes to a single file.

Fields

Name Type Description
additions Int! Number of lines added to the file.
deletions Int! Number of lines deleted from the file.
path String! File path, relative to repository root.

DiffStatsSummary

Aggregated summary of changes.

Fields

Name Type Description
additions Int! Number of lines added.
changes Int! Number of lines changed.
deletions Int! Number of lines deleted.
fileCount Int! Number of files changed.

Discussion

Fields

Name Type Description
createdAt Time! Timestamp of the discussion’s creation.
id DiscussionID! ID of the discussion.
noteable NoteableType Object which the discussion belongs to.
notes NoteConnection! All notes in the discussion. (see Connections)
replyId DiscussionID! ID used to reply to the discussion.
resolvable Boolean! Indicates if the object can be resolved.
resolved Boolean! Indicates if the object is resolved.
resolvedAt Time Timestamp of when the object was resolved.
resolvedBy UserCore User who resolved the object.
userPermissions DiscussionPermissions! Permissions for the current user on the resource.

DiscussionPermissions

Fields

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

Dora

All information related to DORA metrics.

Fields with arguments

Dora.metrics

DORA metrics for the current group or project.

Returns [DoraMetric!].

Arguments
Name Type Description
endDate Date Date range to end at. Default is the current date.
environmentTiers [DeploymentTier!] Deployment tiers of the environments to return. Defaults to [PRODUCTION].
interval DoraMetricBucketingInterval How the metric should be aggregated. Defaults to DAILY. In the case of ALL, the date field in the response will be null.
startDate Date Date range to start from. Default is 3 months ago.

DoraMetric

Fields

Name Type Description
changeFailureRate Float Percentage of deployments that caused incidents in production.
date String Date of the data point.
deploymentFrequency Float Number of deployments per day.
leadTimeForChanges Float Median time to deploy a merged merge request.
timeToRestoreService Float Median time to close an incident.

DoraPerformanceScoreCount

Aggregated DORA score counts for projects for the last complete month.

Fields

Name Type Description
highProjectsCount Int Number of projects that score “high” on the metric.
lowProjectsCount Int Number of projects that score “low” on the metric.
mediumProjectsCount Int Number of projects that score “medium” on the metric.
metricName String! Name of the DORA metric.
noDataProjectsCount Int Number of projects with no data for the metric.

DuoSettings

GitLab Duo settings.

Fields

Name Type Description
aiGatewayUrl {{< icon name=”warning-solid” >}} String Introduced in GitLab 17.9. Status: Experiment. URL for local AI gateway server.
duoCoreFeaturesEnabled {{< icon name=”warning-solid” >}} Boolean Introduced in GitLab 18.0. Status: Experiment. Indicates whether GitLab Duo Core features are enabled.
updatedAt {{< icon name=”warning-solid” >}} Time! Introduced in GitLab 17.9. Status: Experiment. Timestamp of last GitLab Duo setting update.

DuoWorkflow

A Duo Workflow.

Fields

Name Type Description
createdAt Time! Timestamp of when the workflow was created.
goal String Goal of the workflow.
humanStatus String! Human-readable status of the workflow.
id ID! ID of the workflow.
projectId ProjectID! ID of the project.
updatedAt Time! Timestamp of when the workflow was last updated.
userId UserID! ID of the user.
workflowDefinition String Duo Workflow type based on its capabilities.

DuoWorkflowEnablement

Duo Workflow enablement status checks.

Fields

Name Type Description
checks [DuoWorkflowEnablementCheck!] Enablement checks.
enabled Boolean! Indicates whether GitLab Duo Workflow is enabled for current user and the project.

DuoWorkflowEnablementCheck

Represents single Duo Workflow enablement check.

Fields

Name Type Description
message String Description of status check.
name String! Name of the status check.
value Boolean! Whether the check was successful or not.

DuoWorkflowEvent

Events that describe the history and progress of a Duo Workflow.

Fields

Name Type Description
checkpoint JsonString Checkpoint of the event.
errors [String!] Message errors.
executionStatus {{< icon name=”warning-solid” >}} String! Introduced in GitLab 17.10. Status: Experiment. Granular status of workflow execution.
metadata JsonString Metadata associated with the event.
parentTimestamp Time Time of the parent event.
timestamp Time Time of the event.
workflowDefinition String Duo Workflow type based on its capabilities.
workflowGoal String Goal of the workflow.
workflowStatus DuoWorkflowStatus Status of the workflow.

EgressNode

Fields

Name Type Description
artifactsEgress BigInt! Artifacts egress for that project in that period of time.
date String! First day of the node range. There is one node per month.
packagesEgress BigInt! Packages egress for that project in that period of time.
registryEgress BigInt! Registry egress for that project in that period of time.
repositoryEgress BigInt! Repository egress for that project in that period of time.
totalEgress BigInt! Total egress for that project in that period of time.

Email

Fields

Name Type Description
confirmedAt Time Timestamp the email was confirmed.
createdAt Time! Timestamp the email was created.
email String! Email address.
id ID! Internal ID of the email.
updatedAt Time! Timestamp the email was last updated.

EmailParticipantType

Fields

Name Type Description
email String! Email address of the email participant. For guests, the email address is obfuscated.

Environment

Describes where code is deployed for a project.

Fields

Name Type Description
autoDeleteAt Time When the environment is going to be deleted automatically.
autoStopAt Time When the environment is going to be stopped automatically.
autoStopSetting AutoStopSetting Auto stop setting of the environment.
clusterAgent ClusterAgent Cluster agent of the environment.
createdAt Time When the environment was created.
deployFreezes [CiFreezePeriod!] Deployment freeze periods of the environment.
deploymentsDisplayCount String Number of deployments in the environment for display. Returns the precise number up to 999, and “999+” for counts exceeding this limit.
description String Description of the environment.
descriptionHtml String GitLab Flavored Markdown rendering of description.
environmentType String Folder name of the environment.
externalUrl String External URL of the environment.
fluxResourcePath String Flux resource path of the environment.
id ID! ID of the environment.
kubernetesNamespace String Kubernetes namespace of the environment.
latestOpenedMostSevereAlert AlertManagementAlert Most severe open alert for the environment. If multiple alerts have equal severity, the most recent is returned.
name String! Human-readable name of the environment.
path String! Path to the environment.
protectedEnvironments ProtectedEnvironmentConnection Protected Environments for the environment. (see Connections)
slug String Slug of the environment.
state String! State of the environment, for example: available/stopped.
tier DeploymentTier Deployment tier of the environment.
updatedAt Time When the environment was updated.
userPermissions EnvironmentPermissions! Permissions for the current user on the resource. This field can only be resolved for one environment in any single request.

Fields with arguments

Environment.deployments

Deployments of the environment. This field can only be resolved for one environment in any single request.

Returns DeploymentConnection.

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

Arguments
Name Type Description
orderBy DeploymentsOrderByInput Order by a specified field.
statuses [DeploymentStatus!] Statuses of the deployments.
Environment.lastDeployment

Last deployment of the environment.

Returns Deployment.

Arguments
Name Type Description
status DeploymentStatus! Status of the Deployment.

EnvironmentPermissions

Fields

Name Type Description
destroyEnvironment Boolean! If true, the user can perform destroy_environment on this resource.
stopEnvironment Boolean! If true, the user can perform stop_environment on this resource.
updateEnvironment Boolean! If true, the user can perform update_environment on this resource.

Epic

Represents an epic.

Fields

Name Type Description
author UserCore! Author of the epic.
awardEmoji AwardEmojiConnection List of emoji reactions associated with the epic. (see Connections)
blocked Boolean Indicates the epic is blocked.
blockedByCount Int Count of epics blocking the epic.
blockedByEpics EpicConnection Epics blocking the epic. (see Connections)
blockingCount Int Count of epics that the epic is blocking.
closedAt Time Timestamp of when the epic was closed.
color String Color of the epic.
commenters UserCoreConnection! All commenters on the noteable. (see Connections)
confidential Boolean Indicates if the epic is confidential.
createdAt Time Timestamp of when the epic was created.
defaultProjectForIssueCreation Project Default Project for issue creation. Based on the project the user created the last issue in.
descendantCounts EpicDescendantCount Number of open and closed descendant epics and issues.
descendantWeightSum EpicDescendantWeights Total weight of open and closed issues in the epic and its descendants.
description String Description of the epic.
descriptionHtml String GitLab Flavored Markdown rendering of description.
discussions DiscussionConnection! All discussions on the noteable. (see Connections)
downvotes Int! Number of downvotes the epic has received.
dueDate Time Due date of the epic.
dueDateFixed Time Fixed due date of the epic.
dueDateFromInheritedSource Time Inherited due date of the epic from child epics or milestones.
dueDateFromMilestones Time Inherited due date of the epic from milestones.
dueDateIsFixed Boolean Indicates if the due date has been manually set.
events EventConnection List of events associated with the object. (see Connections)
group Group! Group to which the epic belongs.
hasChildren Boolean! Indicates if the epic has children.
hasChildrenWithinTimeframe Boolean! Indicates if the epic has children in the specified timeframe.
hasIssues Boolean! Indicates if the epic has direct issues.
hasParent Boolean! Indicates if the epic has a parent epic.
healthStatus EpicHealthStatus Current health status of the epic.
id ID! ID of the epic.
iid String! Internal ID of the epic.
issues EpicIssueConnection A list of issues associated with the epic. (see Connections)
labels LabelConnection Labels assigned to the epic. (see Connections)
name String Name or title of the object.
parent Epic Parent epic of the epic.
participants UserCoreConnection List of participants for the epic. (see Connections)
relationPath String URI path of the epic-issue relationship.
relativePosition Int Relative position of the epic in the epic tree.
startDate Time Start date of the epic.
startDateFixed Time Fixed start date of the epic.
startDateFromInheritedSource Time Inherited start date of the epic from child epics or milestones.
startDateFromMilestones Time Inherited start date of the epic from milestones.
startDateIsFixed Boolean Indicates if the start date has been manually set.
state EpicState! State of the epic.
subscribed Boolean! Indicates the currently logged in user is subscribed to the epic.
textColor String Text color generated for the epic.
title String Title of the epic.
titleHtml String GitLab Flavored Markdown rendering of title.
updatedAt Time Timestamp of when the epic was updated.
upvotes Int! Number of upvotes the epic has received.
userDiscussionsCount Int! Number of user discussions in the epic.
userNotesCount Int! Number of user notes of the epic.
userPermissions EpicPermissions! Permissions for the current user on the resource.
webPath String! Web path of the epic.
webUrl String! Web URL of the epic.

Fields with arguments

Epic.ancestors

Ancestors (parents) of the epic.

Returns EpicConnection.

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

Arguments
Name Type Description
authorUsername String Filter epics by author.
confidential Boolean Filter epics by given confidentiality.
createdAfter Time Epics created after the date.
createdBefore Time Epics created before the date.
customField {{< icon name=”warning-solid” >}} [WorkItemWidgetCustomFieldFilterInputType!] Introduced in GitLab 17.10. Status: Experiment. Filter by custom fields.
iid ID IID of the epic, e.g., “1”.
iidStartsWith String Filter epics by IID for autocomplete.
iids [ID!] List of IIDs of epics, e.g., [1, 2].
in [IssuableSearchableField!] Specify the fields to perform the search in. Defaults to [TITLE, DESCRIPTION]. Requires the search argument.’.
includeAncestorGroups Boolean Include epics from ancestor groups.
includeDescendantGroups Boolean Include epics from descendant groups.
labelName [String!] Filter epics by labels.
milestoneTitle String Filter epics by milestone title, computed from epic’s issues.
myReactionEmoji String Filter by reaction emoji applied by the current user.
not NegatedEpicFilterInput Negated epic arguments.
or UnionedEpicFilterInput List of arguments with inclusive OR.
search String Search query for title or description.
sort EpicSort List epics by sort order.
state EpicState Filter epics by state.
subscribed SubscriptionStatus Epics the current user is subscribed to.
timeframe Timeframe List items overlapping the given timeframe.
topLevelHierarchyOnly Boolean Filter epics with a top-level hierarchy.
updatedAfter Time Epics updated after the date.
updatedBefore Time Epics updated before the date.
Epic.children

Children (sub-epics) of the epic.

Returns EpicConnection.

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

Arguments
Name Type Description
authorUsername String Filter epics by author.
confidential Boolean Filter epics by given confidentiality.
createdAfter Time Epics created after the date.
createdBefore Time Epics created before the date.
customField {{< icon name=”warning-solid” >}} [WorkItemWidgetCustomFieldFilterInputType!] Introduced in GitLab 17.10. Status: Experiment. Filter by custom fields.
iid ID IID of the epic, e.g., “1”.
iidStartsWith String Filter epics by IID for autocomplete.
iids [ID!] List of IIDs of epics, e.g., [1, 2].
in [IssuableSearchableField!] Specify the fields to perform the search in. Defaults to [TITLE, DESCRIPTION]. Requires the search argument.’.
includeAncestorGroups Boolean Include child epics from ancestor groups.
includeDescendantGroups Boolean Include epics from descendant groups.
labelName [String!] Filter epics by labels.
milestoneTitle String Filter epics by milestone title, computed from epic’s issues.
myReactionEmoji String Filter by reaction emoji applied by the current user.
not NegatedEpicFilterInput Negated epic arguments.
or UnionedEpicFilterInput List of arguments with inclusive OR.
search String Search query for title or description.
sort EpicSort List epics by sort order.
state EpicState Filter epics by state.
subscribed SubscriptionStatus Epics the current user is subscribed to.
timeframe Timeframe List items overlapping the given timeframe.
topLevelHierarchyOnly Boolean Filter epics with a top-level hierarchy.
updatedAfter Time Epics updated after the date.
updatedBefore Time Epics updated before the date.
Epic.currentUserTodos

To-do items for the current user.

Returns TodoConnection!.

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

Arguments
Name Type Description
state TodoStateEnum State of the to-do items.
Epic.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
Name Type Description
filter WorkItemRelatedLinkType Filter 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
Name Type Description
filter NotesFilterType Type of notes collection: ALL_NOTES, ONLY_COMMENTS, ONLY_ACTIVITY.
Epic.reference

Internal reference of the epic. Returned in shortened format by default.

Returns String!.

Arguments
Name Type Description
full Boolean Indicates if the reference should be returned in full.

EpicBoard

Represents an epic board.

Fields

Name Type Description
displayColors Boolean Whether or not display epic colors.
hideBacklogList Boolean Whether or not backlog list is hidden.
hideClosedList Boolean Whether or not closed list is hidden.
id BoardsEpicBoardID! Global ID of the epic board.
labels LabelConnection Labels of the board. (see Connections)
name String Name of the epic board.
webPath String! Web path of the epic board.
webUrl String! Web URL of the epic board.

Fields with arguments

EpicBoard.lists

Epic board lists.

Returns EpicListConnection.

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

Arguments
Name Type Description
epicFilters EpicFilters Filters applied when getting epic metadata in the epic board list.
id BoardsEpicListID Find an epic board list by ID.

EpicDescendantCount

Counts of descendent epics.

Fields

Name Type Description
closedEpics Int Number of closed child epics.
closedIssues Int Number of closed epic issues.
openedEpics Int Number of opened child epics.
openedIssues Int Number of opened epic issues.

EpicDescendantWeights

Total weight of open and closed descendant issues.

Fields

Name Type Description
closedIssues {{< icon name=”warning-solid” >}} Int Deprecated in GitLab 16.6. Use closedIssuesTotal.
closedIssuesTotal BigInt Total weight of completed (closed) issues in this epic, including epic descendants, encoded as a string.
openedIssues {{< icon name=”warning-solid” >}} Int Deprecated in GitLab 16.6. Use OpenedIssuesTotal.
openedIssuesTotal BigInt Total weight of opened issues in the epic, including epic descendants, encoded as a string.

EpicHealthStatus

Health status of child issues.

Fields

Name Type Description
issuesAtRisk Int Number of issues at risk.
issuesNeedingAttention Int Number of issues that need attention.
issuesOnTrack Int Number of issues on track.

EpicIssue

Relationship between an epic and an issue.

Fields

Name Type Description
alertManagementAlert {{< icon name=”warning-solid” >}} AlertManagementAlert Deprecated in GitLab 15.6. Use alert_management_alerts.
assignees UserCoreConnection Assignees of the issue. (see Connections)
author UserCore! User that created the issue.
blocked Boolean! Indicates the issue is blocked.
blockedByCount Int Count of issues blocking the issue.
blockedByIssues IssueConnection Issues blocking the issue. (see Connections)
blockingCount Int! Count of issues the issue is blocking.
closedAsDuplicateOf Issue Issue the issue was closed as a duplicate of.
closedAt Time Timestamp of when the issue was closed.
commenters UserCoreConnection! All commenters on the noteable. (see Connections)
confidential Boolean! Indicates the issue is confidential.
createNoteEmail String User specific email address for the issue.
createdAt Time! Timestamp of when the issue was created.
customerRelationsContacts CustomerRelationsContactConnection Customer relations contacts of the issue. (see Connections)
description String Description of the issue.
descriptionHtml String GitLab Flavored Markdown rendering of description.
designCollection DesignCollection Collection of design images associated with the issue.
discussionLocked Boolean! Indicates discussion is locked on the issue.
discussions DiscussionConnection! All discussions on the noteable. (see Connections)
downvotes Int! Number of downvotes the issue has received.
dueDate Time Due date of the issue.
emailsDisabled {{< icon name=”warning-solid” >}} Boolean! Deprecated in GitLab 16.3. Use emails_enabled.
emailsEnabled Boolean! Indicates if the parent project or group has email notifications disabled: false if email notifications are disabled.
epic {{< icon name=”warning-solid” >}} Epic Deprecated in GitLab 17.5. Replaced by WorkItem type.
epicIssueId ID! ID of the epic-issue relation.
escalationPolicy EscalationPolicyType Escalation policy associated with the issue. Available for issues which support escalation.
escalationStatus IssueEscalationStatus Escalation status of the issue.
externalAuthor String Email address of non-GitLab user reporting the issue. For guests, the email address is obfuscated.
hasEpic Boolean! Indicates if the issue belongs to an epic. Can return true and not show an associated epic when the user has no access to the epic.
hasParent {{< icon name=”warning-solid” >}} Boolean! Introduced in GitLab 16.5. Status: Experiment. Indicates if the issue has a parent work item.
healthStatus HealthStatus Current health status.
hidden Boolean Indicates the issue is hidden because the author has been banned.
humanTimeEstimate String Human-readable time estimate of the issue.
humanTotalTimeSpent String Human-readable total time reported as spent on the issue.
id ID Global ID of the epic-issue relation.
iid String! Internal ID of the issue.
iteration Iteration Iteration of the issue.
labels LabelConnection Labels of the issue. (see Connections)
mergeRequestsCount Int! Number of merge requests that close the issue on merge.
metricImages [MetricImage!] Metric images associated to the issue.
milestone Milestone Milestone of the issue.
moved Boolean Indicates if issue got moved from other project.
movedTo Issue Updated Issue after it got moved to another project.
name String Name or title of the object.
participants UserCoreConnection List of participants in the issue. (see Connections)
projectId Int ID of the issue project.
relatedMergeRequests MergeRequestConnection Merge requests related to the issue. This field can only be resolved for one issue in any single request. (see Connections)
relatedVulnerabilities VulnerabilityConnection Related vulnerabilities of the issue. (see Connections)
relationPath String URI path of the epic-issue relation.
relativePosition Int Relative position of the issue (used for positioning in epic tree and issue boards).
severity IssuableSeverity Severity level of the incident.
slaDueAt Time Timestamp of when the issue SLA expires.
state IssueState! State of the issue.
status {{< icon name=”warning-solid” >}} WorkItemStatus Introduced in GitLab 18.0. Status: Experiment. Status of the issue.
statusPagePublishedIncident Boolean Indicates whether an issue is published to the status page.
subscribed Boolean! Indicates the currently logged in user is subscribed to the issue.
taskCompletionStatus TaskCompletionStatus! Task completion status of the issue.
timeEstimate Int! Time estimate of the issue.
timelogs TimelogConnection! Timelogs on the issue. (see Connections)
title String! Title of the issue.
titleHtml String GitLab Flavored Markdown rendering of title.
totalTimeSpent Int! Total time (in seconds) reported as spent on the issue.
type IssueType Type of the issue.
updatedAt Time! Timestamp of when the issue was last updated.
updatedBy UserCore User that last updated the issue.
upvotes Int! Number of upvotes the issue has received.
userDiscussionsCount Int! Number of user discussions in the issue.
userNotesCount Int! Number of user notes of the issue.
userPermissions IssuePermissions! Permissions for the current user on the resource.
webPath String! Web path of the issue.
webUrl String! Web URL of the issue.
weight Int Weight of the issue.

Fields with arguments

EpicIssue.alertManagementAlerts

Alert Management alerts associated to this issue.

Returns AlertManagementAlertConnection.

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

Arguments
Name Type Description
assigneeUsername String Username of a user assigned to the issue.
domain AlertManagementDomainFilter! Filter query for given domain.
iid String IID of the alert. For example, “1”.
search String Search query for title, description, service, or monitoring_tool.
sort AlertManagementAlertSort Sort alerts by 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
Name Type Description
state TodoStateEnum State 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
Name Type Description
incidentId IssueID! ID of the incident.
EpicIssue.linkedWorkItems

Work items linked to the issue.

{{< details >}} Introduced in GitLab 17.8. Status: Experiment. {{< /details >}}

Returns LinkedWorkItemTypeConnection.

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

Arguments
Name Type Description
filter WorkItemRelatedLinkType Filter by link type. Supported values: RELATED, BLOCKED_BY, and BLOCKS. Returns all types if omitted.
EpicIssue.notes

All notes on this noteable.

Returns NoteConnection!.

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

Arguments
Name Type Description
filter NotesFilterType Type of notes collection: ALL_NOTES, ONLY_COMMENTS, ONLY_ACTIVITY.
EpicIssue.reference

Internal reference of the issue. Returned in shortened format by default.

Returns String!.

Arguments
Name Type Description
full Boolean Boolean option specifying whether the reference should be returned in full.

EpicList

Represents an epic board list.

Fields

Name Type Description
collapsed Boolean Indicates if the list is collapsed for the user.
id BoardsEpicListID! Global ID of the board list.
label Label Label of the list.
listType String! Type of the list.
metadata EpicListMetadata Epic list metatada.
position Int Position of the list within the board.
title String! Title of the list.

Fields with arguments

EpicList.epics

List epics.

Returns EpicConnection.

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

Arguments
Name Type Description
filters EpicFilters Filters applied when selecting epics in the board list.

EpicListMetadata

Represents epic board list metadata.

Fields

Name Type Description
epicsCount Int Count of epics in the list.
totalWeight {{< icon name=”warning-solid” >}} Int Introduced 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

Name Type Description
adminEpic Boolean! If true, the user can perform admin_epic on this resource.
adminEpicRelation Boolean! If true, the user can perform admin_epic_relation on this resource.
awardEmoji Boolean! If true, the user can perform award_emoji on this resource.
createEpic Boolean! If true, the user can perform create_epic on this resource.
createNote Boolean! If true, the user can perform create_note on this resource.
destroyEpic Boolean! If true, the user can perform destroy_epic on this resource.
readEpic Boolean! If true, the user can perform read_epic on this resource.
readEpicIid Boolean! If true, the user can perform read_epic_iid on this resource.
updateEpic Boolean! If true, the user can perform update_epic on this resource.

ErrorTrackingStackTrace

Represents a stack trace.

Fields

Name Type Description
absolutePath String Absolute path of the stack trace.
columnNumber Int Column number of the stack trace.
context [WorkItemWidgetErrorTrackingStackTraceContext!] Context of the stack trace.
filename String Filename of the stack trace.
function String Name of the function where the error occured.
lineNumber Int Line number of the stack trace.

EscalationPolicyType

Represents an escalation policy.

Fields

Name Type Description
description String Description of the escalation policy.
id IncidentManagementEscalationPolicyID ID of the escalation policy.
name String Name of the escalation policy.
rules [EscalationRuleType!] Steps of the escalation policy.

EscalationRuleType

Represents an escalation rule for an escalation policy.

Fields

Name Type Description
elapsedTimeSeconds Int Time in seconds before the rule is activated.
id IncidentManagementEscalationRuleID ID of the escalation policy.
oncallSchedule IncidentManagementOncallSchedule On-call schedule to notify.
status EscalationRuleStatus Status required to prevent the rule from activating.
user UserCore User to notify.

Event

Representing an event.

Fields

Name Type Description
action EventAction! Action of the event.
author UserCore! Author of the event.
createdAt Time! When the event was created.
id ID! ID of the event.
project Project Project of the event.
target EventTargetType Target of the event.
updatedAt Time! When the event was updated.

ExternalAuditEventDestination

Represents an external resource to send audit events to.

Fields

Name Type Description
destinationUrl String! External destination to send audit events to.
eventTypeFilters [String!]! List of event type filters added for streaming.
group Group! Group the destination belongs to.
headers AuditEventStreamingHeaderConnection! List of additional HTTP headers sent with each event. (see Connections)
id ID! ID of the destination.
name String! Name of the external destination to send audit events to.
namespaceFilter AuditEventStreamingHTTPNamespaceFilter List of subgroup or project filters for the destination.
verificationToken String! Verification token to validate source of event.

ExternalIssue

Represents an external issue.

Fields

Name Type Description
createdAt Time Timestamp of when the issue was created.
externalTracker String Type of external tracker.
relativeReference String Relative reference of the issue in the external tracker.
status String Status of the issue in the external tracker.
title String Title of the issue in the external tracker.
updatedAt Time Timestamp of when the issue was updated.
webUrl String URL to the issue in the external tracker.

ExternalStatusCheck

Describes an external status check.

Fields

Name Type Description
externalUrl String! External URL for the status check.
hmac Boolean! Whether or not HMAC secret is enabled for the status check.
id GlobalID! ID of the rule.
name String! Name of the rule.

FeatureFlag

Fields

Name Type Description
active Boolean! Whether the feature flag is active.
id OperationsFeatureFlagID! Global ID of the feature flag.
name String! Name of the feature flag.
path String! Path to feature flag.
reference String! Reference to feature flag.

FileUpload

Fields

Name Type Description
id UploadID! Global ID of the upload.
path String! Path of the upload.
size Int! Size of the upload in bytes.

FindingReportsComparer

Represents security reports comparison for vulnerability findings.

Fields

Name Type Description
report {{< icon name=”warning-solid” >}} ComparedSecurityReport Introduced in GitLab 16.1. Status: Experiment. Compared security report.
status FindingReportsComparerStatus Comparison status.
statusReason String Text explaining the status.

ForkDetails

Details of the fork project compared to its upstream project.

Fields

Name Type Description
ahead Int Number of commits ahead of upstream.
behind Int Number of commits behind upstream.
hasConflicts Boolean Indicates if the fork conflicts with its upstream project.
isSyncing Boolean Indicates if there is a synchronization in progress.

GeoNode

Fields

Name Type Description
containerRepositoriesMaxCapacity Int Maximum concurrency of container repository sync for the secondary node.
enabled Boolean Indicates whether the Geo node is enabled.
filesMaxCapacity Int Maximum concurrency of LFS/attachment backfill for the secondary node.
id ID! ID of the GeoNode.
internalUrl String URL defined on the primary node secondary nodes should use to contact it.
minimumReverificationInterval Int Interval (in days) in which the repository verification is valid. After expiry, it is reverted.
name String Unique identifier for the Geo node.
primary Boolean Indicates whether the Geo node is the primary.
reposMaxCapacity Int Maximum concurrency of repository backfill for the secondary node.
selectiveSyncNamespaces NamespaceConnection Namespaces that should be synced, if selective_sync_type == namespaces. (see Connections)
selectiveSyncShards [String!] Repository storages whose projects should be synced, if selective_sync_type == shards.
selectiveSyncType String Indicates if syncing is limited to only specific groups, or shards.
syncObjectStorage Boolean Indicates if the secondary node will replicate blobs in Object Storage.
url String User-facing URL for the Geo node.
verificationMaxCapacity Int Maximum concurrency of repository verification for the secondary node.

Fields with arguments

GeoNode.ciSecureFileRegistries

Find Ci Secure File registries on this Geo node.

Returns CiSecureFileRegistryConnection.

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

Arguments
Name Type Description
ids [ID!] Filters registries by their ID.
keyword {{< icon name=”warning-solid” >}} String Deprecated in GitLab 17.9. A keyword search feature on Geo registries will not be built in the UI due to poor search UX and performance.
replicationState ReplicationStateEnum Filters registries by their replication state.
sort GeoRegistrySort Sort registries by given criteria.
verificationState VerificationStateEnum Filters registries by their verification state.
GeoNode.containerRepositoryRegistries

Find Container Repository registries on this Geo node.

Returns ContainerRepositoryRegistryConnection.

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

Arguments
Name Type Description
ids [ID!] Filters registries by their ID.
keyword {{< icon name=”warning-solid” >}} String Deprecated in GitLab 17.9. A keyword search feature on Geo registries will not be built in the UI due to poor search UX and performance.
replicationState ReplicationStateEnum Filters registries by their replication state.
sort GeoRegistrySort Sort registries by given criteria.
verificationState VerificationStateEnum Filters registries by their verification state.
GeoNode.dependencyProxyBlobRegistries

Find Dependency Proxy Blob registries on this Geo node.

{{< details >}} Introduced in GitLab 15.6. Status: Experiment. {{< /details >}}

Returns DependencyProxyBlobRegistryConnection.

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

Arguments
Name Type Description
ids [ID!] Filters registries by their ID.
keyword {{< icon name=”warning-solid” >}} String Deprecated in GitLab 17.9. A keyword search feature on Geo registries will not be built in the UI due to poor search UX and performance.
replicationState ReplicationStateEnum Filters registries by their replication state.
sort GeoRegistrySort Sort registries by given criteria.
verificationState VerificationStateEnum Filters registries by their verification state.
GeoNode.dependencyProxyManifestRegistries

Find Dependency Proxy Manifest registries on this Geo node.

Returns DependencyProxyManifestRegistryConnection.

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

Arguments
Name Type Description
ids [ID!] Filters registries by their ID.
keyword {{< icon name=”warning-solid” >}} String Deprecated in GitLab 17.9. A keyword search feature on Geo registries will not be built in the UI due to poor search UX and performance.
replicationState ReplicationStateEnum Filters registries by their replication state.
sort GeoRegistrySort Sort registries by given criteria.
verificationState VerificationStateEnum Filters registries by their verification state.
GeoNode.designManagementRepositoryRegistries

Find Design Management Repository registries on this Geo node.

{{< details >}} Introduced in GitLab 16.1. Status: Experiment. {{< /details >}}

Returns DesignManagementRepositoryRegistryConnection.

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

Arguments
Name Type Description
ids [ID!] Filters registries by their ID.
keyword {{< icon name=”warning-solid” >}} String Deprecated in GitLab 17.9. A keyword search feature on Geo registries will not be built in the UI due to poor search UX and performance.
replicationState ReplicationStateEnum Filters registries by their replication state.
sort GeoRegistrySort Sort registries by given criteria.
verificationState VerificationStateEnum Filters registries by their verification state.
GeoNode.groupWikiRepositoryRegistries

Find group wiki repository registries on this Geo node.

Returns GroupWikiRepositoryRegistryConnection.

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

Arguments
Name Type Description
ids [ID!] Filters registries by their ID.
keyword {{< icon name=”warning-solid” >}} String Deprecated in GitLab 17.9. A keyword search feature on Geo registries will not be built in the UI due to poor search UX and performance.
replicationState ReplicationStateEnum Filters registries by their replication state.
sort GeoRegistrySort Sort registries by given criteria.
verificationState VerificationStateEnum Filters registries by their verification state.
GeoNode.jobArtifactRegistries

Find Job Artifact registries on this Geo node.

Returns JobArtifactRegistryConnection.

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

Arguments
Name Type Description
ids [ID!] Filters registries by their ID.
keyword {{< icon name=”warning-solid” >}} String Deprecated in GitLab 17.9. A keyword search feature on Geo registries will not be built in the UI due to poor search UX and performance.
replicationState ReplicationStateEnum Filters registries by their replication state.
sort GeoRegistrySort Sort registries by given criteria.
verificationState VerificationStateEnum Filters registries by their verification state.
GeoNode.lfsObjectRegistries

Find LFS object registries on this Geo node.

Returns LfsObjectRegistryConnection.

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

Arguments
Name Type Description
ids [ID!] Filters registries by their ID.
keyword {{< icon name=”warning-solid” >}} String Deprecated in GitLab 17.9. A keyword search feature on Geo registries will not be built in the UI due to poor search UX and performance.
replicationState ReplicationStateEnum Filters registries by their replication state.
sort GeoRegistrySort Sort registries by given criteria.
verificationState VerificationStateEnum Filters registries by their verification state.
GeoNode.mergeRequestDiffRegistries

Find merge request diff registries on this Geo node.

Returns MergeRequestDiffRegistryConnection.

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

Arguments
Name Type Description
ids [ID!] Filters registries by their ID.
keyword {{< icon name=”warning-solid” >}} String Deprecated in GitLab 17.9. A keyword search feature on Geo registries will not be built in the UI due to poor search UX and performance.
replicationState ReplicationStateEnum Filters registries by their replication state.
sort GeoRegistrySort Sort registries by given criteria.
verificationState VerificationStateEnum Filters registries by their verification state.
GeoNode.packageFileRegistries

Package file registries of the GeoNode.

Returns PackageFileRegistryConnection.

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

Arguments
Name Type Description
ids [ID!] Filters registries by their ID.
keyword {{< icon name=”warning-solid” >}} String Deprecated in GitLab 17.9. A keyword search feature on Geo registries will not be built in the UI due to poor search UX and performance.
replicationState ReplicationStateEnum Filters registries by their replication state.
sort GeoRegistrySort Sort registries by given criteria.
verificationState VerificationStateEnum Filters registries by their verification state.
GeoNode.pagesDeploymentRegistries

Find Pages Deployment registries on this Geo node.

Returns PagesDeploymentRegistryConnection.

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

Arguments
Name Type Description
ids [ID!] Filters registries by their ID.
keyword {{< icon name=”warning-solid” >}} String Deprecated in GitLab 17.9. A keyword search feature on Geo registries will not be built in the UI due to poor search UX and performance.
replicationState ReplicationStateEnum Filters registries by their replication state.
sort GeoRegistrySort Sort registries by given criteria.
verificationState VerificationStateEnum Filters registries by their verification state.
GeoNode.pipelineArtifactRegistries

Find pipeline artifact registries on this Geo node.

Returns PipelineArtifactRegistryConnection.

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

Arguments
Name Type Description
ids [ID!] Filters registries by their ID.
keyword {{< icon name=”warning-solid” >}} String Deprecated in GitLab 17.9. A keyword search feature on Geo registries will not be built in the UI due to poor search UX and performance.
replicationState ReplicationStateEnum Filters registries by their replication state.
sort GeoRegistrySort Sort registries by given criteria.
verificationState VerificationStateEnum Filters registries by their verification state.
GeoNode.projectRepositoryRegistries

Find Project registries on this Geo node. Ignored if geo_project_repository_replication feature flag is disabled.

Returns ProjectRepositoryRegistryConnection.

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

Arguments
Name Type Description
ids [ID!] Filters registries by their ID.
keyword {{< icon name=”warning-solid” >}} String Deprecated in GitLab 17.9. A keyword search feature on Geo registries will not be built in the UI due to poor search UX and performance.
replicationState ReplicationStateEnum Filters registries by their replication state.
sort GeoRegistrySort Sort registries by given criteria.
verificationState VerificationStateEnum Filters registries by their verification state.
GeoNode.projectWikiRepositoryRegistries

Find Project Wiki Repository registries on this Geo node. Ignored if geo_project_wiki_repository_replication feature flag is disabled.

Returns ProjectWikiRepositoryRegistryConnection.

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

Arguments
Name Type Description
ids [ID!] Filters registries by their ID.
keyword {{< icon name=”warning-solid” >}} String Deprecated in GitLab 17.9. A keyword search feature on Geo registries will not be built in the UI due to poor search UX and performance.
replicationState ReplicationStateEnum Filters registries by their replication state.
sort GeoRegistrySort Sort registries by given criteria.
verificationState VerificationStateEnum Filters registries by their verification state.
GeoNode.snippetRepositoryRegistries

Find snippet repository registries on this Geo node.

Returns SnippetRepositoryRegistryConnection.

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

Arguments
Name Type Description
ids [ID!] Filters registries by their ID.
keyword {{< icon name=”warning-solid” >}} String Deprecated in GitLab 17.9. A keyword search feature on Geo registries will not be built in the UI due to poor search UX and performance.
replicationState ReplicationStateEnum Filters registries by their replication state.
sort GeoRegistrySort Sort registries by given criteria.
verificationState VerificationStateEnum Filters registries by their verification state.
GeoNode.terraformStateVersionRegistries

Find terraform state version registries on this Geo node.

Returns TerraformStateVersionRegistryConnection.

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

Arguments
Name Type Description
ids [ID!] Filters registries by their ID.
keyword {{< icon name=”warning-solid” >}} String Deprecated in GitLab 17.9. A keyword search feature on Geo registries will not be built in the UI due to poor search UX and performance.
replicationState ReplicationStateEnum Filters registries by their replication state.
sort GeoRegistrySort Sort registries by given criteria.
verificationState VerificationStateEnum Filters registries by their verification state.
GeoNode.uploadRegistries

Find Upload registries on this Geo node.

Returns UploadRegistryConnection.

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

Arguments
Name Type Description
ids [ID!] Filters registries by their ID.
keyword {{< icon name=”warning-solid” >}} String Deprecated in GitLab 17.9. A keyword search feature on Geo registries will not be built in the UI due to poor search UX and performance.
replicationState ReplicationStateEnum Filters registries by their replication state.
sort GeoRegistrySort Sort registries by given criteria.
verificationState VerificationStateEnum Filters registries by their verification state.

GitlabInstanceFeatureFlag

A feature flag for the GitLab instance.

Fields

Name Type Description
enabled Boolean! Indicates whether the GitLab instance feature flag is enabled or not.
name String! Name of the GitLab instance feature flag.

GitlabSubscriptionHistory

Describes the subscription history of a given namespace.

Fields

Name Type Description
changeType SubscriptionHistoryChangeType Indicates what type of change in the subscription has happened.
createdAt Time Timestamp of the subscription history entry creation.
endDate Time Subscription end date.
maxSeatsUsed Int Maximum seats used in subscription.
seats Int Seats purchased in subscription.
seatsInUse Int Seats being used in subscription.
startDate Time Subscription start date.

GoogleCloudArtifactRegistryDockerImage

Represents a docker artifact of Google Artifact Registry.

Fields

Name Type Description
digest String! Image’s digest.
image String! Image’s name.
name String! Unique image name.
tags [String!] Tags attached to the image.
updateTime Time Time when the image was last updated.
uploadTime Time Time when the image was uploaded.
uri String! Google Cloud URI to access the image.

GoogleCloudArtifactRegistryDockerImageDetails

Represents details about docker artifact of Google Artifact Registry.

Fields

Name Type Description
artifactRegistryImageUrl String! Google Cloud URL to access the image.
buildTime Time Time when the image was built.
digest String! Image’s digest.
image String! Image’s name.
imageSizeBytes String Calculated size of the image.
location String! Location of the Artifact Registry repository.
mediaType String Media type of the image.
name String! Unique image name.
projectId String! ID of the Google Cloud project.
repository String! Repository on the Google Artifact Registry.
tags [String!] Tags attached to the image.
updateTime Time Time when the image was last updated.
uploadTime Time Time when the image was uploaded.
uri String! Google Cloud URI to access the image.

GoogleCloudArtifactRegistryRepository

Represents a repository of Google Artifact Registry.

Fields

Name Type Description
artifactRegistryRepositoryUrl String! Google Cloud URL to access the repository.
projectId String! ID of the Google Cloud project.
repository String! 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
Name Type Description
sort GoogleCloudArtifactRegistryArtifactsSort Criteria to sort artifacts by.

GoogleCloudLoggingConfigurationType

Stores Google Cloud Logging configurations associated with IAM service accounts,used for generating access tokens.

Fields

Name Type Description
clientEmail String! Client email.
googleProjectIdName String! Google project ID.
group Group! Group the configuration belongs to.
id ID! ID of the configuration.
logIdName String! Log ID.
name String! Name of the external destination to send audit events to.

GpgSignature

GPG signature for a signed commit.

Fields

Name Type Description
commitSha String SHA of the associated commit.
gpgKeyPrimaryKeyid String ID of the GPG key.
gpgKeyUserEmail String User email associated with the GPG key.
gpgKeyUserName String User name associated with the GPG key.
project Project Project of the associated commit.
user UserCore User associated with the key.
verificationStatus VerificationStatus Indicates verification status of the associated key or certificate.

GrafanaIntegration

Fields

Name Type Description
createdAt Time! Timestamp of the issue’s creation.
enabled Boolean! Indicates whether Grafana integration is enabled.
grafanaUrl String! URL for the Grafana host for the Grafana integration.
id ID! Internal ID of the Grafana integration.
updatedAt Time! Timestamp of the issue’s last activity.

Group

Fields

Name Type Description
achievementsPath {{< icon name=”warning-solid” >}} String Introduced 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.
actualRepositorySizeLimit Float Size limit for repositories in the namespace in bytes. This limit only applies to namespaces under Project limit enforcement.
actualSizeLimit Float The actual storage size limit (in bytes) based on the enforcement type of either repository or namespace. This limit is agnostic of enforcement type.
additionalPurchasedStorageSize Float Additional storage purchased for the root namespace in bytes.
aiUsageData {{< icon name=”warning-solid” >}} AiUsageData Introduced in GitLab 17.5. Status: Experiment. AI-related data.
allowStaleRunnerPruning Boolean! Indicates whether to regularly prune stale group runners. Defaults to false.
amazonS3Configurations AmazonS3ConfigurationTypeConnection Amazon S3 configurations that receive audit events belonging to the group. (see Connections)
autoDevopsEnabled Boolean Indicates whether Auto DevOps is enabled for all projects within the group.
avatarUrl String Avatar URL of the group.
ciCdSettings {{< icon name=”warning-solid” >}} CiCdSettings Introduced in GitLab 17.9. Status: Experiment. Namespace CI/CD settings for the namespace.
containerRepositoriesCount Int! Number of container repositories in the group.
containsLockedProjects Boolean Includes at least one project where the repository size exceeds the limit. This only applies to namespaces under Project limit enforcement.
createdAt Time Timestamp of the group creation.
crossProjectPipelineAvailable Boolean! Indicates if the cross_project_pipeline feature is available for the namespace.
dependencyProxyBlobCount Int! Number of dependency proxy blobs cached in the group.
dependencyProxyBlobs DependencyProxyBlobConnection Dependency Proxy blobs. (see Connections)
dependencyProxyImageCount Int! Number of dependency proxy images cached in the group.
dependencyProxyImagePrefix String! Prefix for pulling images when using the dependency proxy.
dependencyProxyImageTtlPolicy DependencyProxyImageTtlGroupPolicy Dependency proxy TTL policy for the group.
dependencyProxyManifests DependencyProxyManifestConnection Dependency Proxy manifests. (see Connections)
dependencyProxySetting DependencyProxySetting Dependency Proxy settings for the group.
dependencyProxyTotalSize String! Total size of the dependency proxy cached images.
dependencyProxyTotalSizeBytes BigInt! Total size of the dependency proxy cached images in bytes, encoded as a string.
dependencyProxyTotalSizeInBytes {{< icon name=”warning-solid” >}} Int! Deprecated in GitLab 16.1. Use dependencyProxyTotalSizeBytes.
descendantGroupsCount Int! Count of direct descendant groups of the group.
description String Description of the namespace.
descriptionHtml String GitLab Flavored Markdown rendering of description.
dora GroupDora Group’s DORA metrics.
duoFeaturesEnabled {{< icon name=”warning-solid” >}} Boolean Introduced in GitLab 16.10. Status: Experiment. Indicates whether GitLab Duo features are enabled for the group.
emailsDisabled Boolean Indicates if a group has email notifications disabled.
emailsEnabled Boolean Indicates if a group has email notifications enabled.
enforceFreeUserCap Boolean Indicates whether the group has limited users for a free plan.
epicBoards {{< icon name=”warning-solid” >}} EpicBoardConnection Deprecated in GitLab 17.5. Replaced by WorkItem type.
epicsEnabled {{< icon name=”warning-solid” >}} Boolean Deprecated in GitLab 17.5. Replaced by WorkItem type.
externalAuditEventDestinations ExternalAuditEventDestinationConnection External locations that receive audit events belonging to the group. (see Connections)
externalAuditEventStreamingDestinations {{< icon name=”warning-solid” >}} GroupAuditEventStreamingDestinationConnection Introduced in GitLab 16.11. Status: Experiment. External destinations that receive audit events belonging to the group.
flowMetrics {{< icon name=”warning-solid” >}} GroupValueStreamAnalyticsFlowMetrics Introduced in GitLab 15.10. Status: Experiment. Flow metrics for value stream analytics.
fullName String Full name of the group.
fullPath ID! Full path of the namespace.
googleCloudLoggingConfigurations GoogleCloudLoggingConfigurationTypeConnection Google Cloud logging configurations that receive audit events belonging to the group. (see Connections)
groupMembersCount Int! Count of direct members of the group.
id ID ID of the group.
isAdjournedDeletionEnabled {{< icon name=”warning-solid” >}} Boolean! Introduced in GitLab 16.11. Status: Experiment. Indicates if delayed group deletion is enabled.
isLinkedToSubscription Boolean Indicates if group is linked to a subscription.
lfsEnabled Boolean Indicates if Large File Storage (LFS) is enabled for namespace.
lockDuoFeaturesEnabled {{< icon name=”warning-solid” >}} Boolean Introduced in GitLab 16.10. Status: Experiment. Indicates if the GitLab Duo features enabled setting is enforced for all subgroups.
lockMathRenderingLimitsEnabled Boolean Indicates if math rendering limits are locked for all descendant groups.
markedForDeletionOn {{< icon name=”warning-solid” >}} Time Introduced in GitLab 16.11. Status: Experiment. Date when group was scheduled to be deleted.
mathRenderingLimitsEnabled Boolean Indicates if math rendering limits are used for the group.
maxAccessLevel AccessLevel! Maximum access level of the current user in the group.
mentionsDisabled Boolean Indicates if a group is disabled from getting mentioned.
name String Name of the group.
organizationEditPath {{< icon name=”warning-solid” >}} String Introduced in GitLab 17.1. Status: Experiment. Path for editing group at the organization level.
packageSettings PackageSettings Package settings for the namespace.
parent Group Parent group.
path String! Path of the namespace.
pendingMemberApprovals {{< icon name=”warning-solid” >}} MemberApprovalConnection Introduced in GitLab 17.3. Status: Experiment. Pending member promotions of the group.
pendingMembers {{< icon name=”warning-solid” >}} PendingMemberInterfaceConnection Introduced in GitLab 16.6. Status: Experiment. A pending membership of a user within this group.
permanentDeletionDate {{< icon name=”warning-solid” >}} String Introduced in GitLab 16.11. Status: Experiment. Date when group will be deleted if delayed group deletion is enabled.
productAnalyticsStoredEventsLimit {{< icon name=”warning-solid” >}} Int Introduced in GitLab 16.9. Status: Experiment. Number of product analytics events namespace is permitted to store per cycle.
projectCreationLevel String Permission level required to create projects in the group.
projectsCount Int! Count of direct projects in the group.
recentIssueBoards BoardConnection List of recently visited boards of the group. Maximum size is 4. (see Connections)
repositorySizeExcessProjectCount Int Number of projects in the root namespace where the repository size exceeds the limit. This only applies to namespaces under Project limit enforcement.
requestAccessEnabled Boolean Indicates if users can request access to namespace.
requireTwoFactorAuthentication Boolean Indicates if all users in the group are required to set up two-factor authentication.
rootStorageStatistics RootStorageStatistics Aggregated storage statistics of the namespace. Only available for root namespaces.
securityPolicyProject Project Security policy project assigned to the namespace.
shareWithGroupLock Boolean Indicates if sharing a project with another group within the group is prevented.
sharedRunnersSetting SharedRunnersSetting Shared runners availability for the namespace and its descendants.
sidebar {{< icon name=”warning-solid” >}} NamespaceSidebar Introduced in GitLab 17.6. Status: Experiment. Data needed to render the sidebar for the namespace.
stats GroupStats Group statistics.
storageSizeLimit Float The storage limit (in bytes) included with the root namespace plan. This limit only applies to namespaces under namespace limit enforcement.
subgroupCreationLevel String Permission level required to create subgroups within the group.
subscriptionHistory {{< icon name=”warning-solid” >}} GitlabSubscriptionHistoryConnection Introduced in GitLab 17.3. Status: Experiment. Find subscription history records.
timelogCategories {{< icon name=”warning-solid” >}} TimeTrackingTimelogCategoryConnection Introduced in GitLab 15.3. Status: Experiment. Timelog categories for the namespace.
totalRepositorySize Float Total repository size of all projects in the root namespace in bytes.
totalRepositorySizeExcess Float Total excess repository size of all projects in the root namespace in bytes. This only applies to namespaces under Project limit enforcement.
twoFactorGracePeriod Int Time before two-factor authentication is enforced.
updatedAt Time Timestamp of when the group was last updated.
userPermissions GroupPermissions! Permissions for the current user on the resource.
valueStreamAnalytics ValueStreamAnalytics Information about Value Stream Analytics within the group.
visibility String Visibility of the namespace.
vulnerabilityNamespaceStatistic {{< icon name=”warning-solid” >}} VulnerabilityNamespaceStatisticType Introduced in GitLab 18.0. Status: Experiment. Counts for each vulnerability severity in the group and its subgroups.
vulnerabilityScanners VulnerabilityScannerConnection Vulnerability scanners reported on the project vulnerabilities of the group and its subgroups. (see Connections)
webUrl String! Web URL of the group.

Fields with arguments

Group.achievements

Achievements for the namespace. Returns null if the achievements feature flag is disabled.

{{< details >}} Introduced in GitLab 15.8. Status: Experiment. {{< /details >}}

Returns AchievementConnection.

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

Arguments
Name Type Description
ids [AchievementsAchievementID!] Filter achievements by IDs.
Group.addOnEligibleUsers

Users in the namespace hierarchy that add ons are applicable for. This only applies to root namespaces.

{{< details >}} Introduced in GitLab 16.5. Status: Experiment. {{< /details >}}

Returns AddOnUserConnection.

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

Arguments
Name Type Description
addOnPurchaseIds [GitlabSubscriptionsAddOnPurchaseID!]! Global IDs of the add on purchases to find assignments for.
addOnType GitlabSubscriptionsAddOnType! Type of add on to filter the eligible users by.
filterByAssignedSeat String Filter users list by assigned seat.
search String Search the user list.
sort GitlabSubscriptionsUserSort Sort the user list.
Group.aiMetrics

AI-related metrics.

{{< details >}} Introduced in GitLab 16.11. Status: Experiment. {{< /details >}}

Returns AiMetrics.

Arguments
Name Type Description
endDate Date Date range to end at. Default is the end of current month.
startDate Date Date range to start from. Default is the beginning of current month.
Group.aiUserMetrics

AI-related user metrics.

{{< details >}} Introduced in GitLab 17.5. Status: Experiment. {{< /details >}}

Returns AiUserMetricsConnection.

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

Arguments
Name Type Description
endDate Date Date range to end at. Default is the end of current month.
startDate Date Date range to start from. Default is the beginning of current month.
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
Name Type Description
includeUnscoped Boolean Filter policies that are scoped to the project.
relationship SecurityPolicyRelationType Filter policies by the given policy relationship. Default is DIRECT.
Group.autocompleteUsers

Search users for autocompletion.

Returns [AutocompletedUser!].

Arguments
Name Type Description
search String Query to search users by name, username, or public email.
Group.billableMembersCount

Number of billable users in the group.

Returns Int.

Arguments
Name Type Description
requestedHostedPlan String Plan from which to get billable members.
Group.board

A single board of the group.

Returns Board.

Arguments
Name Type Description
id BoardID! ID of the board.
Group.boards

Boards of the group.

Returns BoardConnection.

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

Arguments
Name Type Description
id BoardID Find a board by its ID.
Group.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.

{{< details >}} Introduced in GitLab 16.11. Status: Experiment. {{< /details >}}

Returns QueueingDelayHistory.

Arguments
Name Type Description
fromTime Time Start of the requested time. Defaults to three hours ago.
toTime Time End 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
Name Type Description
sort CiVariableSort Sort order of results.
Group.clusterAgents

Cluster agents associated with projects in the group and its subgroups.

Returns ClusterAgentConnection.

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

Arguments
Name Type Description
hasRemoteDevelopmentAgentConfig {{< icon name=”warning-solid” >}} Boolean Deprecated in GitLab 17.10. Use has_workspaces_agent_config filter instead.
hasRemoteDevelopmentEnabled Boolean Returns only cluster agents which have been enabled with the remote development feature.
hasVulnerabilities Boolean Returns only cluster agents which have vulnerabilities.
hasWorkspacesAgentConfig Boolean Returns only cluster agents which have an associated workspaces agent config.
Group.codeCoverageActivities

Represents the code coverage activity for this group.

Returns CodeCoverageActivityConnection.

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

Arguments
Name Type Description
startDate Date! First day for which to fetch code coverage activity (maximum time window is set to 90 days).
Group.complianceFrameworks

Compliance frameworks available to projects in this namespace.

Returns ComplianceFrameworkConnection.

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

Arguments
Name Type Description
id ComplianceManagementFrameworkID Global ID of a specific compliance framework to return.
ids [ComplianceManagementFrameworkID!] List of Global IDs of compliance frameworks to return.
search String Search framework with most similar names.
Group.componentVersions

Find software dependency versions by component name.

{{< details >}} Introduced in GitLab 18.0. Status: Experiment. {{< /details >}}

Returns ComponentVersionConnection!.

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

Arguments
Name Type Description
componentName String! Name of the SBoM component.
Group.components

Find software dependencies by name.

{{< details >}} Introduced in GitLab 17.5. Status: Experiment. {{< /details >}}

Returns [Component!].

Arguments
Name Type Description
name String Entire name or part of the name.
Group.contactStateCounts

Counts of contacts by state for the group.

Returns ContactStateCounts.

Arguments
Name Type Description
search String Search term to find contacts with.
state CustomerRelationsContactState State of the contacts to search for.
Group.contacts

Find contacts of this group.

Returns CustomerRelationsContactConnection.

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

Arguments
Name Type Description
ids [CustomerRelationsContactID!] Filter contacts by IDs.
search String Search term to find contacts with.
sort ContactSort Criteria to sort contacts by.
state CustomerRelationsContactState State of the contacts to search for.
Group.containerRepositories

Container repositories of the group.

Returns ContainerRepositoryConnection.

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

Arguments
Name Type Description
name String Filter the container repositories by their name.
sort ContainerRepositorySort Sort container repositories by 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
Name Type Description
from ISO8601Date! Start date of the reporting time range.
to ISO8601Date! End date of the reporting time range. The end date must be within 93 days after the start date.
Group.customEmoji

Custom emoji in this namespace.

Returns CustomEmojiConnection.

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

Arguments
Name Type Description
includeAncestorGroups Boolean Includes custom emoji from parent groups.
Group.customField

A custom field configured for the group.

{{< details >}} Introduced in GitLab 17.6. Status: Experiment. {{< /details >}}

Returns CustomField.

Arguments
Name Type Description
id IssuablesCustomFieldID! Global ID of the custom field.
Group.customFields

Custom fields configured for the group.

{{< details >}} Introduced in GitLab 17.5. Status: Experiment. {{< /details >}}

Returns CustomFieldConnection.

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

Arguments
Name Type Description
active Boolean Filter for active fields. If false, excludes active fields. If true, returns only active fields.
fieldType CustomFieldType Filter for selected field type.
search String Search query for custom field name.
workItemTypeId WorkItemsTypeID Filter custom fields associated to the given work item type.
Group.customizableDashboardVisualizations

Visualizations of the group or associated configuration project.

Returns CustomizableDashboardVisualizationConnection.

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

Arguments
Name Type Description
slug String Slug of the visualization to return.
Group.customizableDashboards

Customizable dashboards for the group.

Returns CustomizableDashboardConnection.

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

Arguments
Name Type Description
category CustomizableDashboardCategory Find by dashboard type.
slug String Find by dashboard slug.
Group.dataTransfer

Data transfer data point for a specific period. This is mocked data under a development feature flag.

Returns GroupDataTransfer.

Arguments
Name Type Description
from Date Retain egress data for one year. Data for the current month will increase dynamically as egress occurs.
to Date End date for the data.
Group.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
Name Type Description
componentIds [SbomComponentID!] Filter dependencies by component IDs.
componentNames [String!] Filter dependencies by component names.
packageManagers [PackageManager!] Filter dependencies by package managers.
sort DependencySort Sort dependencies by given criteria.
sourceTypes [SbomSourceType!] Filter dependencies by source type.
Group.dependencyAggregations

Software dependencies used by projects under this group.

{{< details >}} Introduced in GitLab 18.0. Status: Experiment. {{< /details >}}

Returns DependencyAggregationConnection.

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

Arguments
Name Type Description
componentIds [SbomComponentID!] Filter dependencies by component IDs.
componentNames [String!] Filter dependencies by component names.
packageManagers [PackageManager!] Filter dependencies by package managers.
projectCountMax Int Filter dependencies by maximum project count.
projectCountMin Int Filter dependencies by minimum project count.
sort DependencySort Sort 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
Name Type Description
ids [ID!] Filter groups by IDs.
includeParentDescendants Boolean List of descendant groups of the parent group.
owned Boolean Limit result to groups owned by authenticated user.
search String Search query for group name or group full path.
sort GroupSort Sort groups by given criteria.
Group.doraPerformanceScoreCounts

Group’s DORA scores for all projects by DORA key metric for the last complete month.

Returns DoraPerformanceScoreCountConnection.

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

Arguments
Name Type Description
projectFilters DoraProjectFilterInput Filter DORA metric results by project attributes.
Group.environmentScopes

Environment scopes of the group.

Returns CiGroupEnvironmentScopeConnection.

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

Arguments
Name Type Description
name String Name of the environment scope.
search String Search query for environment scope name.
Group.epic

Find a single epic.

{{< details >}} Deprecated in GitLab 17.5. Replaced by WorkItem type. {{< /details >}}

Returns Epic.

Arguments
Name Type Description
authorUsername String Filter epics by author.
confidential Boolean Filter epics by given confidentiality.
createdAfter Time Epics created after the date.
createdBefore Time Epics created before the date.
customField {{< icon name=”warning-solid” >}} [WorkItemWidgetCustomFieldFilterInputType!] Introduced in GitLab 17.10. Status: Experiment. Filter by custom fields.
iid ID IID of the epic, e.g., “1”.
iidStartsWith String Filter epics by IID for autocomplete.
iids [ID!] List of IIDs of epics, e.g., [1, 2].
in [IssuableSearchableField!] Specify the fields to perform the search in. Defaults to [TITLE, DESCRIPTION]. Requires the search argument.’.
includeAncestorGroups Boolean Include epics from ancestor groups.
includeDescendantGroups Boolean Include epics from descendant groups.
labelName [String!] Filter epics by labels.
milestoneTitle String Filter epics by milestone title, computed from epic’s issues.
myReactionEmoji String Filter by reaction emoji applied by the current user.
not NegatedEpicFilterInput Negated epic arguments.
or UnionedEpicFilterInput List of arguments with inclusive OR.
search String Search query for title or description.
sort EpicSort List epics by sort order.
state EpicState Filter epics by state.
subscribed SubscriptionStatus Epics the current user is subscribed to.
timeframe Timeframe List items overlapping the given timeframe.
topLevelHierarchyOnly Boolean Filter epics with a top-level hierarchy.
updatedAfter Time Epics updated after the date.
updatedBefore Time Epics updated before the date.
Group.epicBoard

Find a single epic board.

{{< details >}} Deprecated in GitLab 17.5. Replaced by WorkItem type. {{< /details >}}

Returns EpicBoard.

Arguments
Name Type Description
id BoardsEpicBoardID! Find an epic board by ID.
Group.epics

Find epics.

{{< details >}} Deprecated in GitLab 17.5. Replaced by WorkItem type. {{< /details >}}

Returns EpicConnection.

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

Arguments
Name Type Description
authorUsername String Filter epics by author.
confidential Boolean Filter epics by given confidentiality.
createdAfter Time Epics created after the date.
createdBefore Time Epics created before the date.
customField {{< icon name=”warning-solid” >}} [WorkItemWidgetCustomFieldFilterInputType!] Introduced in GitLab 17.10. Status: Experiment. Filter by custom fields.
iid ID IID of the epic, e.g., “1”.
iidStartsWith String Filter epics by IID for autocomplete.
iids [ID!] List of IIDs of epics, e.g., [1, 2].
in [IssuableSearchableField!] Specify the fields to perform the search in. Defaults to [TITLE, DESCRIPTION]. Requires the search argument.’.
includeAncestorGroups Boolean Include epics from ancestor groups.
includeDescendantGroups Boolean Include epics from descendant groups.
labelName [String!] Filter epics by labels.
milestoneTitle String Filter epics by milestone title, computed from epic’s issues.
myReactionEmoji String Filter by reaction emoji applied by the current user.
not NegatedEpicFilterInput Negated epic arguments.
or UnionedEpicFilterInput List of arguments with inclusive OR.
search String Search query for title or description.
sort EpicSort List epics by sort order.
state EpicState Filter epics by state.
subscribed SubscriptionStatus Epics the current user is subscribed to.
timeframe Timeframe List items overlapping the given timeframe.
topLevelHierarchyOnly Boolean Filter epics with a top-level hierarchy.
updatedAfter Time Epics updated after the date.
updatedBefore Time Epics updated before the date.
Group.gitlabSubscriptionsPreviewBillableUserChange

Preview Billable User Changes.

Returns PreviewBillableUserChange.

Arguments
Name Type Description
addGroupId Int Group ID to add.
addUserEmails [String!] User emails to add.
addUserIds [Int!] User IDs to add.
memberRoleId Int Custom role assigned to the users.
role GitlabSubscriptionsUserRole! Role of users being added to group.
Group.groupMembers

A membership of a user within this group.

Returns GroupMemberConnection.

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

Arguments
Name Type Description
accessLevels [AccessLevelEnum!] Filter members by the given access levels.
enterprise Boolean Filter members by enterprise users.
relations [GroupMemberRelation!] Filter members by the given member relations.
search String Search query.
sort MemberSort sort query.
Group.importSourceUsers

Import source users of the namespace. This field can only be resolved for one namespace in any single request.

{{< details >}} Introduced in GitLab 17.2. Status: Experiment. {{< /details >}}

Returns ImportSourceUserConnection.

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

Arguments
Name Type Description
search String Query to search mappings by name or username of users on source instance.
sort SourceUserSort Sort mapping of users on source instance to users on destination instance by the criteria.
statuses [ImportSourceUserStatus!] Filter mapping of users on source instance to users on destination instance by status.
Group.issues

Issues for projects in this group.

Returns IssueConnection.

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

Arguments
Name Type Description
assigneeId String ID of a user assigned to the issues. Wildcard values “NONE” and “ANY” are supported.
assigneeUsername {{< icon name=”warning-solid” >}} String Deprecated in GitLab 13.11. Use assigneeUsernames.
assigneeUsernames [String!] Usernames of users assigned to the issue.
assigneeWildcardId AssigneeWildcardId Filter by assignee wildcard. Incompatible with assigneeUsername and assigneeUsernames.
authorUsername String Username of the author of the issue.
closedAfter Time Issues closed after the date.
closedBefore Time Issues closed before the date.
confidential Boolean Filter for confidential issues. If “false”, excludes confidential issues. If “true”, returns only confidential issues.
createdAfter Time Issues created after the date.
createdBefore Time Issues created before the date.
crmContactId String ID of a contact assigned to the issues.
crmOrganizationId String ID of an organization assigned to the issues.
customField {{< icon name=”warning-solid” >}} [WorkItemWidgetCustomFieldFilterInputType!] Introduced in GitLab 17.10. Status: Experiment. Filter by custom fields.
dueAfter Time Return issues due on or after the given time.
dueBefore Time Return issues due on or before the given time.
epicId String ID of an epic associated with the issues, “none” and “any” values are supported.
epicWildcardId EpicWildcardId Filter by epic ID wildcard. Incompatible with epicId.
healthStatus {{< icon name=”warning-solid” >}} HealthStatus Deprecated in GitLab 15.4. Use healthStatusFilter.
healthStatusFilter HealthStatusFilter Health status of the issue, “none” and “any” values are supported.
iid String IID of the issue. For example, “1”.
iids [String!] List of IIDs of issues. For example, ["1", "2"].
in [IssuableSearchableField!] Specify the fields to perform the search in. Defaults to [TITLE, DESCRIPTION]. Requires the search argument.’.
includeArchived Boolean Return issues from archived projects.
includeSubepics Boolean Whether to include subepics when filtering issues by epicId.
includeSubgroups Boolean Include issues belonging to subgroups.
iterationCadenceId [IterationsCadenceID!] Filter by a list of iteration cadence IDs.
iterationId [ID] List of iteration Global IDs applied to the issue.
iterationTitle String Filter by iteration title.
iterationWildcardId IterationWildcardId Filter by iteration ID wildcard.
labelName [String] Labels applied to the issue.
milestoneTitle [String] Milestone applied to the issue.
milestoneWildcardId MilestoneWildcardId Filter issues by milestone ID wildcard.
myReactionEmoji String Filter by reaction emoji applied by the current user. Wildcard values “NONE” and “ANY” are supported.
not NegatedIssueFilterInput Negated arguments.
or UnionedIssueFilterInput List of arguments with inclusive OR.
search String Search query for title or description.
sort IssueSort Sort issues by the criteria.
state IssuableState Current state of the issue.
subscribed SubscriptionStatus Issues the current user is subscribed to.
types [IssueType!] Filter issues by the given issue types.
updatedAfter Time Issues updated after the date.
updatedBefore Time Issues updated before the date.
weight String Weight applied to the issue, “none” and “any” values are supported.
weightWildcardId WeightWildcardId Filter by weight ID wildcard. Incompatible with weight.
Group.iterationCadences

Find iteration cadences.

Returns IterationCadenceConnection.

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

Arguments
Name Type Description
active Boolean Whether the iteration cadence is active.
automatic Boolean Whether the iteration cadence should automatically generate upcoming iterations.
durationInWeeks Int Duration in weeks of the iterations within the cadence.
id IterationsCadenceID Global ID of the iteration cadence to look up.
includeAncestorGroups Boolean Whether to include ancestor groups to search iterations cadences in.
title String Fuzzy search by title.
Group.iterations

Find iterations.

Returns IterationConnection.

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

Arguments
Name Type Description
id ID Global ID of the Iteration to look up.
iid ID Internal ID of the Iteration to look up.
in [IterationSearchableField!] Fields in which the fuzzy-search should be performed with the query given in the argument search. Defaults to [title].
includeAncestors Boolean Whether to include ancestor iterations. Defaults to true.
includeDescendants Boolean Whether to include descendant iterations.
iterationCadenceIds [IterationsCadenceID!] Global iteration cadence IDs by which to look up the iterations.
search String Query used for fuzzy-searching in the fields selected in the argument in. Returns all iterations if empty.
sort IterationSort List iterations by sort order. If unspecified, an arbitrary order (subject to change) is used.
state IterationState Filter iterations by state.
timeframe Timeframe List items overlapping the given timeframe.
title {{< icon name=”warning-solid” >}} String Deprecated in GitLab 15.4. The argument will be removed in 15.4. Please use search and in fields instead.
Group.label

Label available on the group.

Returns Label.

Arguments
Name Type Description
title String! Title of the label.
Group.labels

Labels available on this group.

Returns LabelConnection.

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

Arguments
Name Type Description
includeAncestorGroups Boolean Include labels from ancestor groups.
includeDescendantGroups Boolean Include labels from descendant groups.
onlyGroupLabels Boolean Include only group level labels.
searchIn [LabelSearchFieldList!]! Specify which fields to search in. Ignored if using title.
searchTerm String Search term to find labels with.
title String Exact match on title. Cannot be used with searchTerm. searchIn will be ignored if title argument is provided.
Group.memberRoles

Custom roles available for the group.

{{< details >}} Introduced in GitLab 16.5. Status: Experiment. {{< /details >}}

Returns MemberRoleConnection.

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

Arguments
Name Type Description
id MemberRoleID Global ID of the member role to look up.
ids [MemberRoleID!] Global IDs of the member role to look up.
orderBy MemberRolesOrderBy Ordering column. Default is NAME.
sort SortDirectionEnum Ordering column. Default is ASC.
Group.mergeRequestViolations

Compliance violations reported on merge requests merged within the group.

Returns ComplianceViolationConnection.

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

Arguments
Name Type Description
filters ComplianceViolationInput Filters applied when retrieving compliance violations.
sort ComplianceViolationSort List compliance violations by sort order.
Group.mergeRequests

Merge requests for projects in this group.

Returns MergeRequestConnection.

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

Arguments
Name Type Description
approved Boolean Limit results to approved merge requests. Available only when the feature flag mr_approved_filter is enabled.
approvedBy [String!] Usernames of the approvers.
approver [String!] Usernames of possible approvers.
assigneeUsername String Username of the assignee.
assigneeUsernames [String!] Usernames of users assigned to the merge request.
assigneeWildcardId AssigneeWildcardId Filter by assignee presence. Incompatible with assigneeUsernames and assigneeUsername.
authorUsername String Username of the author.
blobPath {{< icon name=”warning-solid” >}} String Introduced 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.
createdAfter Time Merge requests created after the timestamp.
createdBefore Time Merge requests created before the timestamp.
deployedAfter Time Merge requests deployed after the timestamp.
deployedBefore Time Merge requests deployed before the timestamp.
deploymentId String ID of the deployment.
draft Boolean Limit result to draft merge requests.
environmentName String Environment merge requests have been deployed to.
ignoredReviewerUsername {{< icon name=”warning-solid” >}} String Introduced in GitLab 18.0. Status: Experiment. Username of the reviewer to ignore when searching by reviewer state.
iids [String!] Array of IIDs of merge requests, for example [1, 2].
in [IssuableSearchableField!] Specify the fields to perform the search in. Defaults to [TITLE, DESCRIPTION]. Requires the search argument.’.
includeArchived Boolean Return merge requests from archived projects.
includeSubgroups Boolean Include merge requests belonging to subgroups.
labelName [String] Labels applied to the merge request.
labels {{< icon name=”warning-solid” >}} [String!] Deprecated in GitLab 17.1. Use labelName.
mergedAfter Time Merge requests merged after the date.
mergedBefore Time Merge requests merged before the date.
mergedBy String Username of the merger.
milestoneTitle String Title of the milestone. Incompatible with milestoneWildcardId.
milestoneWildcardId MilestoneWildcardId Filter issues by milestone ID wildcard. Incompatible with milestoneTitle.
myReactionEmoji String Filter by your reaction emoji.
not MergeRequestsResolverNegatedParams List of negated arguments. Warning: this argument is experimental and a subject to change in future.
or UnionedMergeRequestFilterInput List of arguments with inclusive OR.
releaseTag String Filter by release tag.
reviewState {{< icon name=”warning-solid” >}} MergeRequestReviewState Introduced in GitLab 17.0. Status: Experiment. Reviewer state of the merge request.
reviewStates {{< icon name=”warning-solid” >}} [MergeRequestReviewState!] Introduced in GitLab 17.0. Status: Experiment. Reviewer states of the merge request.
reviewerUsername String Username of the reviewer.
reviewerWildcardId ReviewerWildcardId Filter by reviewer presence. Incompatible with reviewerUsername.
search String Search query for title or description.
sort MergeRequestSort Sort merge requests by the criteria.
sourceBranches [String!] Array of source branch names. All resolved merge requests will have one of these branches as their source.
state MergeRequestState Merge request state. If provided, all resolved merge requests will have the state.
subscribed SubscriptionStatus Merge requests the current user is subscribed to.
targetBranches [String!] Array of target branch names. All resolved merge requests will have one of these branches as their target.
updatedAfter Time Merge requests updated after the timestamp.
updatedBefore Time Merge requests updated before the timestamp.
Group.milestones

Milestones of the group.

Returns MilestoneConnection.

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

Arguments
Name Type Description
containingDate Time Date the milestone contains.
ids [ID!] Array of global milestone IDs, e.g., "gid://gitlab/Milestone/1".
includeAncestors Boolean Include milestones from all parent groups.
includeDescendants Boolean Include milestones from all subgroups and subprojects.
searchTitle String Search string for the title.
sort MilestoneSort Sort milestones by the criteria.
state MilestoneStateEnum Filter milestones by state.
timeframe Timeframe List items overlapping the given timeframe.
title String Title of the milestone.
Group.organizationStateCounts

Counts of organizations by status for the group.

Returns OrganizationStateCounts.

Arguments
Name Type Description
search String Search term to find organizations with.
state CustomerRelationsOrganizationState State of the organizations to search for.
Group.organizations

Find organizations of this group.

Returns CustomerRelationsOrganizationConnection.

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

Arguments
Name Type Description
ids [CustomerRelationsOrganizationID!] Filter organizations by IDs.
search String Search term used to find organizations with.
sort OrganizationSort Criteria to sort organizations by.
state CustomerRelationsOrganizationState State of the organization to search for.
Group.packages

Packages of the group. This field can only be resolved for one group in any single request.

Returns PackageConnection.

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

Arguments
Name Type Description
includeVersionless Boolean Include versionless packages.
packageName String Search a package by name.
packageType PackageTypeEnum Filter a package by type.
packageVersion String Filter a package by version. If used in combination with include_versionless, then no versionless packages are returned.
sort PackageGroupSort Sort packages by the criteria.
status PackageStatus Filter 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
Name Type Description
active Boolean Filter by active or inactive state.
sort Sort Sort results.
versioned Boolean Filter deployments that are versioned or unversioned.
Group.pipelineAnalytics

Pipeline analytics.

Returns PipelineAnalytics.

Arguments
Name Type Description
fromTime {{< icon name=”warning-solid” >}} Time Introduced in GitLab 17.5. Status: Experiment. Start of the requested time (in UTC). Defaults to the pipelines started in the past week.
ref {{< icon name=”warning-solid” >}} String Introduced in GitLab 17.5. Status: Experiment. Branch that triggered the pipeline.
source {{< icon name=”warning-solid” >}} CiPipelineSources Introduced in GitLab 17.5. Status: Experiment. Source of the pipeline.
toTime {{< icon name=”warning-solid” >}} Time Introduced 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
Name Type Description
includeUnscoped Boolean Filter policies that are scoped to the project.
relationship SecurityPolicyRelationType Filter policies by the given policy relationship. Default is DIRECT.
Group.pipelineExecutionSchedulePolicies

Pipeline Execution Schedule Policies of the namespace.

Returns PipelineExecutionSchedulePolicyConnection.

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

Arguments
Name Type Description
includeUnscoped Boolean Filter policies that are scoped to the project.
relationship SecurityPolicyRelationType Filter policies by the given policy relationship. Default is DIRECT.
Group.projectComplianceRequirementsStatus

Compliance statuses for the projects in a group and its subgroups.

{{< details >}} Introduced in GitLab 17.10. Status: Experiment. {{< /details >}}

Returns ProjectComplianceRequirementStatusConnection.

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

Arguments
Name Type Description
filters GroupProjectRequirementComplianceStatusInput Filters applied when retrieving compliance requirement statuses.
orderBy ProjectComplianceRequirementStatusOrderBy Field used to sort compliance requirement statuses.
Group.projectComplianceStandardsAdherence

Compliance standards adherence for the projects in a group and its subgroups.

Returns ComplianceStandardsAdherenceConnection.

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

Arguments
Name Type Description
filters ComplianceStandardsAdherenceInput Filters applied when retrieving compliance standards adherence.
Group.projects

Projects within this namespace. Returns 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
Name Type Description
archivedOnly Boolean Return only archived projects.
complianceFrameworkFilters ComplianceFrameworkFilters Filters applied when selecting a compliance framework.
hasCodeCoverage Boolean Returns only the projects which have code coverage.
hasVulnerabilities Boolean Returns only the projects which have vulnerabilities.
ids [ID!] Filter projects by IDs.
includeArchived Boolean Include also archived projects.
includeSiblingProjects {{< icon name=”warning-solid” >}} Boolean Introduced in GitLab 17.2. Status: Experiment. Include also projects from parent group.
includeSubgroups Boolean Include also subgroup projects.
notAimedForDeletion Boolean Include projects that are not aimed for deletion.
sbomComponentId ID Return only the projects related to the specified SBOM component.
search String Search project with most similar names or paths.
sort NamespaceProjectSort Sort projects by the criteria.
withIssuesEnabled Boolean Return only projects with issues enabled.
withMergeRequestsEnabled Boolean Return only projects with merge requests enabled.
withNamespaceDomainPages Boolean Return only projects that use the namespace domain for pages projects.
Group.releases

Releases belonging to projects in the group.

Returns ReleaseConnection.

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

Arguments
Name Type Description
sort GroupReleaseSort Sort group releases by given criteria.
Group.remoteDevelopmentClusterAgents

Cluster agents in the namespace with remote development capabilities.

{{< details >}} Deprecated in GitLab 17.8. Use workspacesClusterAgents. {{< /details >}}

Returns ClusterAgentConnection.

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

Arguments
Name Type Description
filter NamespaceClusterAgentFilter! 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.

{{< details >}} Introduced in GitLab 16.10. Status: Experiment. {{< /details >}}

Returns CiRunnerCloudProvisioning.

Arguments
Name Type Description
cloudProjectId GoogleCloudProject! Identifier of the cloud project.
provider CiRunnerCloudProvider! 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
Name Type Description
active {{< icon name=”warning-solid” >}} Boolean Deprecated in GitLab 14.8. This was renamed. Use: paused.
creatorId UserID Filter runners by creator ID.
creatorUsername {{< icon name=”warning-solid” >}} String Introduced in GitLab 16.7. Status: Experiment. Filter runners by creator username.
membership CiRunnerMembershipFilter Control which runners to include in the results.
ownerFullPath {{< icon name=”warning-solid” >}} String Introduced in GitLab 17.8. Status: Experiment. Filter runners by owning project or group.
paused Boolean Filter runners by paused (true) or active (false) status.
search String Filter by full token or partial text in description field.
sort CiRunnerSort Sort order of results.
status CiRunnerStatus Filter runners by status.
tagList [String!] Filter by tags associated with the runner (comma-separated or array).
type CiRunnerType Filter runners by type.
upgradeStatus CiRunnerUpgradeStatus Filter by upgrade status.
versionPrefix {{< icon name=”warning-solid” >}} String Introduced 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
Name Type Description
includeAncestorGroups Boolean Include 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
Name Type Description
id GroupsSavedReplyID! 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
Name Type Description
actionScanTypes [SecurityReportTypeEnum!] Filters policies by the action scan type. Only these scan types are supported: dast, secret_detection, cluster_image_scanning, container_scanning, sast, sast_iac, dependency_scanning.
includeUnscoped Boolean Filter policies that are scoped to the project.
relationship SecurityPolicyRelationType Filter policies by the given policy relationship. Default is DIRECT.
Group.scanResultPolicies

Scan Result Policies of the project.

{{< details >}} Deprecated in GitLab 16.9. Use approvalPolicies. {{< /details >}}

Returns ScanResultPolicyConnection.

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

Arguments
Name Type Description
includeUnscoped Boolean Filter policies that are scoped to the project.
relationship SecurityPolicyRelationType Filter policies by the given policy relationship. Default is DIRECT.
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
Name Type Description
onlyLinked Boolean Whether to suggest only projects already linked as security policy projects.
search String! Search query for projects’ full paths.
Group.standardRole

Finds a single default role for the group. Available only for SaaS.

{{< details >}} Introduced in GitLab 17.6. Status: Experiment. {{< /details >}}

Returns StandardRole.

Arguments
Name Type Description
accessLevel [MemberAccessLevel!] Access level or levels to filter by.
Group.standardRoles

Default roles available for the group. Available only for SaaS.

{{< details >}} Introduced in GitLab 17.4. Status: Experiment. {{< /details >}}

Returns StandardRoleConnection.

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

Arguments
Name Type Description
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
Name Type Description
endDate Time List timelogs within a date range where the logged date is equal to or before endDate.
endTime Time List timelogs within a time range where the logged time is equal to or before endTime.
groupId GroupID List timelogs for a group.
projectId ProjectID List timelogs for a project.
sort TimelogSort List timelogs in a particular order.
startDate Time List timelogs within a date range where the logged date is equal to or after startDate.
startTime Time List timelogs within a time range where the logged time is equal to or after startTime.
username String List timelogs for a user.
Group.valueStreamDashboardUsageOverview

Aggregated usage counts within the group.

{{< details >}} Introduced in GitLab 16.4. Status: Experiment. {{< /details >}}

Returns ValueStreamDashboardCount.

Arguments
Name Type Description
identifier ValueStreamDashboardMetric! Type of counts to retrieve.
timeframe Timeframe! Counts recorded during this time frame, usually from beginning of the month until the end of the month (the system runs monthly aggregations).
Group.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
Name Type Description
id ID Value 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
Name Type Description
clusterAgentId [ClustersAgentID!] Filter vulnerabilities by cluster_agent_id. Vulnerabilities with a reportType of cluster_image_scanning are only included with this filter.
clusterId [ClustersClusterID!] Filter vulnerabilities by cluster_id. Vulnerabilities with a reportType of cluster_image_scanning are only included with this filter.
dismissalReason [VulnerabilityDismissalReason!] Filter by dismissal reason. Only dismissed Vulnerabilities will be included with the filter.
hasAiResolution {{< icon name=”warning-solid” >}} Boolean Introduced 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.
hasIssues Boolean Returns only the vulnerabilities which have linked issues.
hasMergeRequest Boolean Returns only the vulnerabilities which have linked merge requests.
hasRemediations Boolean Returns only the vulnerabilities which have remediations.
hasResolution Boolean Returns only the vulnerabilities which have been resolved on default branch.
identifierName String Filter vulnerabilities by identifier name. Ignored when applied on instance security dashboard queries.
image [String!] Filter vulnerabilities by location image. When this filter is present, the response only matches entries for a reportType that includes container_scanning, cluster_image_scanning.
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.
sort VulnerabilitySort List vulnerabilities by sort order.
state [VulnerabilityState!] Filter vulnerabilities by state.
Group.vulnerabilitiesCountByDay

The historical number of vulnerabilities per day for the projects in the group and its subgroups.

Returns VulnerabilitiesCountByDayConnection.

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

Arguments
Name Type Description
endDate ISO8601Date! Last day for which to fetch vulnerability history.
startDate ISO8601Date! First day for which to fetch vulnerability history.
Group.vulnerabilityGrades

Represents vulnerable project counts for each grade.

Returns [VulnerableProjectsByGrade!].

Arguments
Name Type Description
includeSubgroups Boolean Include grades belonging to subgroups.
letterGrade VulnerabilityGrade Filter the response by given letter grade.
Group.vulnerabilityIdentifierSearch

Search for vulnerabilities by identifier.

Returns [String!].

Arguments
Name Type Description
name String! 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.

{{< details >}} Introduced in GitLab 17.7. Status: Experiment. {{< /details >}}

Returns VulnerabilityManagementPolicyConnection.

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

Arguments
Name Type Description
includeUnscoped Boolean Filter policies that are scoped to the project.
relationship SecurityPolicyRelationType Filter policies by the given policy relationship. Default is DIRECT.
Group.vulnerabilitySeveritiesCount

Counts for each vulnerability severity in the group and its subgroups.

Returns VulnerabilitySeveritiesCount.

Arguments
Name Type Description
capped Boolean Default 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 {{< icon name=”warning-solid” >}} Boolean Introduced 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.
hasIssues Boolean Filter vulnerabilities that do or do not have issues.
hasMergeRequest Boolean Filter vulnerabilities that do or do not have a merge request.
hasRemediations Boolean Filter vulnerabilities that do or do not have remediations.
hasResolution Boolean Filter vulnerabilities that do or do not have a resolution.
identifierName {{< icon name=”warning-solid” >}} String Introduced in GitLab 17.7. Status: Experiment. Filter vulnerabilities by identifier name. Ignored when applied on instance security dashboard queries.
image [String!] Filter vulnerabilities by location image. When this filter is present, the response only matches entries for a reportType that includes container_scanning, cluster_image_scanning.
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.

{{< details >}} Introduced in GitLab 16.4. Status: Experiment. {{< /details >}}

Returns WorkItem.

Arguments
Name Type Description
iid String! IID of the work item.
Group.workItemDescriptionTemplates

Work item description templates available to the namespace.

{{< details >}} Introduced in GitLab 17.6. Status: Experiment. {{< /details >}}

Returns WorkItemDescriptionTemplateConnection.

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

Arguments
Name Type Description
name {{< icon name=”warning-solid” >}} String Deprecated in GitLab 17.9. name and project ID are both required for fetching, use DescriptionTemplateContentInputType instead.
search {{< icon name=”warning-solid” >}} String Deprecated 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.

{{< details >}} Introduced in GitLab 16.7. Status: Experiment. {{< /details >}}

Returns WorkItemStateCountsType.

Arguments
Name Type Description
assigneeUsernames [String!] Usernames of users assigned to the work item.
assigneeWildcardId AssigneeWildcardId Filter by assignee wildcard. Incompatible with assigneeUsernames.
authorUsername String Filter work items by author username.
closedAfter Time Work items closed after the date.
closedBefore Time Work items closed before the date.
confidential Boolean Filter for confidential work items. If false, excludes confidential work items. If true, returns only confidential work items.
createdAfter Time Work items created after the timestamp.
createdBefore Time Work items created before the timestamp.
customField {{< icon name=”warning-solid” >}} [WorkItemWidgetCustomFieldFilterInputType!] Introduced in GitLab 17.10. Status: Experiment. Filter by custom fields.
dueAfter Time Work items due after the timestamp.
dueBefore Time Work items due before the timestamp.
excludeProjects {{< icon name=”warning-solid” >}} Boolean Introduced in GitLab 17.5. Status: Experiment. Exclude work items from projects within the group.
healthStatus HealthStatusFilter Health status of the work item, “none” and “any” values are supported.
iid String IID of the work item. For example, “1”.
iids [String!] List of IIDs of work items. For example, ["1", "2"].
in [IssuableSearchableField!] Specify the fields to perform the search in. Defaults to [TITLE, DESCRIPTION]. Requires the search argument.’.
includeAncestors Boolean Include work items from ancestor groups.
includeDescendants Boolean Include work items from descendant groups and projects.
labelName [String!] Labels applied to the work item.
milestoneTitle [String!] Milestone applied to the work item.
milestoneWildcardId MilestoneWildcardId Filter by milestone ID wildcard. Incompatible with milestoneTitle.
myReactionEmoji String Filter by reaction emoji applied by the current user. Wildcard values NONE and ANY are supported.
not NegatedWorkItemFilterInput Negated work item arguments.
or UnionedWorkItemFilterInput List of arguments with inclusive OR.
requirementLegacyWidget {{< icon name=”warning-solid” >}} RequirementLegacyFilterInput Deprecated in GitLab 15.9. Use work item IID filter instead.
search String Search query for title or description.
sort WorkItemSort Sort work items by criteria.
state IssuableState Current state of the work item.
subscribed SubscriptionStatus Work items the current user is subscribed to.
timeframe Timeframe List items overlapping the given timeframe.
types [IssueType!] Filter work items by the given work item types.
updatedAfter Time Work items updated after the timestamp.
updatedBefore Time Work items updated before the timestamp.
verificationStatusWidget VerificationStatusFilterInput Input for verification status widget filter. Ignored if work_items_alpha is disabled.
weight String Weight 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
Name Type Description
name IssueType Filter work item types by the given name.
Group.workItems

Work items that belong to the namespace.

{{< details >}} Introduced in GitLab 16.3. Status: Experiment. {{< /details >}}

Returns WorkItemConnection.

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

Arguments
Name Type Description
assigneeUsernames [String!] Usernames of users assigned to the work item.
assigneeWildcardId AssigneeWildcardId Filter by assignee wildcard. Incompatible with assigneeUsernames.
authorUsername String Filter work items by author username.
closedAfter Time Work items closed after the date.
closedBefore Time Work items closed before the date.
confidential Boolean Filter for confidential work items. If false, excludes confidential work items. If true, returns only confidential work items.
createdAfter Time Work items created after the timestamp.
createdBefore Time Work items created before the timestamp.
customField {{< icon name=”warning-solid” >}} [WorkItemWidgetCustomFieldFilterInputType!] Introduced in GitLab 17.10. Status: Experiment. Filter by custom fields.
dueAfter Time Work items due after the timestamp.
dueBefore Time Work items due before the timestamp.
excludeProjects {{< icon name=”warning-solid” >}} Boolean Introduced in GitLab 17.5. Status: Experiment. Exclude work items from projects within the group.
healthStatus HealthStatusFilter Health status of the work item, “none” and “any” values are supported.
iid String IID of the work item. For example, “1”.
iids [String!] List of IIDs of work items. For example, ["1", "2"].
in [IssuableSearchableField!] Specify the fields to perform the search in. Defaults to [TITLE, DESCRIPTION]. Requires the search argument.’.
includeAncestors Boolean Include work items from ancestor groups.
includeDescendants Boolean Include work items from descendant groups and projects.
labelName [String!] Labels applied to the work item.
milestoneTitle [String!] Milestone applied to the work item.
milestoneWildcardId MilestoneWildcardId Filter by milestone ID wildcard. Incompatible with milestoneTitle.
myReactionEmoji String Filter by reaction emoji applied by the current user. Wildcard values NONE and ANY are supported.
not NegatedWorkItemFilterInput Negated work item arguments.
or UnionedWorkItemFilterInput List of arguments with inclusive OR.
requirementLegacyWidget {{< icon name=”warning-solid” >}} RequirementLegacyFilterInput Deprecated in GitLab 15.9. Use work item IID filter instead.
search String Search query for title or description.
sort WorkItemSort Sort work items by criteria.
state IssuableState Current state of the work item.
subscribed SubscriptionStatus Work items the current user is subscribed to.
timeframe Timeframe List items overlapping the given timeframe.
types [IssueType!] Filter work items by the given work item types.
updatedAfter Time Work items updated after the timestamp.
updatedBefore Time Work items updated before the timestamp.
verificationStatusWidget VerificationStatusFilterInput Input for verification status widget filter. Ignored if work_items_alpha is disabled.
weight String Weight applied to the work item, “none” and “any” values are supported.
Group.workspacesClusterAgents

Cluster agents in the namespace with workspaces capabilities.

{{< details >}} Introduced in GitLab 17.8. Status: Experiment. {{< /details >}}

Returns ClusterAgentConnection.

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

Arguments
Name Type Description
filter NamespaceClusterAgentFilter! Filter the types of cluster agents to return.

GroupAuditEventNamespaceFilter

Represents a subgroup or project filter that belongs to a group level external audit event streaming destination.

Fields

Name Type Description
externalStreamingDestination GroupAuditEventStreamingDestination! Destination to which the filter belongs.
id ID! ID of the filter.
namespace Namespace! Group or project namespace the filter belongs to.

GroupAuditEventStreamingDestination

Represents an external destination to stream group level audit events.

Fields

Name Type Description
category String! Category of the external destination to send audit events to.
config JSON! Config of the external destination.
eventTypeFilters [String!]! List of event type filters added for streaming.
group Group! Group to which the destination belongs.
id ID! ID of the destination.
name String! Name of the external destination to send audit events to.
namespaceFilters [GroupAuditEventNamespaceFilter!] List of subgroup or project filters for the destination.
secretToken String! Secret token for the destination, will be non-empty value only for http category.

GroupDataTransfer

Fields

Name Type Description
egressNodes EgressNodeConnection Data nodes. (see Connections)

GroupDora

All information related to group DORA metrics.

Fields with arguments

GroupDora.metrics

DORA metrics for the current group or project.

Returns [DoraMetric!].

Arguments
Name Type Description
endDate Date Date range to end at. Default is the current date.
environmentTiers [DeploymentTier!] Deployment tiers of the environments to return. Defaults to [PRODUCTION].
interval DoraMetricBucketingInterval How the metric should be aggregated. Defaults to DAILY. In the case of ALL, the date field in the response will be null.
startDate Date Date range to start from. Default is 3 months ago.
GroupDora.projects

Projects within this group with at least 1 DORA metric for given period.

Returns ProjectConnection!.

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

Arguments
Name Type Description
archivedOnly Boolean Return only archived projects.
complianceFrameworkFilters ComplianceFrameworkFilters Filters applied when selecting a compliance framework.
endDate Date! Date range to end DORA lookup at.
hasCodeCoverage Boolean Returns only the projects which have code coverage.
hasVulnerabilities Boolean Returns only the projects which have vulnerabilities.
ids [ID!] Filter projects by IDs.
includeArchived Boolean Include also archived projects.
includeSiblingProjects {{< icon name=”warning-solid” >}} Boolean Introduced in GitLab 17.2. Status: Experiment. Include also projects from parent group.
includeSubgroups Boolean Include also subgroup projects.
notAimedForDeletion Boolean Include projects that are not aimed for deletion.
sbomComponentId ID Return only the projects related to the specified SBOM component.
search String Search project with most similar names or paths.
sort NamespaceProjectSort Sort projects by the criteria.
startDate Date! Date range to start DORA lookup from.
withIssuesEnabled Boolean Return only projects with issues enabled.
withMergeRequestsEnabled Boolean Return only projects with merge requests enabled.
withNamespaceDomainPages Boolean Return only projects that use the namespace domain for pages projects.

GroupMember

Represents a Group Membership.

Fields

Name Type Description
accessLevel AccessLevel GitLab::Access level.
createdAt Time Date and time the membership was created.
createdBy UserCore User that authorized membership.
expiresAt Time Date and time the membership expires.
group Group Group that a user is a member of.
id ID! ID of the member.
notificationEmail String Group notification email for user. Only available for admins.
updatedAt Time Date and time the membership was last updated.
user UserCore User that is associated with the member object.
userPermissions GroupMemberPermissions! Permissions for the current user on the resource.

Fields with arguments

GroupMember.mergeRequestInteraction

Find a merge request.

Returns UserMergeRequestInteraction.

Arguments
Name Type Description
id MergeRequestID! Global ID of the merge request.

GroupMemberPermissions

Fields

Name Type Description
createCustomEmoji Boolean! If true, the user can perform create_custom_emoji on this resource.
createProjects Boolean! If true, the user can perform create_projects on this resource.
readGroup Boolean! If true, the user can perform read_group on this resource.
removeGroup Boolean! If true, the user can perform remove_group on this resource.
viewEditPage Boolean! If true, the user can perform view_edit_page on this resource.

GroupMinimalAccess

Limited group data accessible to users without full group read access (e.g. non-members with READ_ADMIN_CICD admin custom role).

Fields

Name Type Description
avatarUrl String Avatar URL of the group.
fullName String! Full name of the group.
id ID ID of the group.
name String! Name of the group.
webUrl String Web URL of the group.

GroupPermissions

Fields

Name Type Description
canLeave Boolean! If true, the user can leave this group.
createCustomEmoji Boolean! If true, the user can perform create_custom_emoji on this resource.
createProjects Boolean! If true, the user can perform create_projects on this resource.
generateDescription Boolean! If true, the user can perform generate_description on this resource.
readGroup Boolean! If true, the user can perform read_group on this resource.
removeGroup Boolean! If true, the user can perform remove_group on this resource.
viewEditPage Boolean! If true, the user can perform view_edit_page on this resource.

GroupReleaseStats

Contains release-related statistics about a group.

Fields

Name Type Description
releasesCount Int Total number of releases in all descendant projects of the group.
releasesPercentage Int Percentage of the group’s descendant projects that have at least one release.

GroupSavedReply

Fields

Name Type Description
content String! Content of the saved reply.
id GroupsSavedReplyID! Global ID of the group-level saved reply.
name String! Name of the saved reply.

GroupSecurityPolicySource

Represents the source of a security policy belonging to a group.

Fields

Name Type Description
inherited Boolean! Indicates whether the policy is inherited from parent group.
namespace Namespace Project the policy is associated with.

GroupStats

Contains statistics about a group.

Fields

Name Type Description
releaseStats GroupReleaseStats Statistics related to releases within the group.

GroupValueStreamAnalyticsFlowMetrics

Exposes aggregated value stream flow metrics.

Fields with arguments

GroupValueStreamAnalyticsFlowMetrics.cycleTime

Median time from first commit to issue closed.

Returns ValueStreamAnalyticsMetric.

Arguments
Name Type Description
assigneeUsernames [String!] Usernames of users assigned to the issue.
authorUsername String Username of the author of the issue.
epicId ID ID of an epic associated with the issues.
from Time! Timestamp marking the start date and time.
iterationId ID ID of an iteration associated with the issues.
labelNames [String!] Labels applied to the issue.
milestoneTitle String Milestone applied to the issue.
myReactionEmoji String Filter by reaction emoji applied by the current user.
not NegatedValueStreamAnalyticsIssuableFilterInput Argument used for adding negated filters.
projectIds [ID!] Project IDs within the group hierarchy.
to Time! Timestamp marking the end date and time.
weight Int Weight applied to the issue.
GroupValueStreamAnalyticsFlowMetrics.deploymentCount

Number of production deployments in the given period.

Returns ValueStreamAnalyticsMetric.

Arguments
Name Type Description
from Time! Timestamp marking the start date and time.
projectIds [ID!] Project IDs within the group hierarchy.
to Time! Timestamp marking the end date and time.
GroupValueStreamAnalyticsFlowMetrics.issueCount

Number of issues opened in the given period.

Returns ValueStreamAnalyticsMetric.

Arguments
Name Type Description
assigneeUsernames [String!] Usernames of users assigned to the issue.
authorUsername String Username of the author of the issue.
epicId ID ID of an epic associated with the issues.
from Time! Timestamp marking the start date and time.
iterationId ID ID of an iteration associated with the issues.
labelNames [String!] Labels applied to the issue.
milestoneTitle String Milestone applied to the issue.
myReactionEmoji String Filter by reaction emoji applied by the current user.
not NegatedValueStreamAnalyticsIssuableFilterInput Argument used for adding negated filters.
projectIds [ID!] Project IDs within the group hierarchy.
to Time! Timestamp marking the end date and time.
weight Int Weight applied to the issue.
GroupValueStreamAnalyticsFlowMetrics.issuesCompletedCount

Number of open issues closed (completed) in the given period. Maximum value is 10,001.

Returns ValueStreamAnalyticsMetric.

Arguments
Name Type Description
assigneeUsernames [String!] Usernames of users assigned to the issue.
authorUsername String Username of the author of the issue.
epicId ID ID of an epic associated with the issues.
from Time! Timestamp marking the start date and time.
iterationId ID ID of an iteration associated with the issues.
labelNames [String!] Labels applied to the issue.
milestoneTitle String Milestone applied to the issue.
myReactionEmoji String Filter by reaction emoji applied by the current user.
not NegatedValueStreamAnalyticsIssuableFilterInput Argument used for adding negated filters.
projectIds [ID!] Project IDs within the group hierarchy.
to Time! Timestamp marking the end date and time.
weight Int Weight applied to the issue.
GroupValueStreamAnalyticsFlowMetrics.leadTime

Median time from when the issue was created to when it was closed.

Returns ValueStreamAnalyticsMetric.

Arguments
Name Type Description
assigneeUsernames [String!] Usernames of users assigned to the issue.
authorUsername String Username of the author of the issue.
epicId ID ID of an epic associated with the issues.
from Time! Timestamp marking the start date and time.
iterationId ID ID of an iteration associated with the issues.
labelNames [String!] Labels applied to the issue.
milestoneTitle String Milestone applied to the issue.
myReactionEmoji String Filter by reaction emoji applied by the current user.
not NegatedValueStreamAnalyticsIssuableFilterInput Argument used for adding negated filters.
projectIds [ID!] Project IDs within the group hierarchy.
to Time! Timestamp marking the end date and time.
weight Int Weight applied to the issue.
GroupValueStreamAnalyticsFlowMetrics.timeToMerge

Median time from merge request creation to merge request merged.

Returns ValueStreamAnalyticsMetric.

Arguments
Name Type Description
assigneeUsernames [String!] Usernames of users assigned to the merge request.
authorUsername String Username of the author of the merge request.
from Time! Timestamp marking the start date and time.
labelNames [String!] Labels applied to the merge request.
milestoneTitle String Milestone applied to the merge request.
projectIds [ID!] Project IDs within the group hierarchy.
to Time! Timestamp marking the end date and time.

GroupWikiRepositoryRegistry

Represents the Geo sync and verification state of a group wiki repository.

Fields

Name Type Description
checksumMismatch Boolean Indicate if the checksums of the GroupWikiRepositoryRegistry do not match on the primary and secondary.
createdAt Time Timestamp when the GroupWikiRepositoryRegistry was created.
forceToRedownload {{< icon name=”warning-solid” >}} Boolean Deprecated in GitLab 17.10. Removed from registry tables in the database in favor of the newer reusable framework.
groupWikiRepositoryId ID! ID of the Group Wiki Repository.
id ID! ID of the GroupWikiRepositoryRegistry.
lastSyncFailure String Error message during sync of the GroupWikiRepositoryRegistry.
lastSyncedAt Time Timestamp of the most recent successful sync of the GroupWikiRepositoryRegistry.
missingOnPrimary Boolean Indicate if the GroupWikiRepositoryRegistry is missing on primary.
modelRecordId Int ID of the GroupWikiRepositoryRegistry’s model record.
retryAt Time Timestamp after which the GroupWikiRepositoryRegistry is resynced.
retryCount Int Number of consecutive failed sync attempts of the GroupWikiRepositoryRegistry.
state RegistryState Sync state of the GroupWikiRepositoryRegistry.
verificationChecksum String The local checksum of the GroupWikiRepositoryRegistry.
verificationChecksumMismatched String The expected checksum of the GroupWikiRepositoryRegistry in case of mismatch.
verificationFailure String Error message during verification of the GroupWikiRepositoryRegistry.
verificationRetryAt Time Timestamp after which the GroupWikiRepositoryRegistry is reverified.
verificationRetryCount Int Number of consecutive failed verification attempts of the GroupWikiRepositoryRegistry.
verificationStartedAt Time Timestamp when the verification of GroupWikiRepositoryRegistry started.
verificationState VerificationStateEnum Verification state of the GroupWikiRepositoryRegistry.
verifiedAt Time Timestamp of the most recent successful verification of the GroupWikiRepositoryRegistry.

Groups

Fields

Name Type Description
commit Commit! Commit responsible for specified group.
commitData CommitData HTML data derived from commit needed to present blame.
lineno Int! Starting line number for the commit group.
lines [String!]! Array of lines added for the commit group.
span Int! Number of contiguous lines which the blame spans for the commit group.

HelmFileMetadata

Helm file metadata.

Fields

Name Type Description
channel String! Channel of the Helm chart.
createdAt Time! Date of creation.
metadata PackageHelmMetadataType! Metadata of the Helm chart.
updatedAt Time! Date of most recent update.

Ide

IDE settings and feature flags.

Fields

Name Type Description
codeSuggestionsEnabled Boolean! Indicates whether AI assisted code suggestions are enabled.

ImagePullSecrets

Fields

Name Type Description
name String! Name of the Kubernetes image pull secret.
namespace String! Namespace of the kubernetes image pull secret.

ImportSourceUser

Fields

Name Type Description
createdAt Time! Timestamp of when the source user was created.
id ImportSourceUserID! Global ID of the mapping of a user on source instance to a user on destination instance.
importType ImportSource! Name of the importer.
placeholderUser UserCore Placeholder user associated with the import source user.
reassignToUser UserCore User that contributions are reassigned to.
reassignedByUser UserCore User that did the reassignment.
reassignmentError String Error message if reassignment failed.
sourceHostname String! Source instance hostname.
sourceName String Name of user in the source instance.
sourceUserIdentifier String! ID of the user in the source instance.
sourceUsername String Username of user in the source instance.
status ImportSourceUserStatus! Status of the mapping.

IncidentManagementOncallRotation

Describes an incident management on-call rotation.

Fields

Name Type Description
activePeriod OncallRotationActivePeriodType Active period for the on-call rotation.
endsAt Time End date and time of the on-call rotation.
id IncidentManagementOncallRotationID! ID of the on-call rotation.
length Int Length of the on-call schedule, in the units specified by lengthUnit.
lengthUnit OncallRotationUnitEnum Unit of the on-call rotation length.
name String! Name of the on-call rotation.
participants OncallParticipantTypeConnection Participants of the on-call rotation. (see Connections)
startsAt Time Start date of the on-call rotation.

Fields with arguments

IncidentManagementOncallRotation.shifts

Blocks of time for which a participant is on-call within a given time frame. Time frame cannot exceed one month.

Returns IncidentManagementOncallShiftConnection.

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

Arguments
Name Type Description
endTime Time! End of timeframe to include shifts for. Cannot exceed one month after start.
startTime Time! Start of timeframe to include shifts for.

IncidentManagementOncallSchedule

Describes an incident management on-call schedule.

Fields

Name Type Description
description String Description of the on-call schedule.
iid String! Internal ID of the on-call schedule.
name String! Name of the on-call schedule.
oncallUsers [UserCore!]  
rotations IncidentManagementOncallRotationConnection! On-call rotations for the on-call schedule. (see Connections)
timezone String! Time zone of the on-call schedule.

Fields with arguments

IncidentManagementOncallSchedule.rotation

On-call rotation for the on-call schedule.

Returns IncidentManagementOncallRotation.

Arguments
Name Type Description
id IncidentManagementOncallRotationID! ID of the on-call rotation.

IncidentManagementOncallShift

A block of time for which a participant is on-call.

Fields

Name Type Description
endsAt Time End time of the on-call shift.
participant OncallParticipantType Participant assigned to the on-call shift.
startsAt Time Start time of the on-call shift.

InheritedCiVariable

CI/CD variables a project inherites from its parent group and ancestors.

Fields

Name Type Description
description String Description of the variable.
environmentScope String Scope defining the environments that can use the variable.
groupCiCdSettingsPath String Indicates the path to the CI/CD settings of the group the variable belongs to.
groupName String Indicates group the variable belongs to.
hidden Boolean Indicates whether the variable is hidden.
id ID! ID of the variable.
key String Name of the variable.
masked Boolean Indicates whether the variable is masked.
protected Boolean Indicates whether the variable is protected.
raw Boolean Indicates whether the variable is raw.
variableType CiVariableType Type of the variable.

InstanceAmazonS3ConfigurationType

Stores instance level Amazon S3 configurations for audit event streaming.

Fields

Name Type Description
accessKeyXid String! Access key ID of the Amazon S3 account.
awsRegion String! AWS region where the bucket is created.
bucketName String! Name of the bucket where the audit events would be logged.
id ID! ID of the configuration.
name String! Name of the external destination to send audit events to.

InstanceAuditEventNamespaceFilter

Represents a subgroup or project filter that belongs to an instance level external audit event streaming destination.

Fields

Name Type Description
externalStreamingDestination InstanceAuditEventStreamingDestination! Destination to which the filter belongs.
id ID! ID of the filter.
namespace Namespace! Group or project namespace the filter belongs to.

InstanceAuditEventStreamingDestination

Represents an external destination to stream instance level audit events.

Fields

Name Type Description
category String! Category of the external destination to send audit events to.
config JSON! Config of the external destination.
eventTypeFilters [String!]! List of event type filters added for streaming.
id ID! ID of the destination.
name String! Name of the external destination to send audit events to.
namespaceFilters [InstanceAuditEventNamespaceFilter!] List of subgroup or project filters for the destination.
secretToken String! Secret token for the destination, will be non-empty value only for http category.

InstanceExternalAuditEventDestination

Represents an external resource to send instance audit events to.

Fields

Name Type Description
destinationUrl String! External destination to send audit events to.
eventTypeFilters [String!]! List of event type filters added for streaming.
headers AuditEventsStreamingInstanceHeaderConnection! List of additional HTTP headers sent with each event. (see Connections)
id ID! ID of the destination.
name String! Name of the external destination to send audit events to.
verificationToken String! Verification token to validate source of event.

InstanceGoogleCloudLoggingConfigurationType

Stores instance level Google Cloud Logging configurations associated with IAM service accounts,used for generating access tokens.

Fields

Name Type Description
clientEmail String! Client email.
googleProjectIdName String! Google project ID.
id ID! ID of the configuration.
logIdName String! Log ID.
name String! Name of the external destination to send audit events to.

InstanceSecurityDashboard

Fields

Name Type Description
vulnerabilityScanners VulnerabilityScannerConnection Vulnerability scanners reported on the vulnerabilities from projects selected in Instance Security Dashboard. (see Connections)

Fields with arguments

InstanceSecurityDashboard.clusterAgents

Cluster agents associated with projects selected in the Instance Security Dashboard.

Returns ClusterAgentConnection.

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

Arguments
Name Type Description
hasRemoteDevelopmentAgentConfig {{< icon name=”warning-solid” >}} Boolean Deprecated in GitLab 17.10. Use has_workspaces_agent_config filter instead.
hasRemoteDevelopmentEnabled Boolean Returns only cluster agents which have been enabled with the remote development feature.
hasVulnerabilities Boolean Returns only cluster agents which have vulnerabilities.
hasWorkspacesAgentConfig Boolean Returns only cluster agents which have an associated workspaces agent config.
InstanceSecurityDashboard.projects

Projects selected in Instance Security Dashboard.

Returns ProjectConnection!.

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

Arguments
Name Type Description
search String Search query, which can be for the project name, a path, or a description.
InstanceSecurityDashboard.vulnerabilityGrades

Represents vulnerable project counts for each grade.

Returns [VulnerableProjectsByGrade!]!.

Arguments
Name Type Description
letterGrade VulnerabilityGrade Filter the response by given letter grade.
InstanceSecurityDashboard.vulnerabilitySeveritiesCount

Counts for each vulnerability severity from projects selected in Instance Security Dashboard.

Returns VulnerabilitySeveritiesCount.

Arguments
Name Type Description
capped Boolean Default 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 {{< icon name=”warning-solid” >}} Boolean Introduced 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.
hasIssues Boolean Filter vulnerabilities that do or do not have issues.
hasMergeRequest Boolean Filter vulnerabilities that do or do not have a merge request.
hasRemediations Boolean Filter vulnerabilities that do or do not have remediations.
hasResolution Boolean Filter vulnerabilities that do or do not have a resolution.
identifierName {{< icon name=”warning-solid” >}} String Introduced in GitLab 17.7. Status: Experiment. Filter vulnerabilities by identifier name. Ignored when applied on instance security dashboard queries.
image [String!] Filter vulnerabilities by location image. When this filter is present, the response only matches entries for a reportType that includes container_scanning, cluster_image_scanning.
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

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

IntegrationExclusion

An integration to override the level settings of instance specific integrations.

Fields

Name Type Description
group Group Group that has been excluded from the instance specific integration.
project Project Project that has been excluded from the instance specific integration.

Describes an issuable resource link for incident issues.

Fields

Name Type Description
id IncidentManagementIssuableResourceLinkID! ID of the Issuable resource link.
issue Issue! Incident of the resource link.
link String! Web Link to the resource.
linkText String Optional text for the link.
linkType IssuableResourceLinkType! Type of the resource link.

Issue

Fields

Name Type Description
alertManagementAlert {{< icon name=”warning-solid” >}} AlertManagementAlert Deprecated in GitLab 15.6. Use alert_management_alerts.
assignees UserCoreConnection Assignees of the issue. (see Connections)
author UserCore! User that created the issue.
blocked Boolean! Indicates the issue is blocked.
blockedByCount Int Count of issues blocking the issue.
blockedByIssues IssueConnection Issues blocking the issue. (see Connections)
blockingCount Int! Count of issues the issue is blocking.
closedAsDuplicateOf Issue Issue the issue was closed as a duplicate of.
closedAt Time Timestamp of when the issue was closed.
commenters UserCoreConnection! All commenters on the noteable. (see Connections)
confidential Boolean! Indicates the issue is confidential.
createNoteEmail String User specific email address for the issue.
createdAt Time! Timestamp of when the issue was created.
customerRelationsContacts CustomerRelationsContactConnection Customer relations contacts of the issue. (see Connections)
description String Description of the issue.
descriptionHtml String GitLab Flavored Markdown rendering of description.
designCollection DesignCollection Collection of design images associated with the issue.
discussionLocked Boolean! Indicates discussion is locked on the issue.
discussions DiscussionConnection! All discussions on the noteable. (see Connections)
downvotes Int! Number of downvotes the issue has received.
dueDate Time Due date of the issue.
emailsDisabled {{< icon name=”warning-solid” >}} Boolean! Deprecated in GitLab 16.3. Use emails_enabled.
emailsEnabled Boolean! Indicates if the parent project or group has email notifications disabled: false if email notifications are disabled.
epic {{< icon name=”warning-solid” >}} Epic Deprecated in GitLab 17.5. Replaced by WorkItem type.
escalationPolicy EscalationPolicyType Escalation policy associated with the issue. Available for issues which support escalation.
escalationStatus IssueEscalationStatus Escalation status of the issue.
externalAuthor String Email address of non-GitLab user reporting the issue. For guests, the email address is obfuscated.
hasEpic Boolean! Indicates if the issue belongs to an epic. Can return true and not show an associated epic when the user has no access to the epic.
hasParent {{< icon name=”warning-solid” >}} Boolean! Introduced in GitLab 16.5. Status: Experiment. Indicates if the issue has a parent work item.
healthStatus HealthStatus Current health status.
hidden Boolean Indicates the issue is hidden because the author has been banned.
humanTimeEstimate String Human-readable time estimate of the issue.
humanTotalTimeSpent String Human-readable total time reported as spent on the issue.
id ID! ID of the issue.
iid String! Internal ID of the issue.
iteration Iteration Iteration of the issue.
labels LabelConnection Labels of the issue. (see Connections)
mergeRequestsCount Int! Number of merge requests that close the issue on merge.
metricImages [MetricImage!] Metric images associated to the issue.
milestone Milestone Milestone of the issue.
moved Boolean Indicates if issue got moved from other project.
movedTo Issue Updated Issue after it got moved to another project.
name String Name or title of the object.
participants UserCoreConnection List of participants in the issue. (see Connections)
projectId Int ID of the issue project.
relatedMergeRequests MergeRequestConnection Merge requests related to the issue. This field can only be resolved for one issue in any single request. (see Connections)
relatedVulnerabilities VulnerabilityConnection Related vulnerabilities of the issue. (see Connections)
relativePosition Int Relative position of the issue (used for positioning in epic tree and issue boards).
severity IssuableSeverity Severity level of the incident.
slaDueAt Time Timestamp of when the issue SLA expires.
state IssueState! State of the issue.
status {{< icon name=”warning-solid” >}} WorkItemStatus Introduced in GitLab 18.0. Status: Experiment. Status of the issue.
statusPagePublishedIncident Boolean Indicates whether an issue is published to the status page.
subscribed Boolean! Indicates the currently logged in user is subscribed to the issue.
taskCompletionStatus TaskCompletionStatus! Task completion status of the issue.
timeEstimate Int! Time estimate of the issue.
timelogs TimelogConnection! Timelogs on the issue. (see Connections)
title String! Title of the issue.
titleHtml String GitLab Flavored Markdown rendering of title.
totalTimeSpent Int! Total time (in seconds) reported as spent on the issue.
type IssueType Type of the issue.
updatedAt Time! Timestamp of when the issue was last updated.
updatedBy UserCore User that last updated the issue.
upvotes Int! Number of upvotes the issue has received.
userDiscussionsCount Int! Number of user discussions in the issue.
userNotesCount Int! Number of user notes of the issue.
userPermissions IssuePermissions! Permissions for the current user on the resource.
webPath String! Web path of the issue.
webUrl String! Web URL of the issue.
weight Int Weight of the issue.

Fields with arguments

Issue.alertManagementAlerts

Alert Management alerts associated to this issue.

Returns AlertManagementAlertConnection.

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

Arguments
Name Type Description
assigneeUsername String Username of a user assigned to the issue.
domain AlertManagementDomainFilter! Filter query for given domain.
iid String IID of the alert. For example, “1”.
search String Search query for title, description, service, or monitoring_tool.
sort AlertManagementAlertSort Sort alerts by 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
Name Type Description
state TodoStateEnum State 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
Name Type Description
incidentId IssueID! ID of the incident.
Issue.linkedWorkItems

Work items linked to the issue.

{{< details >}} Introduced in GitLab 17.8. Status: Experiment. {{< /details >}}

Returns LinkedWorkItemTypeConnection.

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

Arguments
Name Type Description
filter WorkItemRelatedLinkType Filter by link type. Supported values: RELATED, BLOCKED_BY, and BLOCKS. Returns all types if omitted.
Issue.notes

All notes on this noteable.

Returns NoteConnection!.

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

Arguments
Name Type Description
filter NotesFilterType Type of notes collection: ALL_NOTES, ONLY_COMMENTS, ONLY_ACTIVITY.
Issue.reference

Internal reference of the issue. Returned in shortened format by default.

Returns String!.

Arguments
Name Type Description
full Boolean Boolean option specifying whether the reference should be returned in full.

IssuePermissions

Check permissions for the current user on a issue.

Fields

Name Type Description
adminIssue Boolean! If true, the user can perform admin_issue on this resource.
adminIssueRelation Boolean! If true, the user can perform admin_issue_relation on this resource.
cloneIssue Boolean! If true, the user can perform clone_issue on this resource.
createDesign Boolean! If true, the user can perform create_design on this resource.
createNote Boolean! If true, the user can perform create_note on this resource.
destroyDesign Boolean! If true, the user can perform destroy_design on this resource.
moveDesign Boolean! If true, the user can perform move_design on this resource.
moveIssue Boolean! If true, the user can perform move_issue on this resource.
readDesign Boolean! If true, the user can perform read_design on this resource.
readIssue Boolean! If true, the user can perform read_issue on this resource.
reopenIssue Boolean! If true, the user can perform reopen_issue on this resource.
updateDesign Boolean! If true, the user can perform update_design on this resource.
updateIssue Boolean! If true, the user can perform update_issue on this resource.

IssueStatusCountsType

Represents total number of issues for the represented statuses.

Fields

Name Type Description
all Int Number of issues with status ALL for the project.
closed Int Number of issues with status CLOSED for the project.
opened Int Number of issues with status OPENED for the project.

Iteration

Represents an iteration object.

Fields

Name Type Description
createdAt Time! Timestamp of iteration creation.
description String Description of the iteration.
descriptionHtml String GitLab Flavored Markdown rendering of description.
dueDate Time Timestamp of the iteration due date.
id ID! ID of the iteration.
iid String! Internal ID of the iteration.
iterationCadence IterationCadence! Cadence of the iteration.
scopedPath String Web path of the iteration, scoped to the query parent. Only valid for Project parents. Returns null in other contexts.
scopedUrl String Web URL of the iteration, scoped to the query parent. Only valid for Project parents. Returns null in other contexts.
sequence Int! Sequence number for the iteration when you sort the containing cadence’s iterations by the start and end date. The earliest starting and ending iteration is assigned 1.
startDate Time Timestamp of the iteration start date.
state IterationState! State of the iteration.
title String Title of the iteration.
updatedAt Time! Timestamp of last iteration update.
webPath String! Web path of the iteration.
webUrl String! Web URL of the iteration.

Fields with arguments

Iteration.report

Historically accurate report about the timebox.

Returns TimeboxReport.

Arguments
Name Type Description
fullPath String Full path of the project or group used as a scope for report. For example, gitlab-org or gitlab-org/gitlab.

IterationCadence

Represents an iteration cadence.

Fields

Name Type Description
active Boolean Whether the iteration cadence is active.
automatic Boolean Whether the iteration cadence should automatically generate upcoming iterations.
description String Description of the iteration cadence. Maximum length is 5000 characters.
durationInWeeks Int Duration in weeks of the iterations within the cadence.
id IterationsCadenceID! Global ID of the iteration cadence.
iterationsInAdvance Int Upcoming iterations to be created when iteration cadence is set to automatic.
rollOver Boolean! Whether the iteration cadence should roll over issues to the next iteration or not.
startDate Time Timestamp of the automation start date.
title String! Title of the iteration cadence.

JiraImport

Fields

Name Type Description
createdAt Time Timestamp of when the Jira import was created.
failedToImportCount Int! Count of issues that failed to import.
importedIssuesCount Int! Count of issues that were successfully imported.
jiraProjectKey String! Project key for the imported Jira project.
scheduledAt Time Timestamp of when the Jira import was scheduled.
scheduledBy UserCore User that started the Jira import.
totalIssueCount Int! Total count of issues that were attempted to import.

JiraProject

Fields

Name Type Description
key String! Key of the Jira project.
name String Name of the Jira project.
projectId Int! ID of the Jira project.

JiraService

Fields

Name Type Description
active Boolean Indicates if the service is active.
serviceType ServiceType Type of the service.
type String Class name of the service.

Fields with arguments

JiraService.projects

List of all Jira projects fetched through Jira REST API.

Returns JiraProjectConnection.

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

Arguments
Name Type Description
name String Project name or key.

JiraUser

Fields

Name Type Description
gitlabId Int ID of the matched GitLab user.
gitlabName String Name of the matched GitLab user.
gitlabUsername String Username of the matched GitLab user.
jiraAccountId String! Account ID of the Jira user.
jiraDisplayName String! Display name of the Jira user.
jiraEmail String Email of the Jira user, returned only for users with public emails.

JobArtifactRegistry

Represents the Geo replication and verification state of a job_artifact.

Fields

Name Type Description
artifactId ID! ID of the Job Artifact.
checksumMismatch Boolean Indicate if the checksums of the JobArtifactRegistry do not match on the primary and secondary.
createdAt Time Timestamp when the JobArtifactRegistry was created.
forceToRedownload {{< icon name=”warning-solid” >}} Boolean Deprecated in GitLab 17.10. Removed from registry tables in the database in favor of the newer reusable framework.
id ID! ID of the JobArtifactRegistry.
lastSyncFailure String Error message during sync of the JobArtifactRegistry.
lastSyncedAt Time Timestamp of the most recent successful sync of the JobArtifactRegistry.
missingOnPrimary Boolean Indicate if the JobArtifactRegistry is missing on primary.
modelRecordId Int ID of the JobArtifactRegistry’s model record.
retryAt Time Timestamp after which the JobArtifactRegistry is resynced.
retryCount Int Number of consecutive failed sync attempts of the JobArtifactRegistry.
state RegistryState Sync state of the JobArtifactRegistry.
verificationChecksum String The local checksum of the JobArtifactRegistry.
verificationChecksumMismatched String The expected checksum of the JobArtifactRegistry in case of mismatch.
verificationFailure String Error message during verification of the JobArtifactRegistry.
verificationRetryAt Time Timestamp after which the JobArtifactRegistry is reverified.
verificationRetryCount Int Number of consecutive failed verification attempts of the JobArtifactRegistry.
verificationStartedAt Time Timestamp when the verification of JobArtifactRegistry started.
verificationState VerificationStateEnum Verification state of the JobArtifactRegistry.
verifiedAt Time Timestamp of the most recent successful verification of the JobArtifactRegistry.

JobPermissions

Fields

Name Type Description
cancelBuild Boolean! If true, the user can perform cancel_build on this resource.
readBuild Boolean! If true, the user can perform read_build on this resource.
readJobArtifacts Boolean! If true, the user can perform read_job_artifacts on this resource.
updateBuild Boolean! If true, the user can perform update_build on this resource.

Kas

Fields

Name Type Description
enabled Boolean! Indicates whether the Kubernetes agent server is enabled.
externalK8sProxyUrl String URL used by the Kubernetes tooling to communicate with the KAS Kubernetes API proxy.
externalUrl String URL used by the agents to communicate with the server.
version String KAS version.

Key

Represents an SSH key.

Fields

Name Type Description
createdAt Time! Timestamp of when the key was created.
expiresAt Time! Timestamp of when the key expires. It’s null if it never expires.
id ID! ID of the key.
key String! Public key of the key pair.
name String Name or title of the object.
title String! Title of the key.
webUrl String URL of the object.

KubernetesAnnotation

Annotation to apply to associated Kubernetes objects of a workspace.

Fields

Name Type Description
key String! Key of the annotation.
value String! Value of the annotation.

KubernetesLabel

Label to apply to associated Kubernetes objects of a workspace.

Fields

Name Type Description
key String! Key of the label.
value String! Value of the label.

Label

Fields

Name Type Description
color String! Background color of the label.
createdAt Time! When the label was created.
description String Description of the label (Markdown rendered as HTML for caching).
descriptionHtml String GitLab Flavored Markdown rendering of description.
id LabelID! Global ID of the label.
lockOnMerge Boolean! Indicates this label is locked for merge requests that have been merged.
textColor String! Text color of the label.
title String! Content of the label.
updatedAt Time! When the label was last updated.

Represents an instance-level LDAP link.

Fields

Name Type Description
adminMemberRole AdminMemberRole! Custom admin member role.
cn String Common Name (CN) of the LDAP group.
filter String Search filter for the LDAP group.
id ID! ID of the LDAP link.
provider LdapProvider! LDAP provider for the LDAP link.

LdapProvider

Represents a LDAP provider.

Fields

Name Type Description
id String ID of the LDAP provider.
label String Display name of the LDAP provider.

LfsObjectRegistry

Represents the Geo sync and verification state of an LFS object.

Fields

Name Type Description
checksumMismatch Boolean Indicate if the checksums of the LfsObjectRegistry do not match on the primary and secondary.
createdAt Time Timestamp when the LfsObjectRegistry was created.
forceToRedownload {{< icon name=”warning-solid” >}} Boolean Deprecated in GitLab 17.10. Removed from registry tables in the database in favor of the newer reusable framework.
id ID! ID of the LfsObjectRegistry.
lastSyncFailure String Error message during sync of the LfsObjectRegistry.
lastSyncedAt Time Timestamp of the most recent successful sync of the LfsObjectRegistry.
lfsObjectId ID! ID of the LFS object.
missingOnPrimary Boolean Indicate if the LfsObjectRegistry is missing on primary.
modelRecordId Int ID of the LfsObjectRegistry’s model record.
retryAt Time Timestamp after which the LfsObjectRegistry is resynced.
retryCount Int Number of consecutive failed sync attempts of the LfsObjectRegistry.
state RegistryState Sync state of the LfsObjectRegistry.
verificationChecksum String The local checksum of the LfsObjectRegistry.
verificationChecksumMismatched String The expected checksum of the LfsObjectRegistry in case of mismatch.
verificationFailure String Error message during verification of the LfsObjectRegistry.
verificationRetryAt Time Timestamp after which the LfsObjectRegistry is reverified.
verificationRetryCount Int Number of consecutive failed verification attempts of the LfsObjectRegistry.
verificationStartedAt Time Timestamp when the verification of LfsObjectRegistry started.
verificationState VerificationStateEnum Verification state of the LfsObjectRegistry.
verifiedAt Time Timestamp of the most recent successful verification of the LfsObjectRegistry.

License

Fields

Name Type Description
name String! Name of the license.
spdxIdentifier String Name of the SPDX identifier.
url String License URL in relation to SPDX.

LicenseHistoryEntry

Represents an entry from the Cloud License history.

Fields

Name Type Description
activatedAt Date Date when the license was activated.
blockChangesAt Date Date, including grace period, when licensed features will be blocked.
company String Company of the licensee.
createdAt Date Date when the license was added.
email String Email of the licensee.
expiresAt Date Date when the license expires.
id ID! ID of the license extracted from the license data.
name String Name of the licensee.
plan String! Name of the subscription plan.
startsAt Date Date when the license started.
type String! Type of the license.
usersInLicenseCount Int Number of paid users in the license.

LinkedWorkItemType

Fields

Name Type Description
linkCreatedAt Time! Timestamp the link was created.
linkId WorkItemsRelatedWorkItemLinkID! Global ID of the link.
linkType String! Type of link.
linkUpdatedAt Time! Timestamp the link was updated.
workItem WorkItem Linked work item.
workItemState WorkItemState! State of the linked work item.

Location

Fields

Name Type Description
ancestors [AncestorType!] Ancestors of the dependency.
blobPath String HTTP URI path to view the input file in GitLab.
path String Path, relative to the root of the repository, of the filewhich was analyzed to detect the dependency.
topLevel Boolean Is top level dependency.

Represents links to perform actions on the candidate.

Fields

Name Type Description
artifactPath String Path to the artifact.
showPath String Path to the details page of the candidate.

Represents links to perform actions on the model.

Fields

Name Type Description
showPath String Path to the details page of the model.

Represents links to perform actions on the model version.

Fields

Name Type Description
importPath String File upload path for the machine learning model.
packagePath String Path to the package of the model version.
showPath String Path to the details page of the model version.

MavenMetadata

Maven metadata.

Fields

Name Type Description
appGroup String! App group of the Maven package.
appName String! App name of the Maven package.
appVersion String App version of the Maven package.
createdAt Time! Date of creation.
id PackagesMavenMetadatumID! ID of the metadatum.
path String! Path of the Maven package.
updatedAt Time! Date of most recent update.

MemberApproval

Represents a Member Approval queued for role promotion.

Fields

Name Type Description
createdAt Time Timestamp when the member approval was created.
member MemberInterface Member associated with the member approval object.
memberRoleId ID ID of the member role.
newAccessLevel AccessLevel New GitLab::Access level requested for the member.
oldAccessLevel AccessLevel Existing GitLab::Access level for the member.
requestedBy UserCore User who requested the member promotion.
reviewedBy UserCore User who reviewed the member promotion.
status String Status for the member approval request (approved, denied, pending).
updatedAt Time Timestamp when the member approval was last updated.
user UserCore User that is associated with the member approval object.

MemberRole

Represents a member role.

Fields

Name Type Description
baseAccessLevel {{< icon name=”warning-solid” >}} AccessLevel! Introduced in GitLab 16.5. Status: Experiment. Base access level for the custom role.
createdAt Time! Timestamp of when the member role was created.
dependentSecurityPolicies [ApprovalPolicy!] Array of security policies dependent on the custom role.
description String Role description.
detailsPath {{< icon name=”warning-solid” >}} String Introduced in GitLab 17.4. Status: Experiment. URL path to the role details webpage.
editPath {{< icon name=”warning-solid” >}} String! Introduced in GitLab 16.11. Status: Experiment. Web UI path to edit the custom role.
enabledPermissions {{< icon name=”warning-solid” >}} CustomizableStandardPermissionConnection! Introduced in GitLab 16.5. Status: Experiment. Array of all permissions enabled for the custom role.
id ID! Role ID.
membersCount {{< icon name=”warning-solid” >}} Int Introduced in GitLab 17.3. Status: Experiment. Number of times the role has been directly assigned to a group or project member.
name String Role name.
usersCount {{< icon name=”warning-solid” >}} Int Introduced 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

Name Type Description
accessLevel Int! GitLab::Access level.
accessLevelDescription String! Human readable representation for the access level.
group AccessLevelGroup Group associated with the access level.
user AccessLevelUser User associated with the access level.

MergeRequest

Fields

Name Type Description
allowCollaboration Boolean Indicates if members of the target project can push to the fork.
allowsMultipleAssignees Boolean! Allows assigning multiple users to a merge request.
allowsMultipleReviewers Boolean! Allows assigning multiple reviewers to a merge request.
approvalState MergeRequestApprovalState! Information relating to rules that must be satisfied to merge the merge request.
approvalsLeft Int Number of approvals left.
approvalsRequired Int Number of approvals required.
approved Boolean! Indicates if the merge request has all the required approvals.
approvedBy UserCoreConnection Users who approved the merge request. (see Connections)
assignees MergeRequestAssigneeConnection Assignees of the merge request. (see Connections)
author MergeRequestAuthor User who created the merge request.
autoMergeEnabled Boolean! Indicates if auto merge is enabled for the merge request.
autoMergeStrategy String Selected auto merge strategy.
availableAutoMergeStrategies [String!] Array of available auto merge strategies.
awardEmoji AwardEmojiConnection List of emoji reactions associated with the merge request. (see Connections)
blockingMergeRequests {{< icon name=”warning-solid” >}} BlockingMergeRequests Introduced in GitLab 16.5. Status: Experiment. Merge requests that block another merge request from merging.
changeRequesters UserCoreConnection Users that have requested changes to the merge request. (see Connections)
closedAt Time Timestamp of when the merge request was closed, null if not closed.
codequalityReportsComparer CodequalityReportsComparer Code quality reports comparison reported on the merge request.
commenters UserCoreConnection! All commenters on the noteable. (see Connections)
commitCount Int Number of commits in the merge request.
commits CommitConnection Merge request commits. (see Connections)
commitsWithoutMergeCommits CommitConnection Merge request commits excluding merge commits. (see Connections)
committers UserCoreConnection Users who have added commits to the merge request. (see Connections)
conflicts Boolean! Indicates if the merge request has conflicts.
createdAt Time! Timestamp of when the merge request was created.
defaultMergeCommitMessage String Default merge commit message of the merge request.
defaultSquashCommitMessage String Default squash commit message of the merge request.
description String Description of the merge request (Markdown rendered as HTML for caching).
descriptionHtml String GitLab Flavored Markdown rendering of description.
detailedMergeStatus DetailedMergeStatus Detailed merge status of the merge request.
diffHeadSha String Diff head SHA of the merge request.
diffRefs DiffRefs References of the base SHA, the head SHA, and the start SHA for the merge request.
diffStatsSummary DiffStatsSummary Summary of which files were changed in the merge request.
discussionLocked Boolean! Indicates if comments on the merge request are locked to members only.
discussions DiscussionConnection! All discussions on the noteable. (see Connections)
divergedFromTargetBranch Boolean! Indicates if the source branch is behind the target branch.
downvotes Int! Number of downvotes for the merge request.
draft Boolean! Indicates if the merge request is a draft.
forceRemoveSourceBranch Boolean Indicates if the project settings will lead to source branch deletion after merge.
hasCi Boolean! Indicates if the merge request has CI.
hasSecurityReports Boolean! Indicates if the source branch has any security reports.
headPipeline Pipeline Pipeline running on the branch HEAD of the merge request.
hidden Boolean Indicates the merge request is hidden because the author has been banned.
humanTimeEstimate String Human-readable time estimate of the merge request.
humanTotalTimeSpent String Human-readable total time reported as spent on the merge request.
id ID! ID of the merge request.
iid String! Internal ID of the merge request.
inProgressMergeCommitSha String Commit SHA of the merge request if merge is in progress.
labels LabelConnection Labels of the merge request. (see Connections)
mergeAfter Time Date after which the merge request can be merged.
mergeCommitSha String SHA of the merge request commit (set once merged).
mergeError String Error message due to a merge error.
mergeOngoing Boolean! Indicates if a merge is currently occurring.
mergeRequestDiffs {{< icon name=”warning-solid” >}} MergeRequestDiffConnection Introduced in GitLab 16.2. Status: Experiment. Diff versions of a merge request.
mergeStatus {{< icon name=”warning-solid” >}} String Deprecated in GitLab 14.0. This was renamed. Use: MergeRequest.mergeStatusEnum.
mergeStatusEnum MergeStatus Merge status of the merge request.
mergeTrainCar {{< icon name=”warning-solid” >}} MergeTrainCar Introduced in GitLab 17.2. Status: Experiment. Represents the merge request in a merge train.
mergeTrainIndex {{< icon name=”warning-solid” >}} Int Deprecated in GitLab 17.4. Use index on MergeTrains::CarType instead.
mergeTrainsCount {{< icon name=”warning-solid” >}} Int Deprecated in GitLab 17.4. Use count from cars connection on MergeTrains::TrainType instead.
mergeUser UserCore User who merged the merge request or set it to auto-merge.
mergeWhenPipelineSucceeds {{< icon name=”warning-solid” >}} Boolean Deprecated in GitLab 17.11. This was renamed. Use: MergeRequest.autoMergeEnabled.
mergeabilityChecks {{< icon name=”warning-solid” >}} [MergeRequestMergeabilityCheck!]! Introduced in GitLab 16.5. Status: Experiment. Status of all mergeability checks of the merge request.
mergeable Boolean! Indicates if the merge request is mergeable.
mergeableDiscussionsState Boolean Indicates if all discussions in the merge request have been resolved, allowing the merge request to be merged.
mergedAt Time Timestamp of when the merge request was merged, null if not merged.
milestone Milestone Milestone of the merge request.
name String Name or title of the object.
participants MergeRequestParticipantConnection Participants 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.
policyViolations PolicyViolationDetails Policy violations reported on the merge request.
preparedAt Time Timestamp of when the merge request was prepared.
project Project! Alias for target_project.
projectId Int! ID of the merge request project.
rebaseCommitSha String Rebase commit SHA of the merge request.
rebaseInProgress Boolean! Indicates if there is a rebase currently in progress for the merge request.
resolvableDiscussionsCount Int Number of user discussions that are resolvable in the merge request.
resolvedDiscussionsCount Int Number of user discussions that are resolved in the merge request.
retargeted Boolean Indicates if merge request was retargeted.
reviewers MergeRequestReviewerConnection Users from whom a review has been requested. (see Connections)
securityAutoFix {{< icon name=”warning-solid” >}} Boolean Deprecated in GitLab 16.11. Security Auto Fix experiment feature was removed. It was always hidden behind security_auto_fix feature flag.
securityReportsUpToDateOnTargetBranch Boolean! Indicates if the target branch security reports are out of date.
shouldBeRebased Boolean! Indicates if the merge request will be rebased.
shouldRemoveSourceBranch Boolean Indicates if the source branch of the merge request will be deleted after merge.
sourceBranch String! Source branch of the merge request.
sourceBranchExists Boolean! Indicates if the source branch of the merge request exists.
sourceBranchProtected Boolean! Indicates if the source branch is protected.
sourceProject Project Source project of the merge request.
sourceProjectId Int ID of the merge request source project.
squash Boolean! Indicates if the merge request is set to be squashed when merged. Project settings may override this value. Use squash_on_merge instead to take project squash options into account.
squashOnMerge Boolean! Indicates if the merge request will be squashed when merged.
squashReadOnly Boolean! Indicates if squashReadOnly is enabled.
state MergeRequestState! State of the merge request.
subscribed Boolean! Indicates if the currently logged in user is subscribed to the merge request.
suggestedReviewers SuggestedReviewersType Suggested reviewers for merge request.
supportsLockOnMerge Boolean! Indicates if the merge request supports locked labels.
targetBranch String! Target branch of the merge request.
targetBranchExists Boolean! Indicates if the target branch of the merge request exists.
targetBranchPath String Path to the target branch of the merge request.
targetProject Project! Target project of the merge request.
targetProjectId Int! ID of the merge request target project.
taskCompletionStatus TaskCompletionStatus! Completion status of tasks.
timeEstimate Int! Time estimate of the merge request.
timelogs TimelogConnection! Timelogs on the merge request. (see Connections)
title String! Title of the merge request.
titleHtml String GitLab Flavored Markdown rendering of title.
totalTimeSpent Int! Total time (in seconds) reported as spent on the merge request.
updatedAt Time! Timestamp of when the merge request was last updated.
upvotes Int! Number of upvotes for the merge request.
userDiscussionsCount Int Number of user discussions in the merge request.
userNotesCount Int User notes count of the merge request.
userPermissions MergeRequestPermissions! Permissions for the current user on the resource.
webPath String! Web path of the merge request.
webUrl String Web URL of the merge request.

Fields with arguments

MergeRequest.currentUserTodos

To-do items for the current user.

Returns TodoConnection!.

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

Arguments
Name Type Description
state TodoStateEnum State of the to-do items.
MergeRequest.diffStats

Details about which files were changed in the merge request.

Returns [DiffStats!].

Arguments
Name Type Description
path String Specific file path.
MergeRequest.findingReportsComparer

Vulnerability finding reports comparison reported on the merge request.

{{< details >}} Introduced in GitLab 16.1. Status: Experiment. {{< /details >}}

Returns FindingReportsComparer.

Arguments
Name Type Description
reportType ComparableSecurityReportType! Filter vulnerability findings by report type.
MergeRequest.notes

All notes on this noteable.

Returns NoteConnection!.

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

Arguments
Name Type Description
filter NotesFilterType Type of notes collection: ALL_NOTES, ONLY_COMMENTS, ONLY_ACTIVITY.
MergeRequest.pipelines

Pipelines for the merge request. Note: for performance reasons, no more than the most recent 500 pipelines will be returned.

Returns PipelineConnection.

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

Arguments
Name Type Description
ref String Filter pipelines by the ref they are run for.
scope PipelineScopeEnum Filter pipelines by scope.
sha String Filter pipelines by the sha of the commit they are run for.
source String Filter pipelines by their source.
status PipelineStatusEnum Filter pipelines by their status.
updatedAfter Time Pipelines updated after the date.
updatedBefore Time Pipelines updated before the date.
username String Filter pipelines by the user that triggered the pipeline.
MergeRequest.reference

Internal reference of the merge request. Returned in shortened format by default.

Returns String!.

Arguments
Name Type Description
full Boolean Boolean option specifying whether the reference should be returned in full.

MergeRequestApprovalState

Information relating to rules that must be satisfied to merge this merge request.

Fields

Name Type Description
approvalRulesOverwritten Boolean Indicates if the merge request approval rules are overwritten for the merge request.
invalidApproversRules [ApprovalRule!] List of approval rules that are associated with the merge request, but invalid.
rules [ApprovalRule!] List of approval rules associated with the merge request.
suggestedApprovers UserCoreConnection List of suggested approvers. (see Connections)

MergeRequestAssignee

A user assigned to a merge request.

Fields

Name Type Description
active Boolean Indicates if the user is active.
avatarUrl String URL of the user’s avatar.
bio String Bio of the user.
bot Boolean! Indicates if the user is a bot.
callouts UserCalloutConnection User callouts that belong to the user. (see Connections)
commitEmail String User’s default commit email.
createdAt Time Timestamp of when the user was created.
discord String Discord ID of the user.
email {{< icon name=”warning-solid” >}} String Deprecated in GitLab 13.7. This was renamed. Use: User.publicEmail.
emails EmailConnection User’s email addresses. (see Connections)
gitpodEnabled Boolean Whether Gitpod is enabled at the user level.
groupCount Int Group count for the user.
groupMemberships GroupMemberConnection Group memberships of the user. (see Connections)
human Boolean Indicates if the user is a regular user.
id UserID! Global ID of the user.
ide Ide IDE settings.
jobTitle String Job title of the user.
lastActivityOn Date Date the user last performed any actions.
linkedin String LinkedIn profile name of the user.
location String Location of the user.
mergeRequestInteraction UserMergeRequestInteraction Details of the user’s interactions with the merge request.
name String! Human-readable name of the user. Returns **** if the user is a project bot and the requester does not have permission to view the project.
namespace Namespace Personal namespace of the user.
namespaceCommitEmails NamespaceCommitEmailConnection User’s custom namespace commit emails. (see Connections)
organization String Who the user represents or works for.
preferencesGitpodPath String Web path to the Gitpod section within user preferences.
profileEnableGitpodPath String Web path to enable Gitpod for the user.
projectMemberships ProjectMemberConnection Project memberships of the user. (see Connections)
pronouns String Pronouns of the user.
publicEmail String User’s public email.
savedReplies SavedReplyConnection Saved replies authored by the user. (see Connections)
state UserState! State of the user.
status UserStatus User status.
twitter String X (formerly Twitter) username of the user.
type UserType! Type of the user.
userPermissions UserPermissions! Permissions for the current user on the resource.
userPreferences UserPreferences Preferences for the user.
username String! Username of the user. Unique within the instance of GitLab.
webPath String! Web path of the user.
webUrl String! Web URL of the user.

Fields with arguments

MergeRequestAssignee.assignedMergeRequests

Merge requests assigned to the user.

Returns MergeRequestConnection.

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

Arguments
Name Type Description
approved Boolean Limit results to approved merge requests. Available only when the feature flag mr_approved_filter is enabled.
approvedBy [String!] Usernames of the approvers.
approver [String!] Usernames of possible approvers.
authorUsername String Username of the author.
blobPath {{< icon name=”warning-solid” >}} String Introduced 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.
createdAfter Time Merge requests created after the timestamp.
createdBefore Time Merge requests created before the timestamp.
deployedAfter Time Merge requests deployed after the timestamp.
deployedBefore Time Merge requests deployed before the timestamp.
deploymentId String ID of the deployment.
draft Boolean Limit result to draft merge requests.
environmentName String Environment merge requests have been deployed to.
groupId GroupID The global ID of the group the authored merge requests should be in. Merge requests in subgroups are included.
ignoredReviewerUsername {{< icon name=”warning-solid” >}} String Introduced in GitLab 18.0. Status: Experiment. Username of the reviewer to ignore when searching by reviewer state.
iids [String!] Array of IIDs of merge requests, for example [1, 2].
in [IssuableSearchableField!] Specify the fields to perform the search in. Defaults to [TITLE, DESCRIPTION]. Requires the search argument.’.
includeArchived Boolean Merge requests from archived projects.
labelName [String] Labels applied to the merge request.
labels {{< icon name=”warning-solid” >}} [String!] Deprecated in GitLab 17.1. Use labelName.
mergedAfter Time Merge requests merged after the date.
mergedBefore Time Merge requests merged before the date.
mergedBy String Username of the merger.
milestoneTitle String Title of the milestone. Incompatible with milestoneWildcardId.
milestoneWildcardId MilestoneWildcardId Filter issues by milestone ID wildcard. Incompatible with milestoneTitle.
myReactionEmoji String Filter by your reaction emoji.
not MergeRequestsResolverNegatedParams List of negated arguments. Warning: this argument is experimental and a subject to change in future.
or UnionedMergeRequestFilterInput List of arguments with inclusive OR.
projectId ProjectID The global ID of the project the authored merge requests should be in. Incompatible with projectPath.
projectPath String The full-path of the project the authored merge requests should be in. Incompatible with projectId.
releaseTag String Filter by release tag.
reviewState {{< icon name=”warning-solid” >}} MergeRequestReviewState Introduced in GitLab 17.0. Status: Experiment. Reviewer state of the merge request.
reviewStates {{< icon name=”warning-solid” >}} [MergeRequestReviewState!] Introduced in GitLab 17.0. Status: Experiment. Reviewer states of the merge request.
reviewerUsername String Username of the reviewer.
reviewerWildcardId ReviewerWildcardId Filter by reviewer presence. Incompatible with reviewerUsername.
search String Search query for title or description.
sort MergeRequestSort Sort merge requests by the criteria.
sourceBranches [String!] Array of source branch names. All resolved merge requests will have one of these branches as their source.
state MergeRequestState Merge request state. If provided, all resolved merge requests will have the state.
subscribed SubscriptionStatus Merge requests the current user is subscribed to.
targetBranches [String!] Array of target branch names. All resolved merge requests will have one of these branches as their target.
updatedAfter Time Merge requests updated after the timestamp.
updatedBefore Time Merge requests updated before the timestamp.
MergeRequestAssignee.authoredMergeRequests

Merge requests authored by the user.

Returns MergeRequestConnection.

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

Arguments
Name Type Description
approved Boolean Limit results to approved merge requests. Available only when the feature flag mr_approved_filter is enabled.
approvedBy [String!] Usernames of the approvers.
approver [String!] Usernames of possible approvers.
assigneeUsername String Username of the assignee.
assigneeUsernames [String!] Usernames of users assigned to the merge request.
assigneeWildcardId AssigneeWildcardId Filter by assignee presence. Incompatible with assigneeUsernames and assigneeUsername.
blobPath {{< icon name=”warning-solid” >}} String Introduced 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.
createdAfter Time Merge requests created after the timestamp.
createdBefore Time Merge requests created before the timestamp.
deployedAfter Time Merge requests deployed after the timestamp.
deployedBefore Time Merge requests deployed before the timestamp.
deploymentId String ID of the deployment.
draft Boolean Limit result to draft merge requests.
environmentName String Environment merge requests have been deployed to.
groupId GroupID The global ID of the group the authored merge requests should be in. Merge requests in subgroups are included.
ignoredReviewerUsername {{< icon name=”warning-solid” >}} String Introduced in GitLab 18.0. Status: Experiment. Username of the reviewer to ignore when searching by reviewer state.
iids [String!] Array of IIDs of merge requests, for example [1, 2].
in [IssuableSearchableField!] Specify the fields to perform the search in. Defaults to [TITLE, DESCRIPTION]. Requires the search argument.’.
includeArchived Boolean Merge requests from archived projects.
includeAssigned Boolean Include merge requests the user is assigned to.
labelName [String] Labels applied to the merge request.
labels {{< icon name=”warning-solid” >}} [String!] Deprecated in GitLab 17.1. Use labelName.
mergedAfter Time Merge requests merged after the date.
mergedBefore Time Merge requests merged before the date.
mergedBy String Username of the merger.
milestoneTitle String Title of the milestone. Incompatible with milestoneWildcardId.
milestoneWildcardId MilestoneWildcardId Filter issues by milestone ID wildcard. Incompatible with milestoneTitle.
myReactionEmoji String Filter by your reaction emoji.
not MergeRequestsResolverNegatedParams List of negated arguments. Warning: this argument is experimental and a subject to change in future.
or UnionedMergeRequestFilterInput List of arguments with inclusive OR.
projectId ProjectID The global ID of the project the authored merge requests should be in. Incompatible with projectPath.
projectPath String The full-path of the project the authored merge requests should be in. Incompatible with projectId.
releaseTag String Filter by release tag.
reviewState {{< icon name=”warning-solid” >}} MergeRequestReviewState Introduced in GitLab 17.0. Status: Experiment. Reviewer state of the merge request.
reviewStates {{< icon name=”warning-solid” >}} [MergeRequestReviewState!] Introduced in GitLab 17.0. Status: Experiment. Reviewer states of the merge request.
reviewerUsername String Username of the reviewer.
reviewerWildcardId ReviewerWildcardId Filter by reviewer presence. Incompatible with reviewerUsername.
search String Search query for title or description.
sort MergeRequestSort Sort merge requests by the criteria.
sourceBranches [String!] Array of source branch names. All resolved merge requests will have one of these branches as their source.
state MergeRequestState Merge request state. If provided, all resolved merge requests will have the state.
subscribed SubscriptionStatus Merge requests the current user is subscribed to.
targetBranches [String!] Array of target branch names. All resolved merge requests will have one of these branches as their target.
updatedAfter Time Merge requests updated after the timestamp.
updatedBefore Time Merge requests updated before the timestamp.
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
Name Type Description
includePersonal Boolean Include personal projects.
minAccessLevel AccessLevelEnum Return only projects where current user has at least the specified access level.
programmingLanguageName String Filter projects by programming language name (case insensitive). For example: “css” or “ruby”.
search String Search query.
sort ProjectSort Sort contributed projects.
MergeRequestAssignee.groups

Groups where the user has access.

Returns GroupConnection.

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

Arguments
Name Type Description
permissionScope GroupPermission Filter by permissions the user has on groups.
search String Search by group name or path.
sort GroupSort Sort groups by given criteria.
MergeRequestAssignee.organizations

Organizations where the user has access.

{{< details >}} Introduced in GitLab 16.6. Status: Experiment. {{< /details >}}

Returns OrganizationConnection.

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

Arguments
Name Type Description
search String Search query, which can be for the organization name or a path.
soloOwned Boolean When 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
Name Type Description
approved Boolean Limit 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.
assigneeUsername String Username of the assignee.
assigneeUsernames [String!] Usernames of users assigned to the merge request.
assigneeWildcardId AssigneeWildcardId Filter by assignee presence. Incompatible with assigneeUsernames and assigneeUsername.
authorUsername String Username of the author.
blobPath {{< icon name=”warning-solid” >}} String Introduced 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.
createdAfter Time Merge requests created after the timestamp.
createdBefore Time Merge requests created before the timestamp.
deployedAfter Time Merge requests deployed after the timestamp.
deployedBefore Time Merge requests deployed before the timestamp.
deploymentId String ID of the deployment.
draft Boolean Limit result to draft merge requests.
environmentName String Environment merge requests have been deployed to.
groupId GroupID The global ID of the group the authored merge requests should be in. Merge requests in subgroups are included.
ignoredReviewerUsername {{< icon name=”warning-solid” >}} String Introduced in GitLab 18.0. Status: Experiment. Username of the reviewer to ignore when searching by reviewer state.
iids [String!] Array of IIDs of merge requests, for example [1, 2].
in [IssuableSearchableField!] Specify the fields to perform the search in. Defaults to [TITLE, DESCRIPTION]. Requires the search argument.’.
includeArchived Boolean Merge requests from archived projects.
labelName [String] Labels applied to the merge request.
labels {{< icon name=”warning-solid” >}} [String!] Deprecated in GitLab 17.1. Use labelName.
mergedAfter Time Merge requests merged after the date.
mergedBefore Time Merge requests merged before the date.
mergedBy String Username of the merger.
milestoneTitle String Title of the milestone. Incompatible with milestoneWildcardId.
milestoneWildcardId MilestoneWildcardId Filter issues by milestone ID wildcard. Incompatible with milestoneTitle.
myReactionEmoji String Filter by your reaction emoji.
not MergeRequestsResolverNegatedParams List of negated arguments. Warning: this argument is experimental and a subject to change in future.
or UnionedMergeRequestFilterInput List of arguments with inclusive OR.
projectId ProjectID The global ID of the project the authored merge requests should be in. Incompatible with projectPath.
projectPath String The full-path of the project the authored merge requests should be in. Incompatible with projectId.
releaseTag String Filter by release tag.
reviewState {{< icon name=”warning-solid” >}} MergeRequestReviewState Introduced in GitLab 17.0. Status: Experiment. Reviewer state of the merge request.
reviewStates {{< icon name=”warning-solid” >}} [MergeRequestReviewState!] Introduced in GitLab 17.0. Status: Experiment. Reviewer states of the merge request.
search String Search query for title or description.
sort MergeRequestSort Sort merge requests by the criteria.
sourceBranches [String!] Array of source branch names. All resolved merge requests will have one of these branches as their source.
state MergeRequestState Merge request state. If provided, all resolved merge requests will have the state.
subscribed SubscriptionStatus Merge requests the current user is subscribed to.
targetBranches [String!] Array of target branch names. All resolved merge requests will have one of these branches as their target.
updatedAfter Time Merge requests updated after the timestamp.
updatedBefore Time Merge requests updated before the timestamp.
MergeRequestAssignee.savedReply

Saved reply authored by the user.

Returns SavedReply.

Arguments
Name Type Description
id UsersSavedReplyID! ID of a saved reply.
MergeRequestAssignee.snippets

Snippets authored by the user.

Returns SnippetConnection.

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

Arguments
Name Type Description
ids [SnippetID!] Array of global snippet IDs. For example, gid://gitlab/ProjectSnippet/1.
type TypeEnum Type of snippet.
visibility VisibilityScopesEnum Visibility of the snippet.
MergeRequestAssignee.starredProjects

Projects starred by the user.

Returns ProjectConnection.

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

Arguments
Name Type Description
minAccessLevel AccessLevelEnum Return only projects where current user has at least the specified access level.
programmingLanguageName String Filter projects by programming language name (case insensitive). For example: “css” or “ruby”.
search String Search query.
sort ProjectSort List starred projects by sort order.
MergeRequestAssignee.timelogs

Time logged by the user.

Returns TimelogConnection.

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

Arguments
Name Type Description
endDate Time List timelogs within a date range where the logged date is equal to or before endDate.
endTime Time List timelogs within a time range where the logged time is equal to or before endTime.
groupId GroupID List timelogs for a group.
projectId ProjectID List timelogs for a project.
sort TimelogSort List timelogs in a particular order.
startDate Time List timelogs within a date range where the logged date is equal to or after startDate.
startTime Time List timelogs within a time range where the logged time is equal to or after startTime.
username String List timelogs for a user.
MergeRequestAssignee.todos

To-do items of the user.

Returns TodoConnection.

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

Arguments
Name Type Description
action [TodoActionEnum!] Action to be filtered.
authorId [ID!] ID of an author.
groupId [ID!] ID of a group.
isSnoozed Boolean Whether the to-do item is snoozed.
projectId [ID!] ID of a project.
sort TodoSort Sort todos by given criteria.
state [TodoStateEnum!] State of the todo.
type [TodoTargetEnum!] Type of the todo.
MergeRequestAssignee.userAchievements

Achievements for the user. Only returns for namespaces where the achievements feature flag is enabled.

{{< details >}} Introduced in GitLab 15.10. Status: Experiment. {{< /details >}}

Returns UserAchievementConnection.

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

Arguments
Name Type Description
includeHidden Boolean Indicates 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
Name Type Description
actualStates [String!] Filter workspaces by actual states.
agentIds [ClustersAgentID!] Filter workspaces by agent GlobalIDs.
ids [RemoteDevelopmentWorkspaceID!] Filter workspaces by workspace GlobalIDs. For example, ["gid://gitlab/RemoteDevelopment::Workspace/1"].
includeActualStates {{< icon name=”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

Name Type Description
active Boolean Indicates if the user is active.
avatarUrl String URL of the user’s avatar.
bio String Bio of the user.
bot Boolean! Indicates if the user is a bot.
callouts UserCalloutConnection User callouts that belong to the user. (see Connections)
commitEmail String User’s default commit email.
createdAt Time Timestamp of when the user was created.
discord String Discord ID of the user.
email {{< icon name=”warning-solid” >}} String Deprecated in GitLab 13.7. This was renamed. Use: User.publicEmail.
emails EmailConnection User’s email addresses. (see Connections)
gitpodEnabled Boolean Whether Gitpod is enabled at the user level.
groupCount Int Group count for the user.
groupMemberships GroupMemberConnection Group memberships of the user. (see Connections)
human Boolean Indicates if the user is a regular user.
id UserID! Global ID of the user.
ide Ide IDE settings.
jobTitle String Job title of the user.
lastActivityOn Date Date the user last performed any actions.
linkedin String LinkedIn profile name of the user.
location String Location of the user.
mergeRequestInteraction UserMergeRequestInteraction Details of the user’s interactions with the merge request.
name String! Human-readable name of the user. Returns **** if the user is a project bot and the requester does not have permission to view the project.
namespace Namespace Personal namespace of the user.
namespaceCommitEmails NamespaceCommitEmailConnection User’s custom namespace commit emails. (see Connections)
organization String Who the user represents or works for.
preferencesGitpodPath String Web path to the Gitpod section within user preferences.
profileEnableGitpodPath String Web path to enable Gitpod for the user.
projectMemberships ProjectMemberConnection Project memberships of the user. (see Connections)
pronouns String Pronouns of the user.
publicEmail String User’s public email.
savedReplies SavedReplyConnection Saved replies authored by the user. (see Connections)
state UserState! State of the user.
status UserStatus User status.
twitter String X (formerly Twitter) username of the user.
type UserType! Type of the user.
userPermissions UserPermissions! Permissions for the current user on the resource.
userPreferences UserPreferences Preferences for the user.
username String! Username of the user. Unique within the instance of GitLab.
webPath String! Web path of the user.
webUrl String! Web URL of the user.

Fields with arguments

MergeRequestAuthor.assignedMergeRequests

Merge requests assigned to the user.

Returns MergeRequestConnection.

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

Arguments
Name Type Description
approved Boolean Limit results to approved merge requests. Available only when the feature flag mr_approved_filter is enabled.
approvedBy [String!] Usernames of the approvers.
approver [String!] Usernames of possible approvers.
authorUsername String Username of the author.
blobPath {{< icon name=”warning-solid” >}} String Introduced 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.
createdAfter Time Merge requests created after the timestamp.
createdBefore Time Merge requests created before the timestamp.
deployedAfter Time Merge requests deployed after the timestamp.
deployedBefore Time Merge requests deployed before the timestamp.
deploymentId String ID of the deployment.
draft Boolean Limit result to draft merge requests.
environmentName String Environment merge requests have been deployed to.
groupId GroupID The global ID of the group the authored merge requests should be in. Merge requests in subgroups are included.
ignoredReviewerUsername {{< icon name=”warning-solid” >}} String Introduced in GitLab 18.0. Status: Experiment. Username of the reviewer to ignore when searching by reviewer state.
iids [String!] Array of IIDs of merge requests, for example [1, 2].
in [IssuableSearchableField!] Specify the fields to perform the search in. Defaults to [TITLE, DESCRIPTION]. Requires the search argument.’.
includeArchived Boolean Merge requests from archived projects.
labelName [String] Labels applied to the merge request.
labels {{< icon name=”warning-solid” >}} [String!] Deprecated in GitLab 17.1. Use labelName.
mergedAfter Time Merge requests merged after the date.
mergedBefore Time Merge requests merged before the date.
mergedBy String Username of the merger.
milestoneTitle String Title of the milestone. Incompatible with milestoneWildcardId.
milestoneWildcardId MilestoneWildcardId Filter issues by milestone ID wildcard. Incompatible with milestoneTitle.
myReactionEmoji String Filter by your reaction emoji.
not MergeRequestsResolverNegatedParams List of negated arguments. Warning: this argument is experimental and a subject to change in future.
or UnionedMergeRequestFilterInput List of arguments with inclusive OR.
projectId ProjectID The global ID of the project the authored merge requests should be in. Incompatible with projectPath.
projectPath String The full-path of the project the authored merge requests should be in. Incompatible with projectId.
releaseTag String Filter by release tag.
reviewState {{< icon name=”warning-solid” >}} MergeRequestReviewState Introduced in GitLab 17.0. Status: Experiment. Reviewer state of the merge request.
reviewStates {{< icon name=”warning-solid” >}} [MergeRequestReviewState!] Introduced in GitLab 17.0. Status: Experiment. Reviewer states of the merge request.
reviewerUsername String Username of the reviewer.
reviewerWildcardId ReviewerWildcardId Filter by reviewer presence. Incompatible with reviewerUsername.
search String Search query for title or description.
sort MergeRequestSort Sort merge requests by the criteria.
sourceBranches [String!] Array of source branch names. All resolved merge requests will have one of these branches as their source.
state MergeRequestState Merge request state. If provided, all resolved merge requests will have the state.
subscribed SubscriptionStatus Merge requests the current user is subscribed to.
targetBranches [String!] Array of target branch names. All resolved merge requests will have one of these branches as their target.
updatedAfter Time Merge requests updated after the timestamp.
updatedBefore Time Merge requests updated before the timestamp.
MergeRequestAuthor.authoredMergeRequests

Merge requests authored by the user.

Returns MergeRequestConnection.

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

Arguments
Name Type Description
approved Boolean Limit results to approved merge requests. Available only when the feature flag mr_approved_filter is enabled.
approvedBy [String!] Usernames of the approvers.
approver [String!] Usernames of possible approvers.
assigneeUsername String Username of the assignee.
assigneeUsernames [String!] Usernames of users assigned to the merge request.
assigneeWildcardId AssigneeWildcardId Filter by assignee presence. Incompatible with assigneeUsernames and assigneeUsername.
blobPath {{< icon name=”warning-solid” >}} String Introduced 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.
createdAfter Time Merge requests created after the timestamp.
createdBefore Time Merge requests created before the timestamp.
deployedAfter Time Merge requests deployed after the timestamp.
deployedBefore Time Merge requests deployed before the timestamp.
deploymentId String ID of the deployment.
draft Boolean Limit result to draft merge requests.
environmentName String Environment merge requests have been deployed to.
groupId GroupID The global ID of the group the authored merge requests should be in. Merge requests in subgroups are included.
ignoredReviewerUsername {{< icon name=”warning-solid” >}} String Introduced in GitLab 18.0. Status: Experiment. Username of the reviewer to ignore when searching by reviewer state.
iids [String!] Array of IIDs of merge requests, for example [1, 2].
in [IssuableSearchableField!] Specify the fields to perform the search in. Defaults to [TITLE, DESCRIPTION]. Requires the search argument.’.
includeArchived Boolean Merge requests from archived projects.
includeAssigned Boolean Include merge requests the user is assigned to.
labelName [String] Labels applied to the merge request.
labels {{< icon name=”warning-solid” >}} [String!] Deprecated in GitLab 17.1. Use labelName.
mergedAfter Time Merge requests merged after the date.
mergedBefore Time Merge requests merged before the date.
mergedBy String Username of the merger.
milestoneTitle String Title of the milestone. Incompatible with milestoneWildcardId.
milestoneWildcardId MilestoneWildcardId Filter issues by milestone ID wildcard. Incompatible with milestoneTitle.
myReactionEmoji String Filter by your reaction emoji.
not MergeRequestsResolverNegatedParams List of negated arguments. Warning: this argument is experimental and a subject to change in future.
or UnionedMergeRequestFilterInput List of arguments with inclusive OR.
projectId ProjectID The global ID of the project the authored merge requests should be in. Incompatible with projectPath.
projectPath String The full-path of the project the authored merge requests should be in. Incompatible with projectId.
releaseTag String Filter by release tag.
reviewState {{< icon name=”warning-solid” >}} MergeRequestReviewState Introduced in GitLab 17.0. Status: Experiment. Reviewer state of the merge request.
reviewStates {{< icon name=”warning-solid” >}} [MergeRequestReviewState!] Introduced in GitLab 17.0. Status: Experiment. Reviewer states of the merge request.
reviewerUsername String Username of the reviewer.
reviewerWildcardId ReviewerWildcardId Filter by reviewer presence. Incompatible with reviewerUsername.
search String Search query for title or description.
sort MergeRequestSort Sort merge requests by the criteria.
sourceBranches [String!] Array of source branch names. All resolved merge requests will have one of these branches as their source.
state MergeRequestState Merge request state. If provided, all resolved merge requests will have the state.
subscribed SubscriptionStatus Merge requests the current user is subscribed to.
targetBranches [String!] Array of target branch names. All resolved merge requests will have one of these branches as their target.
updatedAfter Time Merge requests updated after the timestamp.
updatedBefore Time Merge requests updated before the timestamp.
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
Name Type Description
includePersonal Boolean Include personal projects.
minAccessLevel AccessLevelEnum Return only projects where current user has at least the specified access level.
programmingLanguageName String Filter projects by programming language name (case insensitive). For example: “css” or “ruby”.
search String Search query.
sort ProjectSort Sort contributed projects.
MergeRequestAuthor.groups

Groups where the user has access.

Returns GroupConnection.

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

Arguments
Name Type Description
permissionScope GroupPermission Filter by permissions the user has on groups.
search String Search by group name or path.
sort GroupSort Sort groups by given criteria.
MergeRequestAuthor.organizations

Organizations where the user has access.

{{< details >}} Introduced in GitLab 16.6. Status: Experiment. {{< /details >}}

Returns OrganizationConnection.

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

Arguments
Name Type Description
search String Search query, which can be for the organization name or a path.
soloOwned Boolean When 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
Name Type Description
approved Boolean Limit 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.
assigneeUsername String Username of the assignee.
assigneeUsernames [String!] Usernames of users assigned to the merge request.
assigneeWildcardId AssigneeWildcardId Filter by assignee presence. Incompatible with assigneeUsernames and assigneeUsername.
authorUsername String Username of the author.
blobPath {{< icon name=”warning-solid” >}} String Introduced 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.
createdAfter Time Merge requests created after the timestamp.
createdBefore Time Merge requests created before the timestamp.
deployedAfter Time Merge requests deployed after the timestamp.
deployedBefore Time Merge requests deployed before the timestamp.
deploymentId String ID of the deployment.
draft Boolean Limit result to draft merge requests.
environmentName String Environment merge requests have been deployed to.
groupId GroupID The global ID of the group the authored merge requests should be in. Merge requests in subgroups are included.
ignoredReviewerUsername {{< icon name=”warning-solid” >}} String Introduced in GitLab 18.0. Status: Experiment. Username of the reviewer to ignore when searching by reviewer state.
iids [String!] Array of IIDs of merge requests, for example [1, 2].
in [IssuableSearchableField!] Specify the fields to perform the search in. Defaults to [TITLE, DESCRIPTION]. Requires the search argument.’.
includeArchived Boolean Merge requests from archived projects.
labelName [String] Labels applied to the merge request.
labels {{< icon name=”warning-solid” >}} [String!] Deprecated in GitLab 17.1. Use labelName.
mergedAfter Time Merge requests merged after the date.
mergedBefore Time Merge requests merged before the date.
mergedBy String Username of the merger.
milestoneTitle String Title of the milestone. Incompatible with milestoneWildcardId.
milestoneWildcardId MilestoneWildcardId Filter issues by milestone ID wildcard. Incompatible with milestoneTitle.
myReactionEmoji String Filter by your reaction emoji.
not MergeRequestsResolverNegatedParams List of negated arguments. Warning: this argument is experimental and a subject to change in future.
or UnionedMergeRequestFilterInput List of arguments with inclusive OR.
projectId ProjectID The global ID of the project the authored merge requests should be in. Incompatible with projectPath.
projectPath String The full-path of the project the authored merge requests should be in. Incompatible with projectId.
releaseTag String Filter by release tag.
reviewState {{< icon name=”warning-solid” >}} MergeRequestReviewState Introduced in GitLab 17.0. Status: Experiment. Reviewer state of the merge request.
reviewStates {{< icon name=”warning-solid” >}} [MergeRequestReviewState!] Introduced in GitLab 17.0. Status: Experiment. Reviewer states of the merge request.
search String Search query for title or description.
sort MergeRequestSort Sort merge requests by the criteria.
sourceBranches [String!] Array of source branch names. All resolved merge requests will have one of these branches as their source.
state MergeRequestState Merge request state. If provided, all resolved merge requests will have the state.
subscribed SubscriptionStatus Merge requests the current user is subscribed to.
targetBranches [String!] Array of target branch names. All resolved merge requests will have one of these branches as their target.
updatedAfter Time Merge requests updated after the timestamp.
updatedBefore Time Merge requests updated before the timestamp.
MergeRequestAuthor.savedReply

Saved reply authored by the user.

Returns SavedReply.

Arguments
Name Type Description
id UsersSavedReplyID! ID of a saved reply.
MergeRequestAuthor.snippets

Snippets authored by the user.

Returns SnippetConnection.

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

Arguments
Name Type Description
ids [SnippetID!] Array of global snippet IDs. For example, gid://gitlab/ProjectSnippet/1.
type TypeEnum Type of snippet.
visibility VisibilityScopesEnum Visibility of the snippet.
MergeRequestAuthor.starredProjects

Projects starred by the user.

Returns ProjectConnection.

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

Arguments
Name Type Description
minAccessLevel AccessLevelEnum Return only projects where current user has at least the specified access level.
programmingLanguageName String Filter projects by programming language name (case insensitive). For example: “css” or “ruby”.
search String Search query.
sort ProjectSort List starred projects by sort order.
MergeRequestAuthor.timelogs

Time logged by the user.

Returns TimelogConnection.

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

Arguments
Name Type Description
endDate Time List timelogs within a date range where the logged date is equal to or before endDate.
endTime Time List timelogs within a time range where the logged time is equal to or before endTime.
groupId GroupID List timelogs for a group.
projectId ProjectID List timelogs for a project.
sort TimelogSort List timelogs in a particular order.
startDate Time List timelogs within a date range where the logged date is equal to or after startDate.
startTime Time List timelogs within a time range where the logged time is equal to or after startTime.
username String List timelogs for a user.
MergeRequestAuthor.todos

To-do items of the user.

Returns TodoConnection.

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

Arguments
Name Type Description
action [TodoActionEnum!] Action to be filtered.
authorId [ID!] ID of an author.
groupId [ID!] ID of a group.
isSnoozed Boolean Whether the to-do item is snoozed.
projectId [ID!] ID of a project.
sort TodoSort Sort todos by given criteria.
state [TodoStateEnum!] State of the todo.
type [TodoTargetEnum!] Type of the todo.
MergeRequestAuthor.userAchievements

Achievements for the user. Only returns for namespaces where the achievements feature flag is enabled.

{{< details >}} Introduced in GitLab 15.10. Status: Experiment. {{< /details >}}

Returns UserAchievementConnection.

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

Arguments
Name Type Description
includeHidden Boolean Indicates 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
Name Type Description
actualStates [String!] Filter workspaces by actual states.
agentIds [ClustersAgentID!] Filter workspaces by agent GlobalIDs.
ids [RemoteDevelopmentWorkspaceID!] Filter workspaces by workspace GlobalIDs. For example, ["gid://gitlab/RemoteDevelopment::Workspace/1"].
includeActualStates {{< icon name=”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

Name Type Description
createdAt Time! Timestamp of when the diff was created.
updatedAt Time! Timestamp of when the diff was updated.

MergeRequestDiffRegistry

Represents the Geo sync and verification state of a Merge Request diff.

Fields

Name Type Description
checksumMismatch Boolean Indicate if the checksums of the MergeRequestDiffRegistry do not match on the primary and secondary.
createdAt Time Timestamp when the MergeRequestDiffRegistry was created.
forceToRedownload {{< icon name=”warning-solid” >}} Boolean Deprecated in GitLab 17.10. Removed from registry tables in the database in favor of the newer reusable framework.
id ID! ID of the MergeRequestDiffRegistry.
lastSyncFailure String Error message during sync of the MergeRequestDiffRegistry.
lastSyncedAt Time Timestamp of the most recent successful sync of the MergeRequestDiffRegistry.
mergeRequestDiffId ID! ID of the Merge Request diff.
missingOnPrimary Boolean Indicate if the MergeRequestDiffRegistry is missing on primary.
modelRecordId Int ID of the MergeRequestDiffRegistry’s model record.
retryAt Time Timestamp after which the MergeRequestDiffRegistry is resynced.
retryCount Int Number of consecutive failed sync attempts of the MergeRequestDiffRegistry.
state RegistryState Sync state of the MergeRequestDiffRegistry.
verificationChecksum String The local checksum of the MergeRequestDiffRegistry.
verificationChecksumMismatched String The expected checksum of the MergeRequestDiffRegistry in case of mismatch.
verificationFailure String Error message during verification of the MergeRequestDiffRegistry.
verificationRetryAt Time Timestamp after which the MergeRequestDiffRegistry is reverified.
verificationRetryCount Int Number of consecutive failed verification attempts of the MergeRequestDiffRegistry.
verificationStartedAt Time Timestamp when the verification of MergeRequestDiffRegistry started.
verificationState VerificationStateEnum Verification state of the MergeRequestDiffRegistry.
verifiedAt Time Timestamp of the most recent successful verification of the MergeRequestDiffRegistry.

MergeRequestMergeabilityCheck

Mergeability check of the merge request.

Fields

Name Type Description
identifier MergeabilityCheckIdentifier! Identifier of the mergeability check.
status MergeabilityCheckStatus! Status of the mergeability check.

MergeRequestParticipant

A user participating in a merge request.

Fields

Name Type Description
active Boolean Indicates if the user is active.
avatarUrl String URL of the user’s avatar.
bio String Bio of the user.
bot Boolean! Indicates if the user is a bot.
callouts UserCalloutConnection User callouts that belong to the user. (see Connections)
commitEmail String User’s default commit email.
createdAt Time Timestamp of when the user was created.
discord String Discord ID of the user.
email {{< icon name=”warning-solid” >}} String Deprecated in GitLab 13.7. This was renamed. Use: User.publicEmail.
emails EmailConnection User’s email addresses. (see Connections)
gitpodEnabled Boolean Whether Gitpod is enabled at the user level.
groupCount Int Group count for the user.
groupMemberships GroupMemberConnection Group memberships of the user. (see Connections)
human Boolean Indicates if the user is a regular user.
id UserID! Global ID of the user.
ide Ide IDE settings.
jobTitle String Job title of the user.
lastActivityOn Date Date the user last performed any actions.
linkedin String LinkedIn profile name of the user.
location String Location of the user.
mergeRequestInteraction UserMergeRequestInteraction Details of the user’s interactions with the merge request.
name String! Human-readable name of the user. Returns **** if the user is a project bot and the requester does not have permission to view the project.
namespace Namespace Personal namespace of the user.
namespaceCommitEmails NamespaceCommitEmailConnection User’s custom namespace commit emails. (see Connections)
organization String Who the user represents or works for.
preferencesGitpodPath String Web path to the Gitpod section within user preferences.
profileEnableGitpodPath String Web path to enable Gitpod for the user.
projectMemberships ProjectMemberConnection Project memberships of the user. (see Connections)
pronouns String Pronouns of the user.
publicEmail String User’s public email.
savedReplies SavedReplyConnection Saved replies authored by the user. (see Connections)
state UserState! State of the user.
status UserStatus User status.
twitter String X (formerly Twitter) username of the user.
type UserType! Type of the user.
userPermissions UserPermissions! Permissions for the current user on the resource.
userPreferences UserPreferences Preferences for the user.
username String! Username of the user. Unique within the instance of GitLab.
webPath String! Web path of the user.
webUrl String! Web URL of the user.

Fields with arguments

MergeRequestParticipant.assignedMergeRequests

Merge requests assigned to the user.

Returns MergeRequestConnection.

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

Arguments
Name Type Description
approved Boolean Limit results to approved merge requests. Available only when the feature flag mr_approved_filter is enabled.
approvedBy [String!] Usernames of the approvers.
approver [String!] Usernames of possible approvers.
authorUsername String Username of the author.
blobPath {{< icon name=”warning-solid” >}} String Introduced 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.
createdAfter Time Merge requests created after the timestamp.
createdBefore Time Merge requests created before the timestamp.
deployedAfter Time Merge requests deployed after the timestamp.
deployedBefore Time Merge requests deployed before the timestamp.
deploymentId String ID of the deployment.
draft Boolean Limit result to draft merge requests.
environmentName String Environment merge requests have been deployed to.
groupId GroupID The global ID of the group the authored merge requests should be in. Merge requests in subgroups are included.
ignoredReviewerUsername {{< icon name=”warning-solid” >}} String Introduced in GitLab 18.0. Status: Experiment. Username of the reviewer to ignore when searching by reviewer state.
iids [String!] Array of IIDs of merge requests, for example [1, 2].
in [IssuableSearchableField!] Specify the fields to perform the search in. Defaults to [TITLE, DESCRIPTION]. Requires the search argument.’.
includeArchived Boolean Merge requests from archived projects.
labelName [String] Labels applied to the merge request.
labels {{< icon name=”warning-solid” >}} [String!] Deprecated in GitLab 17.1. Use labelName.
mergedAfter Time Merge requests merged after the date.
mergedBefore Time Merge requests merged before the date.
mergedBy String Username of the merger.
milestoneTitle String Title of the milestone. Incompatible with milestoneWildcardId.
milestoneWildcardId MilestoneWildcardId Filter issues by milestone ID wildcard. Incompatible with milestoneTitle.
myReactionEmoji String Filter by your reaction emoji.
not MergeRequestsResolverNegatedParams List of negated arguments. Warning: this argument is experimental and a subject to change in future.
or UnionedMergeRequestFilterInput List of arguments with inclusive OR.
projectId ProjectID The global ID of the project the authored merge requests should be in. Incompatible with projectPath.
projectPath String The full-path of the project the authored merge requests should be in. Incompatible with projectId.
releaseTag String Filter by release tag.
reviewState {{< icon name=”warning-solid” >}} MergeRequestReviewState Introduced in GitLab 17.0. Status: Experiment. Reviewer state of the merge request.
reviewStates {{< icon name=”warning-solid” >}} [MergeRequestReviewState!] Introduced in GitLab 17.0. Status: Experiment. Reviewer states of the merge request.
reviewerUsername String Username of the reviewer.
reviewerWildcardId ReviewerWildcardId Filter by reviewer presence. Incompatible with reviewerUsername.
search String Search query for title or description.
sort MergeRequestSort Sort merge requests by the criteria.
sourceBranches [String!] Array of source branch names. All resolved merge requests will have one of these branches as their source.
state MergeRequestState Merge request state. If provided, all resolved merge requests will have the state.
subscribed SubscriptionStatus Merge requests the current user is subscribed to.
targetBranches [String!] Array of target branch names. All resolved merge requests will have one of these branches as their target.
updatedAfter Time Merge requests updated after the timestamp.
updatedBefore Time Merge requests updated before the timestamp.
MergeRequestParticipant.authoredMergeRequests

Merge requests authored by the user.

Returns MergeRequestConnection.

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

Arguments
Name Type Description
approved Boolean Limit results to approved merge requests. Available only when the feature flag mr_approved_filter is enabled.
approvedBy [String!] Usernames of the approvers.
approver [String!] Usernames of possible approvers.
assigneeUsername String Username of the assignee.
assigneeUsernames [String!] Usernames of users assigned to the merge request.
assigneeWildcardId AssigneeWildcardId Filter by assignee presence. Incompatible with assigneeUsernames and assigneeUsername.
blobPath {{< icon name=”warning-solid” >}} String Introduced 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.
createdAfter Time Merge requests created after the timestamp.
createdBefore Time Merge requests created before the timestamp.
deployedAfter Time Merge requests deployed after the timestamp.
deployedBefore Time Merge requests deployed before the timestamp.
deploymentId String ID of the deployment.
draft Boolean Limit result to draft merge requests.
environmentName String Environment merge requests have been deployed to.
groupId GroupID The global ID of the group the authored merge requests should be in. Merge requests in subgroups are included.
ignoredReviewerUsername {{< icon name=”warning-solid” >}} String Introduced in GitLab 18.0. Status: Experiment. Username of the reviewer to ignore when searching by reviewer state.
iids [String!] Array of IIDs of merge requests, for example [1, 2].
in [IssuableSearchableField!] Specify the fields to perform the search in. Defaults to [TITLE, DESCRIPTION]. Requires the search argument.’.
includeArchived Boolean Merge requests from archived projects.
includeAssigned Boolean Include merge requests the user is assigned to.
labelName [String] Labels applied to the merge request.
labels {{< icon name=”warning-solid” >}} [String!] Deprecated in GitLab 17.1. Use labelName.
mergedAfter Time Merge requests merged after the date.
mergedBefore Time Merge requests merged before the date.
mergedBy String Username of the merger.
milestoneTitle String Title of the milestone. Incompatible with milestoneWildcardId.
milestoneWildcardId MilestoneWildcardId Filter issues by milestone ID wildcard. Incompatible with milestoneTitle.
myReactionEmoji String Filter by your reaction emoji.
not MergeRequestsResolverNegatedParams List of negated arguments. Warning: this argument is experimental and a subject to change in future.
or UnionedMergeRequestFilterInput List of arguments with inclusive OR.
projectId ProjectID The global ID of the project the authored merge requests should be in. Incompatible with projectPath.
projectPath String The full-path of the project the authored merge requests should be in. Incompatible with projectId.
releaseTag String Filter by release tag.
reviewState {{< icon name=”warning-solid” >}} MergeRequestReviewState Introduced in GitLab 17.0. Status: Experiment. Reviewer state of the merge request.
reviewStates {{< icon name=”warning-solid” >}} [MergeRequestReviewState!] Introduced in GitLab 17.0. Status: Experiment. Reviewer states of the merge request.
reviewerUsername String Username of the reviewer.
reviewerWildcardId ReviewerWildcardId Filter by reviewer presence. Incompatible with reviewerUsername.
search String Search query for title or description.
sort MergeRequestSort Sort merge requests by the criteria.
sourceBranches [String!] Array of source branch names. All resolved merge requests will have one of these branches as their source.
state MergeRequestState Merge request state. If provided, all resolved merge requests will have the state.
subscribed SubscriptionStatus Merge requests the current user is subscribed to.
targetBranches [String!] Array of target branch names. All resolved merge requests will have one of these branches as their target.
updatedAfter Time Merge requests updated after the timestamp.
updatedBefore Time Merge requests updated before the timestamp.
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
Name Type Description
includePersonal Boolean Include personal projects.
minAccessLevel AccessLevelEnum Return only projects where current user has at least the specified access level.
programmingLanguageName String Filter projects by programming language name (case insensitive). For example: “css” or “ruby”.
search String Search query.
sort ProjectSort Sort contributed projects.
MergeRequestParticipant.groups

Groups where the user has access.

Returns GroupConnection.

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

Arguments
Name Type Description
permissionScope GroupPermission Filter by permissions the user has on groups.
search String Search by group name or path.
sort GroupSort Sort groups by given criteria.
MergeRequestParticipant.organizations

Organizations where the user has access.

{{< details >}} Introduced in GitLab 16.6. Status: Experiment. {{< /details >}}

Returns OrganizationConnection.

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

Arguments
Name Type Description
search String Search query, which can be for the organization name or a path.
soloOwned Boolean When 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
Name Type Description
approved Boolean Limit 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.
assigneeUsername String Username of the assignee.
assigneeUsernames [String!] Usernames of users assigned to the merge request.
assigneeWildcardId AssigneeWildcardId Filter by assignee presence. Incompatible with assigneeUsernames and assigneeUsername.
authorUsername String Username of the author.
blobPath {{< icon name=”warning-solid” >}} String Introduced 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.
createdAfter Time Merge requests created after the timestamp.
createdBefore Time Merge requests created before the timestamp.
deployedAfter Time Merge requests deployed after the timestamp.
deployedBefore Time Merge requests deployed before the timestamp.
deploymentId String ID of the deployment.
draft Boolean Limit result to draft merge requests.
environmentName String Environment merge requests have been deployed to.
groupId GroupID The global ID of the group the authored merge requests should be in. Merge requests in subgroups are included.
ignoredReviewerUsername {{< icon name=”warning-solid” >}} String Introduced in GitLab 18.0. Status: Experiment. Username of the reviewer to ignore when searching by reviewer state.
iids [String!] Array of IIDs of merge requests, for example [1, 2].
in [IssuableSearchableField!] Specify the fields to perform the search in. Defaults to [TITLE, DESCRIPTION]. Requires the search argument.’.
includeArchived Boolean Merge requests from archived projects.
labelName [String] Labels applied to the merge request.
labels {{< icon name=”warning-solid” >}} [String!] Deprecated in GitLab 17.1. Use labelName.
mergedAfter Time Merge requests merged after the date.
mergedBefore Time Merge requests merged before the date.
mergedBy String Username of the merger.
milestoneTitle String Title of the milestone. Incompatible with milestoneWildcardId.
milestoneWildcardId MilestoneWildcardId Filter issues by milestone ID wildcard. Incompatible with milestoneTitle.
myReactionEmoji String Filter by your reaction emoji.
not MergeRequestsResolverNegatedParams List of negated arguments. Warning: this argument is experimental and a subject to change in future.
or UnionedMergeRequestFilterInput List of arguments with inclusive OR.
projectId ProjectID The global ID of the project the authored merge requests should be in. Incompatible with projectPath.
projectPath String The full-path of the project the authored merge requests should be in. Incompatible with projectId.
releaseTag String Filter by release tag.
reviewState {{< icon name=”warning-solid” >}} MergeRequestReviewState Introduced in GitLab 17.0. Status: Experiment. Reviewer state of the merge request.
reviewStates {{< icon name=”warning-solid” >}} [MergeRequestReviewState!] Introduced in GitLab 17.0. Status: Experiment. Reviewer states of the merge request.
search String Search query for title or description.
sort MergeRequestSort Sort merge requests by the criteria.
sourceBranches [String!] Array of source branch names. All resolved merge requests will have one of these branches as their source.
state MergeRequestState Merge request state. If provided, all resolved merge requests will have the state.
subscribed SubscriptionStatus Merge requests the current user is subscribed to.
targetBranches [String!] Array of target branch names. All resolved merge requests will have one of these branches as their target.
updatedAfter Time Merge requests updated after the timestamp.
updatedBefore Time Merge requests updated before the timestamp.
MergeRequestParticipant.savedReply

Saved reply authored by the user.

Returns SavedReply.

Arguments
Name Type Description
id UsersSavedReplyID! ID of a saved reply.
MergeRequestParticipant.snippets

Snippets authored by the user.

Returns SnippetConnection.

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

Arguments
Name Type Description
ids [SnippetID!] Array of global snippet IDs. For example, gid://gitlab/ProjectSnippet/1.
type TypeEnum Type of snippet.
visibility VisibilityScopesEnum Visibility of the snippet.
MergeRequestParticipant.starredProjects

Projects starred by the user.

Returns ProjectConnection.

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

Arguments
Name Type Description
minAccessLevel AccessLevelEnum Return only projects where current user has at least the specified access level.
programmingLanguageName String Filter projects by programming language name (case insensitive). For example: “css” or “ruby”.
search String Search query.
sort ProjectSort List starred projects by sort order.
MergeRequestParticipant.timelogs

Time logged by the user.

Returns TimelogConnection.

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

Arguments
Name Type Description
endDate Time List timelogs within a date range where the logged date is equal to or before endDate.
endTime Time List timelogs within a time range where the logged time is equal to or before endTime.
groupId GroupID List timelogs for a group.
projectId ProjectID List timelogs for a project.
sort TimelogSort List timelogs in a particular order.
startDate Time List timelogs within a date range where the logged date is equal to or after startDate.
startTime Time List timelogs within a time range where the logged time is equal to or after startTime.
username String List timelogs for a user.
MergeRequestParticipant.todos

To-do items of the user.

Returns TodoConnection.

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

Arguments
Name Type Description
action [TodoActionEnum!] Action to be filtered.
authorId [ID!] ID of an author.
groupId [ID!] ID of a group.
isSnoozed Boolean Whether the to-do item is snoozed.
projectId [ID!] ID of a project.
sort TodoSort Sort todos by given criteria.
state [TodoStateEnum!] State of the todo.
type [TodoTargetEnum!] Type of the todo.
MergeRequestParticipant.userAchievements

Achievements for the user. Only returns for namespaces where the achievements feature flag is enabled.

{{< details >}} Introduced in GitLab 15.10. Status: Experiment. {{< /details >}}

Returns UserAchievementConnection.

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

Arguments
Name Type Description
includeHidden Boolean Indicates 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
Name Type Description
actualStates [String!] Filter workspaces by actual states.
agentIds [ClustersAgentID!] Filter workspaces by agent GlobalIDs.
ids [RemoteDevelopmentWorkspaceID!] Filter workspaces by workspace GlobalIDs. For example, ["gid://gitlab/RemoteDevelopment::Workspace/1"].
includeActualStates {{< icon name=”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

Name Type Description
adminMergeRequest Boolean! If true, the user can perform admin_merge_request on this resource.
canApprove Boolean! If true, the user can perform can_approve on this resource.
canMerge Boolean! If true, the user can perform can_merge on this resource.
cherryPickOnCurrentMergeRequest Boolean! If true, the user can perform cherry_pick_on_current_merge_request on this resource.
createNote Boolean! If true, the user can perform create_note on this resource.
pushToSourceBranch Boolean! If true, the user can perform push_to_source_branch on this resource.
readMergeRequest Boolean! If true, the user can perform read_merge_request on this resource.
removeSourceBranch Boolean! If true, the user can perform remove_source_branch on this resource.
revertOnCurrentMergeRequest Boolean! If true, the user can perform revert_on_current_merge_request on this resource.
updateMergeRequest Boolean! If true, the user can perform update_merge_request on this resource.

MergeRequestReviewer

A user assigned to a merge request as a reviewer.

Fields

Name Type Description
active Boolean Indicates if the user is active.
avatarUrl String URL of the user’s avatar.
bio String Bio of the user.
bot Boolean! Indicates if the user is a bot.
callouts UserCalloutConnection User callouts that belong to the user. (see Connections)
commitEmail String User’s default commit email.
createdAt Time Timestamp of when the user was created.
discord String Discord ID of the user.
email {{< icon name=”warning-solid” >}} String Deprecated in GitLab 13.7. This was renamed. Use: User.publicEmail.
emails EmailConnection User’s email addresses. (see Connections)
gitpodEnabled Boolean Whether Gitpod is enabled at the user level.
groupCount Int Group count for the user.
groupMemberships GroupMemberConnection Group memberships of the user. (see Connections)
human Boolean Indicates if the user is a regular user.
id UserID! Global ID of the user.
ide Ide IDE settings.
jobTitle String Job title of the user.
lastActivityOn Date Date the user last performed any actions.
linkedin String LinkedIn profile name of the user.
location String Location of the user.
mergeRequestInteraction UserMergeRequestInteraction Details of the user’s interactions with the merge request.
name String! Human-readable name of the user. Returns **** if the user is a project bot and the requester does not have permission to view the project.
namespace Namespace Personal namespace of the user.
namespaceCommitEmails NamespaceCommitEmailConnection User’s custom namespace commit emails. (see Connections)
organization String Who the user represents or works for.
preferencesGitpodPath String Web path to the Gitpod section within user preferences.
profileEnableGitpodPath String Web path to enable Gitpod for the user.
projectMemberships ProjectMemberConnection Project memberships of the user. (see Connections)
pronouns String Pronouns of the user.
publicEmail String User’s public email.
savedReplies SavedReplyConnection Saved replies authored by the user. (see Connections)
state UserState! State of the user.
status UserStatus User status.
twitter String X (formerly Twitter) username of the user.
type UserType! Type of the user.
userPermissions UserPermissions! Permissions for the current user on the resource.
userPreferences UserPreferences Preferences for the user.
username String! Username of the user. Unique within the instance of GitLab.
webPath String! Web path of the user.
webUrl String! Web URL of the user.

Fields with arguments

MergeRequestReviewer.assignedMergeRequests

Merge requests assigned to the user.

Returns MergeRequestConnection.

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

Arguments
Name Type Description
approved Boolean Limit results to approved merge requests. Available only when the feature flag mr_approved_filter is enabled.
approvedBy [String!] Usernames of the approvers.
approver [String!] Usernames of possible approvers.
authorUsername String Username of the author.
blobPath {{< icon name=”warning-solid” >}} String Introduced 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.
createdAfter Time Merge requests created after the timestamp.
createdBefore Time Merge requests created before the timestamp.
deployedAfter Time Merge requests deployed after the timestamp.
deployedBefore Time Merge requests deployed before the timestamp.
deploymentId String ID of the deployment.
draft Boolean Limit result to draft merge requests.
environmentName String Environment merge requests have been deployed to.
groupId GroupID The global ID of the group the authored merge requests should be in. Merge requests in subgroups are included.
ignoredReviewerUsername {{< icon name=”warning-solid” >}} String Introduced in GitLab 18.0. Status: Experiment. Username of the reviewer to ignore when searching by reviewer state.
iids [String!] Array of IIDs of merge requests, for example [1, 2].
in [IssuableSearchableField!] Specify the fields to perform the search in. Defaults to [TITLE, DESCRIPTION]. Requires the search argument.’.
includeArchived Boolean Merge requests from archived projects.
labelName [String] Labels applied to the merge request.
labels {{< icon name=”warning-solid” >}} [String!] Deprecated in GitLab 17.1. Use labelName.
mergedAfter Time Merge requests merged after the date.
mergedBefore Time Merge requests merged before the date.
mergedBy String Username of the merger.
milestoneTitle String Title of the milestone. Incompatible with milestoneWildcardId.
milestoneWildcardId MilestoneWildcardId Filter issues by milestone ID wildcard. Incompatible with milestoneTitle.
myReactionEmoji String Filter by your reaction emoji.
not MergeRequestsResolverNegatedParams List of negated arguments. Warning: this argument is experimental and a subject to change in future.
or UnionedMergeRequestFilterInput List of arguments with inclusive OR.
projectId ProjectID The global ID of the project the authored merge requests should be in. Incompatible with projectPath.
projectPath String The full-path of the project the authored merge requests should be in. Incompatible with projectId.
releaseTag String Filter by release tag.
reviewState {{< icon name=”warning-solid” >}} MergeRequestReviewState Introduced in GitLab 17.0. Status: Experiment. Reviewer state of the merge request.
reviewStates {{< icon name=”warning-solid” >}} [MergeRequestReviewState!] Introduced in GitLab 17.0. Status: Experiment. Reviewer states of the merge request.
reviewerUsername String Username of the reviewer.
reviewerWildcardId ReviewerWildcardId Filter by reviewer presence. Incompatible with reviewerUsername.
search String Search query for title or description.
sort MergeRequestSort Sort merge requests by the criteria.
sourceBranches [String!] Array of source branch names. All resolved merge requests will have one of these branches as their source.
state MergeRequestState Merge request state. If provided, all resolved merge requests will have the state.
subscribed SubscriptionStatus Merge requests the current user is subscribed to.
targetBranches [String!] Array of target branch names. All resolved merge requests will have one of these branches as their target.
updatedAfter Time Merge requests updated after the timestamp.
updatedBefore Time Merge requests updated before the timestamp.
MergeRequestReviewer.authoredMergeRequests

Merge requests authored by the user.

Returns MergeRequestConnection.

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

Arguments
Name Type Description
approved Boolean Limit results to approved merge requests. Available only when the feature flag mr_approved_filter is enabled.
approvedBy [String!] Usernames of the approvers.
approver [String!] Usernames of possible approvers.
assigneeUsername String Username of the assignee.
assigneeUsernames [String!] Usernames of users assigned to the merge request.
assigneeWildcardId AssigneeWildcardId Filter by assignee presence. Incompatible with assigneeUsernames and assigneeUsername.
blobPath {{< icon name=”warning-solid” >}} String Introduced 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.
createdAfter Time Merge requests created after the timestamp.
createdBefore Time Merge requests created before the timestamp.
deployedAfter Time Merge requests deployed after the timestamp.
deployedBefore Time Merge requests deployed before the timestamp.
deploymentId String ID of the deployment.
draft Boolean Limit result to draft merge requests.
environmentName String Environment merge requests have been deployed to.
groupId GroupID The global ID of the group the authored merge requests should be in. Merge requests in subgroups are included.
ignoredReviewerUsername {{< icon name=”warning-solid” >}} String Introduced in GitLab 18.0. Status: Experiment. Username of the reviewer to ignore when searching by reviewer state.
iids [String!] Array of IIDs of merge requests, for example [1, 2].
in [IssuableSearchableField!] Specify the fields to perform the search in. Defaults to [TITLE, DESCRIPTION]. Requires the search argument.’.
includeArchived Boolean Merge requests from archived projects.
includeAssigned Boolean Include merge requests the user is assigned to.
labelName [String] Labels applied to the merge request.
labels {{< icon name=”warning-solid” >}} [String!] Deprecated in GitLab 17.1. Use labelName.
mergedAfter Time Merge requests merged after the date.
mergedBefore Time Merge requests merged before the date.
mergedBy String Username of the merger.
milestoneTitle String Title of the milestone. Incompatible with milestoneWildcardId.
milestoneWildcardId MilestoneWildcardId Filter issues by milestone ID wildcard. Incompatible with milestoneTitle.
myReactionEmoji String Filter by your reaction emoji.
not MergeRequestsResolverNegatedParams List of negated arguments. Warning: this argument is experimental and a subject to change in future.
or UnionedMergeRequestFilterInput List of arguments with inclusive OR.
projectId ProjectID The global ID of the project the authored merge requests should be in. Incompatible with projectPath.
projectPath String The full-path of the project the authored merge requests should be in. Incompatible with projectId.
releaseTag String Filter by release tag.
reviewState {{< icon name=”warning-solid” >}} MergeRequestReviewState Introduced in GitLab 17.0. Status: Experiment. Reviewer state of the merge request.
reviewStates {{< icon name=”warning-solid” >}} [MergeRequestReviewState!] Introduced in GitLab 17.0. Status: Experiment. Reviewer states of the merge request.
reviewerUsername String Username of the reviewer.
reviewerWildcardId ReviewerWildcardId Filter by reviewer presence. Incompatible with reviewerUsername.
search String Search query for title or description.
sort MergeRequestSort Sort merge requests by the criteria.
sourceBranches [String!] Array of source branch names. All resolved merge requests will have one of these branches as their source.
state MergeRequestState Merge request state. If provided, all resolved merge requests will have the state.
subscribed SubscriptionStatus Merge requests the current user is subscribed to.
targetBranches [String!] Array of target branch names. All resolved merge requests will have one of these branches as their target.
updatedAfter Time Merge requests updated after the timestamp.
updatedBefore Time Merge requests updated before the timestamp.
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
Name Type Description
includePersonal Boolean Include personal projects.
minAccessLevel AccessLevelEnum Return only projects where current user has at least the specified access level.
programmingLanguageName String Filter projects by programming language name (case insensitive). For example: “css” or “ruby”.
search String Search query.
sort ProjectSort Sort contributed projects.
MergeRequestReviewer.groups

Groups where the user has access.

Returns GroupConnection.

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

Arguments
Name Type Description
permissionScope GroupPermission Filter by permissions the user has on groups.
search String Search by group name or path.
sort GroupSort Sort groups by given criteria.
MergeRequestReviewer.organizations

Organizations where the user has access.

{{< details >}} Introduced in GitLab 16.6. Status: Experiment. {{< /details >}}

Returns OrganizationConnection.

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

Arguments
Name Type Description
search String Search query, which can be for the organization name or a path.
soloOwned Boolean When 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
Name Type Description
approved Boolean Limit 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.
assigneeUsername String Username of the assignee.
assigneeUsernames [String!] Usernames of users assigned to the merge request.
assigneeWildcardId AssigneeWildcardId Filter by assignee presence. Incompatible with assigneeUsernames and assigneeUsername.
authorUsername String Username of the author.
blobPath {{< icon name=”warning-solid” >}} String Introduced 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.
createdAfter Time Merge requests created after the timestamp.
createdBefore Time Merge requests created before the timestamp.
deployedAfter Time Merge requests deployed after the timestamp.
deployedBefore Time Merge requests deployed before the timestamp.
deploymentId String ID of the deployment.
draft Boolean Limit result to draft merge requests.
environmentName String Environment merge requests have been deployed to.
groupId GroupID The global ID of the group the authored merge requests should be in. Merge requests in subgroups are included.
ignoredReviewerUsername {{< icon name=”warning-solid” >}} String Introduced in GitLab 18.0. Status: Experiment. Username of the reviewer to ignore when searching by reviewer state.
iids [String!] Array of IIDs of merge requests, for example [1, 2].
in [IssuableSearchableField!] Specify the fields to perform the search in. Defaults to [TITLE, DESCRIPTION]. Requires the search argument.’.
includeArchived Boolean Merge requests from archived projects.
labelName [String] Labels applied to the merge request.
labels {{< icon name=”warning-solid” >}} [String!] Deprecated in GitLab 17.1. Use labelName.
mergedAfter Time Merge requests merged after the date.
mergedBefore Time Merge requests merged before the date.
mergedBy String Username of the merger.
milestoneTitle String Title of the milestone. Incompatible with milestoneWildcardId.
milestoneWildcardId MilestoneWildcardId Filter issues by milestone ID wildcard. Incompatible with milestoneTitle.
myReactionEmoji String Filter by your reaction emoji.
not MergeRequestsResolverNegatedParams List of negated arguments. Warning: this argument is experimental and a subject to change in future.
or UnionedMergeRequestFilterInput List of arguments with inclusive OR.
projectId ProjectID The global ID of the project the authored merge requests should be in. Incompatible with projectPath.
projectPath String The full-path of the project the authored merge requests should be in. Incompatible with projectId.
releaseTag String Filter by release tag.
reviewState {{< icon name=”warning-solid” >}} MergeRequestReviewState Introduced in GitLab 17.0. Status: Experiment. Reviewer state of the merge request.
reviewStates {{< icon name=”warning-solid” >}} [MergeRequestReviewState!] Introduced in GitLab 17.0. Status: Experiment. Reviewer states of the merge request.
search String Search query for title or description.
sort MergeRequestSort Sort merge requests by the criteria.
sourceBranches [String!] Array of source branch names. All resolved merge requests will have one of these branches as their source.
state MergeRequestState Merge request state. If provided, all resolved merge requests will have the state.
subscribed SubscriptionStatus Merge requests the current user is subscribed to.
targetBranches [String!] Array of target branch names. All resolved merge requests will have one of these branches as their target.
updatedAfter Time Merge requests updated after the timestamp.
updatedBefore Time Merge requests updated before the timestamp.
MergeRequestReviewer.savedReply

Saved reply authored by the user.

Returns SavedReply.

Arguments
Name Type Description
id UsersSavedReplyID! ID of a saved reply.
MergeRequestReviewer.snippets

Snippets authored by the user.

Returns SnippetConnection.

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

Arguments
Name Type Description
ids [SnippetID!] Array of global snippet IDs. For example, gid://gitlab/ProjectSnippet/1.
type TypeEnum Type of snippet.
visibility VisibilityScopesEnum Visibility of the snippet.
MergeRequestReviewer.starredProjects

Projects starred by the user.

Returns ProjectConnection.

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

Arguments
Name Type Description
minAccessLevel AccessLevelEnum Return only projects where current user has at least the specified access level.
programmingLanguageName String Filter projects by programming language name (case insensitive). For example: “css” or “ruby”.
search String Search query.
sort ProjectSort List starred projects by sort order.
MergeRequestReviewer.timelogs

Time logged by the user.

Returns TimelogConnection.

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

Arguments
Name Type Description
endDate Time List timelogs within a date range where the logged date is equal to or before endDate.
endTime Time List timelogs within a time range where the logged time is equal to or before endTime.
groupId GroupID List timelogs for a group.
projectId ProjectID List timelogs for a project.
sort TimelogSort List timelogs in a particular order.
startDate Time List timelogs within a date range where the logged date is equal to or after startDate.
startTime Time List timelogs within a time range where the logged time is equal to or after startTime.
username String List timelogs for a user.
MergeRequestReviewer.todos

To-do items of the user.

Returns TodoConnection.

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

Arguments
Name Type Description
action [TodoActionEnum!] Action to be filtered.
authorId [ID!] ID of an author.
groupId [ID!] ID of a group.
isSnoozed Boolean Whether the to-do item is snoozed.
projectId [ID!] ID of a project.
sort TodoSort Sort todos by given criteria.
state [TodoStateEnum!] State of the todo.
type [TodoTargetEnum!] Type of the todo.
MergeRequestReviewer.userAchievements

Achievements for the user. Only returns for namespaces where the achievements feature flag is enabled.

{{< details >}} Introduced in GitLab 15.10. Status: Experiment. {{< /details >}}

Returns UserAchievementConnection.

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

Arguments
Name Type Description
includeHidden Boolean Indicates 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
Name Type Description
actualStates [String!] Filter workspaces by actual states.
agentIds [ClustersAgentID!] Filter workspaces by agent GlobalIDs.
ids [RemoteDevelopmentWorkspaceID!] Filter workspaces by workspace GlobalIDs. For example, ["gid://gitlab/RemoteDevelopment::Workspace/1"].
includeActualStates {{< icon name=”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

Name Type Description
targetBranch String! Target branch of the car’s merge request.

Fields with arguments

MergeTrain.cars

Cars queued in the train.

{{< details >}} Introduced in GitLab 17.1. Status: Experiment. {{< /details >}}

Returns MergeTrainCarConnection!.

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

Arguments
Name Type Description
activityStatus MergeTrainStatus! 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

Name Type Description
createdAt Time! Timestamp of when the car was created.
duration Int Duration of the car.
id MergeTrainsCarID! Global ID of the car.
index Int Zero-based position of the car in the merge train. Returns null if the car is not active in a merge train.
mergeRequest MergeRequest! Merge request the car contains.
mergedAt Time Timestamp of when the car was merged.
pipeline Pipeline Pipeline of the car.
status CarStatus! Status of the car.
targetBranch String! Target branch of the car’s merge request.
targetProject Project! Project the car’s MR targets.
updatedAt Time! Timestamp of when the car was last updated.
user UserCore! Creator of the car (user who added the merge request to the train).
userPermissions CarPermissions! Permissions for the current user on the resource.

Metadata

Fields

Name Type Description
enterprise Boolean! Enterprise edition.
kas Kas! Metadata about KAS.
revision String! Revision.
version String! Version.

Fields with arguments

Metadata.featureFlags

Feature flags for the GitLab instance.

{{< details >}} Introduced in GitLab 17.4. Status: Experiment. {{< /details >}}

Returns [GitlabInstanceFeatureFlag!]!.

Arguments
Name Type Description
names [String!]! Names of the feature flags to lookup (maximum of 20).

MetricImage

Represents a metric image upload.

Fields

Name Type Description
fileName String File name of the metric image.
filePath String File path of the metric image.
id ID! ID of the metric upload.
iid String! Internal ID of the metric upload.
url String! URL of the metric source.

MetricsDashboardAnnotation

Fields

Name Type Description
description String Description of the annotation.
endingAt Time Timestamp marking end of annotated time span.
id ID! ID of the annotation.
panelId String ID of a dashboard panel to which the annotation should be scoped.
startingAt Time Timestamp marking start of annotated time span.

Milestone

Represents a milestone.

Fields

Name Type Description
createdAt Time! Timestamp of milestone creation.
description String Description of the milestone.
dueDate Time Timestamp of the milestone due date.
expired Boolean! Expired state of the milestone (a milestone is expired when the due date is past the current date). Defaults to false when due date has not been set.
group Group Group of the milestone.
groupMilestone Boolean! Indicates if milestone is at group level.
id ID! ID of the milestone.
iid ID! Internal ID of the milestone.
project Project Project of the milestone.
projectMilestone Boolean! Indicates if milestone is at project level.
releases ReleaseConnection Releases associated with the milestone. (see Connections)
startDate Time Timestamp of the milestone start date.
state MilestoneStateEnum! State of the milestone.
stats MilestoneStats Milestone statistics.
subgroupMilestone Boolean! Indicates if milestone is at subgroup level.
title String! Title of the milestone.
upcoming Boolean! Upcoming state of the milestone (a milestone is upcoming when the start date is in the future). Defaults to false when start date has not been set.
updatedAt Time! Timestamp of last milestone update.
webPath String! Web path of the milestone.

Fields with arguments

Milestone.report

Historically accurate report about the timebox.

Returns TimeboxReport.

Arguments
Name Type Description
fullPath String Full path of the project or group used as a scope for report. For example, gitlab-org or gitlab-org/gitlab.

MilestoneStats

Contains statistics about a milestone.

Fields

Name Type Description
closedIssuesCount Int Number of closed issues associated with the milestone.
totalIssuesCount Int Total number of issues associated with the milestone.

MlCandidate

Candidate for a model version in the model registry.

Fields

Name Type Description
_links MLCandidateLinks! Map of links to perform actions on the candidate.
ciJob CiJob CI information about the job that created the candidate.
createdAt Time! Date of creation.
creator UserCore User that created the candidate.
eid String! MLflow uuid for the candidate.
id MlCandidateID! ID of the candidate.
iid Int! IID of the candidate scoped to project.
metadata MlCandidateMetadataConnection! Metadata entries for the candidate. (see Connections)
metrics MlCandidateMetricConnection! Metrics for the candidate. (see Connections)
name String Name of the candidate.
params MlCandidateParamConnection! Parameters for the candidate. (see Connections)
status String Candidate status.

MlCandidateMetadata

Metadata for a candidate in the model registry.

Fields

Name Type Description
id MlCandidateMetadataID! ID of the metadata.
name String Name of the metadata entry.
value String! Value set for the metadata entry.

MlCandidateMetric

Metric for a candidate in the model registry.

Fields

Name Type Description
id MlCandidateMetricID! ID of the metric.
name String Name of the metric.
step Int! Step at which the metric was measured.
value Float! Value set for the metric.

MlCandidateParam

Parameter for a candidate in the model registry.

Fields

Name Type Description
id MlCandidateParamID! ID of the parameter.
name String Name of the parameter.
value String! Value set for the parameter.

MlExperiment

Machine learning experiment in model experiments.

Fields

Name Type Description
candidateCount Int! Number of candidates in the experiment.
candidates MlCandidateConnection Candidates of the experiment. (see Connections)
createdAt Time! Timestamp of when the experiment was created.
creator UserCore User who created the experiment.
id MlExperimentID! ID of the experiment.
modelId MlModelID ID of the model.
name String! Name of the experiment.
path String! Web URL of the experiment.
updatedAt Time! Timestamp of when the experiment was updated.

MlModel

Machine learning model in the model registry.

Fields

Name Type Description
_links MLModelLinks! Map of links to perform actions on the model.
author UserCore User that created the model.
candidateCount Int Count of candidates in the model.
candidates MlCandidateConnection Version candidates of the model. (see Connections)
createdAt Time! Date of creation.
defaultExperimentPath String Path to default experiment page for the model.
description String Description of the model.
descriptionHtml String GitLab Flavored Markdown rendering of description.
id MlModelID! ID of the model.
latestVersion MlModelVersion Latest version of the model.
name String! Name of the model.
versionCount Int Count of versions in the model.

Fields with arguments

MlModel.version

Version of the model.

Returns MlModelVersion.

Arguments
Name Type Description
modelVersionId MlModelVersionID Id 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
Name Type Description
orderBy MlModelVersionsOrderBy Ordering column. Default is created_at.
sort SortDirectionEnum Ordering column. Default is desc.
version String Search for versions where the name includes the string.

MlModelVersion

Version of a machine learning model.

Fields

Name Type Description
_links MLModelVersionLinks! Map of links to perform actions on the model version.
artifactsCount Int Number of files in the package.
author UserCore User that created the model version.
candidate MlCandidate! Metrics, params and metadata for the model version.
createdAt Time! Date of creation.
description String Description of the version.
descriptionHtml String GitLab Flavored Markdown rendering of description.
id MlModelVersionID! ID of the model version.
packageId PackagesPackageID! Package for model version artifacts.
version String! Name of the version.

MonthlyUsage

Product analytics events for a specific month and year.

Fields

Name Type Description
count Int Count of product analytics events.
month Int! Month of the data.
year Int! Year of the data.

Namespace

Fields

Name Type Description
achievementsPath {{< icon name=”warning-solid” >}} String Introduced 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.
actualRepositorySizeLimit Float Size limit for repositories in the namespace in bytes. This limit only applies to namespaces under Project limit enforcement.
actualSizeLimit Float The actual storage size limit (in bytes) based on the enforcement type of either repository or namespace. This limit is agnostic of enforcement type.
additionalPurchasedStorageSize Float Additional storage purchased for the root namespace in bytes.
avatarUrl String URL to avatar image file of the namespace.
ciCdSettings {{< icon name=”warning-solid” >}} CiCdSettings Introduced in GitLab 17.9. Status: Experiment. Namespace CI/CD settings for the namespace.
containsLockedProjects Boolean Includes at least one project where the repository size exceeds the limit. This only applies to namespaces under Project limit enforcement.
crossProjectPipelineAvailable Boolean! Indicates if the cross_project_pipeline feature is available for the namespace.
description String Description of the namespace.
descriptionHtml String GitLab Flavored Markdown rendering of description.
fullName String! Full name of the namespace.
fullPath ID! Full path of the namespace.
id ID! ID of the namespace.
lfsEnabled Boolean Indicates if Large File Storage (LFS) is enabled for namespace.
name String! Name of the namespace.
packageSettings PackageSettings Package settings for the namespace.
path String! Path of the namespace.
productAnalyticsStoredEventsLimit {{< icon name=”warning-solid” >}} Int Introduced in GitLab 16.9. Status: Experiment. Number of product analytics events namespace is permitted to store per cycle.
repositorySizeExcessProjectCount Int Number of projects in the root namespace where the repository size exceeds the limit. This only applies to namespaces under Project limit enforcement.
requestAccessEnabled Boolean Indicates if users can request access to namespace.
rootStorageStatistics RootStorageStatistics Aggregated storage statistics of the namespace. Only available for root namespaces.
securityPolicyProject Project Security policy project assigned to the namespace.
sharedRunnersSetting SharedRunnersSetting Shared runners availability for the namespace and its descendants.
sidebar {{< icon name=”warning-solid” >}} NamespaceSidebar Introduced in GitLab 17.6. Status: Experiment. Data needed to render the sidebar for the namespace.
storageSizeLimit Float The storage limit (in bytes) included with the root namespace plan. This limit only applies to namespaces under namespace limit enforcement.
subscriptionHistory {{< icon name=”warning-solid” >}} GitlabSubscriptionHistoryConnection Introduced in GitLab 17.3. Status: Experiment. Find subscription history records.
timelogCategories {{< icon name=”warning-solid” >}} TimeTrackingTimelogCategoryConnection Introduced in GitLab 15.3. Status: Experiment. Timelog categories for the namespace.
totalRepositorySize Float Total repository size of all projects in the root namespace in bytes.
totalRepositorySizeExcess Float Total excess repository size of all projects in the root namespace in bytes. This only applies to namespaces under Project limit enforcement.
userPermissions NamespacePermissions! Permissions for the current user on the resource.
visibility String Visibility of the namespace.
webUrl String URL of the object.

Fields with arguments

Namespace.achievements

Achievements for the namespace. Returns null if the achievements feature flag is disabled.

{{< details >}} Introduced in GitLab 15.8. Status: Experiment. {{< /details >}}

Returns AchievementConnection.

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

Arguments
Name Type Description
ids [AchievementsAchievementID!] Filter achievements by IDs.
Namespace.addOnEligibleUsers

Users in the namespace hierarchy that add ons are applicable for. This only applies to root namespaces.

{{< details >}} Introduced in GitLab 16.5. Status: Experiment. {{< /details >}}

Returns AddOnUserConnection.

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

Arguments
Name Type Description
addOnPurchaseIds [GitlabSubscriptionsAddOnPurchaseID!]! Global IDs of the add on purchases to find assignments for.
addOnType GitlabSubscriptionsAddOnType! Type of add on to filter the eligible users by.
filterByAssignedSeat String Filter users list by assigned seat.
search String Search the user list.
sort GitlabSubscriptionsUserSort Sort the user list.
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
Name Type Description
includeUnscoped Boolean Filter policies that are scoped to the project.
relationship SecurityPolicyRelationType Filter policies by the given policy relationship. Default is DIRECT.
Namespace.complianceFrameworks

Compliance frameworks available to projects in this namespace.

Returns ComplianceFrameworkConnection.

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

Arguments
Name Type Description
id ComplianceManagementFrameworkID Global ID of a specific compliance framework to return.
ids [ComplianceManagementFrameworkID!] List of Global IDs of compliance frameworks to return.
search String Search framework with most similar names.
Namespace.customFields

Custom fields configured for the namespace.

{{< details >}} Introduced in GitLab 17.10. Status: Experiment. {{< /details >}}

Returns CustomFieldConnection.

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

Arguments
Name Type Description
active Boolean Filter for active fields. If false, excludes active fields. If true, returns only active fields.
fieldType CustomFieldType Filter for selected field type.
search String Search query for custom field name.
workItemTypeId WorkItemsTypeID Filter custom fields associated to the given work item type.
Namespace.importSourceUsers

Import source users of the namespace. This field can only be resolved for one namespace in any single request.

{{< details >}} Introduced in GitLab 17.2. Status: Experiment. {{< /details >}}

Returns ImportSourceUserConnection.

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

Arguments
Name Type Description
search String Query to search mappings by name or username of users on source instance.
sort SourceUserSort Sort mapping of users on source instance to users on destination instance by the criteria.
statuses [ImportSourceUserStatus!] Filter mapping of users on source instance to users on destination instance by status.
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
Name Type Description
active Boolean Filter by active or inactive state.
sort Sort Sort results.
versioned Boolean Filter 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
Name Type Description
includeUnscoped Boolean Filter policies that are scoped to the project.
relationship SecurityPolicyRelationType Filter policies by the given policy relationship. Default is DIRECT.
Namespace.pipelineExecutionSchedulePolicies

Pipeline Execution Schedule Policies of the namespace.

Returns PipelineExecutionSchedulePolicyConnection.

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

Arguments
Name Type Description
includeUnscoped Boolean Filter policies that are scoped to the project.
relationship SecurityPolicyRelationType Filter policies by the given policy relationship. Default is DIRECT.
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
Name Type Description
archivedOnly Boolean Return only archived projects.
complianceFrameworkFilters ComplianceFrameworkFilters Filters applied when selecting a compliance framework.
hasCodeCoverage Boolean Returns only the projects which have code coverage.
hasVulnerabilities Boolean Returns only the projects which have vulnerabilities.
ids [ID!] Filter projects by IDs.
includeArchived Boolean Include also archived projects.
includeSiblingProjects {{< icon name=”warning-solid” >}} Boolean Introduced in GitLab 17.2. Status: Experiment. Include also projects from parent group.
includeSubgroups Boolean Include also subgroup projects.
notAimedForDeletion Boolean Include projects that are not aimed for deletion.
sbomComponentId ID Return only the projects related to the specified SBOM component.
search String Search project with most similar names or paths.
sort NamespaceProjectSort Sort projects by the criteria.
withIssuesEnabled Boolean Return only projects with issues enabled.
withMergeRequestsEnabled Boolean Return only projects with merge requests enabled.
withNamespaceDomainPages Boolean Return only projects that use the namespace domain for pages projects.
Namespace.remoteDevelopmentClusterAgents

Cluster agents in the namespace with remote development capabilities.

{{< details >}} Deprecated in GitLab 17.8. Use workspacesClusterAgents. {{< /details >}}

Returns ClusterAgentConnection.

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

Arguments
Name Type Description
filter NamespaceClusterAgentFilter! 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
Name Type Description
actionScanTypes [SecurityReportTypeEnum!] Filters policies by the action scan type. Only these scan types are supported: dast, secret_detection, cluster_image_scanning, container_scanning, sast, sast_iac, dependency_scanning.
includeUnscoped Boolean Filter policies that are scoped to the project.
relationship SecurityPolicyRelationType Filter policies by the given policy relationship. Default is DIRECT.
Namespace.scanResultPolicies

Scan Result Policies of the project.

{{< details >}} Deprecated in GitLab 16.9. Use approvalPolicies. {{< /details >}}

Returns ScanResultPolicyConnection.

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

Arguments
Name Type Description
includeUnscoped Boolean Filter policies that are scoped to the project.
relationship SecurityPolicyRelationType Filter policies by the given policy relationship. Default is DIRECT.
Namespace.vulnerabilityManagementPolicies

Vulnerability Management Policies of the project.

{{< details >}} Introduced in GitLab 17.7. Status: Experiment. {{< /details >}}

Returns VulnerabilityManagementPolicyConnection.

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

Arguments
Name Type Description
includeUnscoped Boolean Filter policies that are scoped to the project.
relationship SecurityPolicyRelationType Filter policies by the given policy relationship. Default is DIRECT.
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.

{{< details >}} Introduced in GitLab 16.10. Status: Experiment. {{< /details >}}

Returns WorkItem.

Arguments
Name Type Description
iid String! IID of the work item.
Namespace.workItemDescriptionTemplates

Work item description templates available to the namespace.

{{< details >}} Introduced in GitLab 17.6. Status: Experiment. {{< /details >}}

Returns WorkItemDescriptionTemplateConnection.

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

Arguments
Name Type Description
name {{< icon name=”warning-solid” >}} String Deprecated in GitLab 17.9. name and project ID are both required for fetching, use DescriptionTemplateContentInputType instead.
search {{< icon name=”warning-solid” >}} String Deprecated in GitLab 17.8. search on template names is performed on the FE only.
Namespace.workItemTypes

Work item types available to the namespace.

{{< details >}} Introduced in GitLab 17.2. Status: Experiment. {{< /details >}}

Returns WorkItemTypeConnection.

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

Arguments
Name Type Description
name IssueType Filter work item types by the given name.
Namespace.workspacesClusterAgents

Cluster agents in the namespace with workspaces capabilities.

{{< details >}} Introduced in GitLab 17.8. Status: Experiment. {{< /details >}}

Returns ClusterAgentConnection.

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

Arguments
Name Type Description
filter NamespaceClusterAgentFilter! Filter the types of cluster agents to return.

NamespaceBan

Fields

Name Type Description
id GlobalID! Global ID of the namespace ban.
namespace Namespace! Root namespace to which the ban applies.
user UserCore! User to which the namespace ban applies.

NamespaceCiCdSetting

Fields

Name Type Description
allowStaleRunnerPruning Boolean Indicates if stale runners directly belonging to the namespace should be periodically pruned.
namespace Namespace Namespace the CI/CD settings belong to.

NamespaceClusterAgentMapping

Represents a namespace-cluster-agent mapping.

Fields

Name Type Description
clusterAgentId ClustersAgentID! Global ID of the cluster agent.
createdAt Time! Timestamp when the namespace-cluster-agent mapping was created.
creatorId UserID! Global ID of the creator.
id RemoteDevelopmentNamespaceClusterAgentMappingID! Global ID of the namespace-cluster-agent mapping.
namespaceId NamespaceID! Global ID of the namespace.
updatedAt Time! Timestamp when the namespace-cluster-agent mapping was last updated.

NamespaceCommitEmail

Fields

Name Type Description
createdAt Time! Timestamp the namespace commit email was created.
email Email! Email.
id ID! Internal ID of the namespace commit email.
namespace Namespace! Namespace.
updatedAt Time! Timestamp the namespace commit email was last updated.

NamespacePermissions

Fields

Name Type Description
generateDescription Boolean! If true, the user can perform generate_description on this resource.
readNamespace Boolean! If true, the user can perform read_namespace on this resource.

NamespaceSidebar

Fields

Name Type Description
openEpicsCount Int Number of open epics of the namespace.
openIssuesCount Int Number of open issues of the namespace.
openMergeRequestsCount Int Number of open merge requests of the namespace.

NestedEnvironment

Describes where code is deployed for a project organized by folder.

Fields

Name Type Description
environment Environment Latest environment in the folder.
name String! Human-readable name of the environment.
size Int! Number of environments nested in the folder.

NetworkPolicyEgress

Fields

Name Type Description
allow String! IP range to allow traffic from.
except [String!] List of IP ranges to exclude from the allow range.

Note

Fields

Name Type Description
author UserCore User who wrote the note.
authorIsContributor Boolean Indicates whether the note author is a contributor.
awardEmoji AwardEmojiConnection List of emoji reactions associated with the note. (see Connections)
body String! Content of the note.
bodyFirstLineHtml String! First line of the note content.
bodyHtml String GitLab Flavored Markdown rendering of the content of the note.
createdAt Time! Timestamp of the note creation.
discussion Discussion Discussion the note is a part of.
externalAuthor String Email address of non-GitLab user adding the note. For guests, the email address is obfuscated.
id NoteID! ID of the note.
imported Boolean Indicates whether the note was imported.
internal Boolean Indicates if the note is internal.
lastEditedAt Time Timestamp when note was last edited.
lastEditedBy UserCore User who last edited the note.
maxAccessLevelOfAuthor String Max access level of the note author in the project.
position DiffPosition Position of the note on a diff.
project Project Project associated with the note.
resolvable Boolean! Indicates if the object can be resolved.
resolved Boolean! Indicates if the object is resolved.
resolvedAt Time Timestamp of when the object was resolved.
resolvedBy UserCore User who resolved the object.
system Boolean! Indicates whether the note was created by the system or by a user.
systemNoteIconName String Name of the icon corresponding to a system note.
systemNoteMetadata SystemNoteMetadata Metadata for the given note if it is a system note.
updatedAt Time! Timestamp of the note’s last activity.
url String URL to view the note in the Web UI.
userPermissions NotePermissions! Permissions for the current user on the resource.

NotePermissions

Fields

Name Type Description
adminNote Boolean! If true, the user can perform admin_note on this resource.
awardEmoji Boolean! If true, the user can perform award_emoji on this resource.
createNote Boolean! If true, the user can perform create_note on this resource.
readNote Boolean! If true, the user can perform read_note on this resource.
repositionNote Boolean! If true, the user can perform reposition_note on this resource.
resolveNote Boolean! If true, the user can perform resolve_note on this resource.

NugetDependencyLinkMetadata

Nuget dependency link metadata.

Fields

Name Type Description
id PackagesNugetDependencyLinkMetadatumID! ID of the metadatum.
targetFramework String! Target framework of the dependency link package.

NugetMetadata

Nuget metadata.

Fields

Name Type Description
iconUrl String Icon URL of the Nuget package.
id PackagesNugetMetadatumID! ID of the metadatum.
licenseUrl String License URL of the Nuget package.
projectUrl String Project URL of the Nuget package.

ObservabilityLog

ObservabilityLog represents a connection between an issue and a log entry.

Fields

Name Type Description
fingerprint String! Log fingerprint of the log.
issue Issue! Issue associated with the log.
serviceName String! Service name of the log.
severityNumber Int! Severity number of the log.
timestamp ISO8601DateTime! Timestamp of the log.
traceIdentifier String! Trace identifier of the log.

ObservabilityMetric

ObservabilityMetric represents a connection between an issue and a metric.

Fields

Name Type Description
issue Issue Issues that the metric is attributed to.
name String! Name of the metric.
type String! OpenTelemetry metric type of the metric.

ObservabilityTrace

ObservabilityTrace represents a connection between an issue and a trace.

Fields

Name Type Description
issue Issue! Issue associated with the trace.
traceIdentifier String! Identifier of the trace.

OncallParticipantType

The rotation participant and color palette.

Fields

Name Type Description
colorPalette String Color palette to assign to the on-call user. For example “blue”.
colorWeight String Color weight to assign to for the on-call user, for example “500”. Max 4 chars. For easy identification of the user.
id IncidentManagementOncallParticipantID! ID of the on-call participant.
user UserCore! User who is participating.

OncallRotationActivePeriodType

Active period time range for on-call rotation.

Fields

Name Type Description
endTime String End of the rotation active period.
startTime String Start of the rotation active period.

Organization

Fields

Name Type Description
avatarUrl {{< icon name=”warning-solid” >}} String Introduced in GitLab 16.7. Status: Experiment. Avatar URL of the organization.
description {{< icon name=”warning-solid” >}} String Introduced in GitLab 16.7. Status: Experiment. Description of the organization.
descriptionHtml {{< icon name=”warning-solid” >}} String Introduced in GitLab 16.7. Status: Experiment. GitLab Flavored Markdown rendering of description.
id {{< icon name=”warning-solid” >}} ID! Introduced in GitLab 16.4. Status: Experiment. ID of the organization.
name {{< icon name=”warning-solid” >}} String! Introduced in GitLab 16.4. Status: Experiment. Name of the organization.
organizationUsers {{< icon name=”warning-solid” >}} OrganizationUserConnection! Introduced in GitLab 16.4. Status: Experiment. Users with access to the organization.
path {{< icon name=”warning-solid” >}} String! Introduced in GitLab 16.4. Status: Experiment. Path of the organization.
webUrl {{< icon name=”warning-solid” >}} String! 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.

{{< details >}} Introduced in GitLab 16.4. Status: Experiment. {{< /details >}}

Returns GroupConnection!.

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

Arguments
Name Type Description
allAvailable Boolean When true, returns all accessible groups. When false, returns only groups where the user is a member. Unauthenticated requests always return all public groups. The owned_only argument takes precedence.
ids [ID!] Filter groups by IDs.
markedForDeletionOn Date Date when the group was marked for deletion.
ownedOnly Boolean Only include groups where the current user has an owner role.
parentPath ID Full path of the parent group.
search String Search query for group name or group full path.
sort String Sort order of results. Format: <field_name>_<sort_direction>, for example: id_desc or name_asc.
topLevelOnly Boolean Only include top-level groups.
Organization.projects

Projects within this organization that the user has access to.

{{< details >}} Introduced in GitLab 16.8. Status: Experiment. {{< /details >}}

Returns ProjectConnection!.

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

Arguments
Name Type Description
aimedForDeletion Boolean Return only projects marked for deletion.
archived ProjectArchived Filter 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.
includeHidden Boolean Include hidden projects.
markedForDeletionOn Date Date when the project was marked for deletion.
membership Boolean Return only projects that the current user is a member of.
minAccessLevel AccessLevelEnum Return only projects where current user has at least the specified access level.
notAimedForDeletion Boolean Exclude projects that are marked for deletion.
personal Boolean Return only personal projects.
programmingLanguageName String Filter projects by programming language name (case insensitive). For example: “css” or “ruby”.
search String Search query, which can be for the project name, a path, or a description.
searchNamespaces Boolean Include namespace in project search.
sort String Sort order of results. Format: <field_name>_<sort_direction>, for example: id_desc or name_asc.
topics [String!] Filter projects by topics.
trending Boolean Return only projects that are trending.
withIssuesEnabled Boolean Return only projects with issues enabled.
withMergeRequestsEnabled Boolean Return only projects with merge requests enabled.
Organization.workspacesClusterAgents

Cluster agents in the organization with workspaces capabilities.

{{< details >}} Introduced in GitLab 17.10. Status: Experiment. {{< /details >}}

Returns ClusterAgentConnection.

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

Arguments
Name Type Description
filter NamespaceClusterAgentFilter! Filter the types of cluster agents to return.

OrganizationStateCounts

Represents the total number of organizations for the represented states.

Fields

Name Type Description
active Int Number of organizations with state ACTIVE.
all Int Number of organizations with state ALL.
inactive Int Number of organizations with state INACTIVE.

OrganizationUser

A user with access to the organization.

Fields

Name Type Description
accessLevel {{< icon name=”warning-solid” >}} OrganizationUserAccess! Introduced in GitLab 16.11. Status: Experiment. Access level of the user in the organization.
badges {{< icon name=”warning-solid” >}} [OrganizationUserBadge!] Introduced in GitLab 16.4. Status: Experiment. Badges describing the user within the organization.
id {{< icon name=”warning-solid” >}} ID! Introduced in GitLab 16.4. Status: Experiment. ID of the organization user.
isLastOwner {{< icon name=”warning-solid” >}} Boolean! Introduced in GitLab 16.11. Status: Experiment. Whether the user is the last owner of the organization.
user {{< icon name=”warning-solid” >}} UserCore! Introduced in GitLab 16.4. Status: Experiment. User that is associated with the organization.
userPermissions OrganizationUserPermissions! Permissions for the current user on the resource.

OrganizationUserAccess

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

Fields

Name Type Description
integerValue {{< icon name=”warning-solid” >}} Int Introduced in GitLab 16.11. Status: Experiment. Integer representation of access level.
stringValue {{< icon name=”warning-solid” >}} OrganizationUserAccessLevel Introduced in GitLab 16.11. Status: Experiment. String representation of access level.

OrganizationUserBadge

An organization user badge.

Fields

Name Type Description
text String! Badge text.
variant String! Badge variant.

OrganizationUserPermissions

Fields

Name Type Description
adminOrganization Boolean! If true, the user can perform admin_organization on this resource.
deleteUser Boolean! If true, the user can perform delete_user on this resource.
removeUser Boolean! If true, the user can perform remove_user on this resource.

Package

Represents a package with pipelines in the package registry.

Fields

Name Type Description
_links PackageLinks! Map of links to perform actions on the package.
createdAt Time! Date of creation.
id PackagesPackageID! ID of the package.
metadata PackageMetadata Package metadata.
name String! Name of the package.
packageType PackageTypeEnum! Package type.
pipelines PipelineConnection Pipelines that built the package. Max page size 20. (see Connections)
project Project! Project where the package is stored.
protectionRuleExists Boolean! Whether any matching package protection rule exists for the package.
status PackageStatus! Package status.
statusMessage String Status message.
tags PackageTagConnection Package tags. (see Connections)
updatedAt Time! Date of most recent update.
userPermissions PackagePermissions! Permissions for the current user on the resource.
version String Version string.

PackageBase

Represents a package in the package registry.

Fields

Name Type Description
_links PackageLinks! Map of links to perform actions on the package.
createdAt Time! Date of creation.
id PackagesPackageID! ID of the package.
metadata PackageMetadata Package metadata.
name String! Name of the package.
packageType PackageTypeEnum! Package type.
project Project! Project where the package is stored.
protectionRuleExists Boolean! Whether any matching package protection rule exists for the package.
status PackageStatus! Package status.
statusMessage String Status message.
tags PackageTagConnection Package tags. (see Connections)
updatedAt Time! Date of most recent update.
userPermissions PackagePermissions! Permissions for the current user on the resource.
version String Version string.

PackageComposerJsonType

Represents a composer JSON file.

Fields

Name Type Description
license String License set in the Composer JSON file.
name String Name set in the Composer JSON file.
type String Type set in the Composer JSON file.
version String Version set in the Composer JSON file.

PackageDependency

Represents a package dependency.

Fields

Name Type Description
id PackagesDependencyID! ID of the dependency.
name String! Name of the dependency.
versionPattern String! Version pattern of the dependency.

Represents a package dependency link.

Fields

Name Type Description
dependency PackageDependency Dependency.
dependencyType PackageDependencyType! Dependency type.
id PackagesDependencyLinkID! ID of the dependency link.
metadata DependencyLinkMetadata Dependency link metadata.

PackageDetailsType

Represents a package details in the Package Registry.

Fields

Name Type Description
_links PackageLinks! Map of links to perform actions on the package.
composerConfigRepositoryUrl String Url of the Composer setup endpoint.
composerUrl String Url of the Composer endpoint.
conanUrl String Url of the Conan project endpoint.
createdAt Time! Date of creation.
dependencyLinks PackageDependencyLinkConnection Dependency link. (see Connections)
id PackagesPackageID! ID of the package.
lastDownloadedAt Time Last time that a file of the package was downloaded.
mavenUrl String Url of the Maven project endpoint.
metadata PackageMetadata Package metadata.
name String! Name of the package.
npmUrl String Url of the NPM project endpoint.
nugetUrl String Url of the Nuget project endpoint.
packageFiles PackageFileConnection Package files. (see Connections)
packageType PackageTypeEnum! Package type.
pipelines PipelineConnection Pipelines that built the package. Max page size 20. (see Connections)
project Project! Project where the package is stored.
protectionRuleExists Boolean! Whether any matching package protection rule exists for the package.
publicPackage Boolean Indicates if there is public access to the package.
pypiSetupUrl String Url of the PyPi project setup endpoint.
pypiUrl String Url of the PyPi project endpoint.
status PackageStatus! Package status.
statusMessage String Status message.
tags PackageTagConnection Package tags. (see Connections)
updatedAt Time! Date of most recent update.
userPermissions PackagePermissions! Permissions for the current user on the resource.
version String Version string.
versions PackageBaseConnection Other versions of the package. (see Connections)

PackageFile

Represents a package file.

Fields

Name Type Description
createdAt Time! Created date.
downloadPath String! Download path of the package file.
fileMd5 String Md5 of the package file.
fileMetadata PackageFileMetadata File metadata.
fileName String! Name of the package file.
fileSha1 String Sha1 of the package file.
fileSha256 String Sha256 of the package file.
id PackagesPackageFileID! ID of the file.
size String! Size of the package file.
updatedAt Time! Updated date.

PackageFileRegistry

Represents the Geo sync and verification state of a package file.

Fields

Name Type Description
checksumMismatch Boolean Indicate if the checksums of the PackageFileRegistry do not match on the primary and secondary.
createdAt Time Timestamp when the PackageFileRegistry was created.
forceToRedownload {{< icon name=”warning-solid” >}} Boolean Deprecated in GitLab 17.10. Removed from registry tables in the database in favor of the newer reusable framework.
id ID! ID of the PackageFileRegistry.
lastSyncFailure String Error message during sync of the PackageFileRegistry.
lastSyncedAt Time Timestamp of the most recent successful sync of the PackageFileRegistry.
missingOnPrimary Boolean Indicate if the PackageFileRegistry is missing on primary.
modelRecordId Int ID of the PackageFileRegistry’s model record.
packageFileId ID! ID of the PackageFile.
retryAt Time Timestamp after which the PackageFileRegistry is resynced.
retryCount Int Number of consecutive failed sync attempts of the PackageFileRegistry.
state RegistryState Sync state of the PackageFileRegistry.
verificationChecksum String The local checksum of the PackageFileRegistry.
verificationChecksumMismatched String The expected checksum of the PackageFileRegistry in case of mismatch.
verificationFailure String Error message during verification of the PackageFileRegistry.
verificationRetryAt Time Timestamp after which the PackageFileRegistry is reverified.
verificationRetryCount Int Number of consecutive failed verification attempts of the PackageFileRegistry.
verificationStartedAt Time Timestamp when the verification of PackageFileRegistry started.
verificationState VerificationStateEnum Verification state of the PackageFileRegistry.
verifiedAt Time Timestamp of the most recent successful verification of the PackageFileRegistry.

PackageHelmDependencyType

Represents a Helm dependency.

Fields

Name Type Description
alias String Alias of the dependency.
condition String Condition of the dependency.
enabled Boolean Indicates the dependency is enabled.
importValues [JSON!] Import-values of the dependency.
name String Name of the dependency.
repository String Repository of the dependency.
tags [String!] Tags of the dependency.
version String Version of the dependency.

PackageHelmMaintainerType

Represents a Helm maintainer.

Fields

Name Type Description
email String Email of the maintainer.
name String Name of the maintainer.
url String URL of the maintainer.

PackageHelmMetadataType

Represents the contents of a Helm Chart.yml file.

Fields

Name Type Description
annotations JSON Annotations for the chart.
apiVersion String! API version of the chart.
appVersion String App version of the chart.
condition String Condition for the chart.
dependencies [PackageHelmDependencyType!] Dependencies of the chart.
deprecated Boolean Indicates if the chart is deprecated.
description String Description of the chart.
home String URL of the home page.
icon String URL to an SVG or PNG image for the chart.
keywords [String!] Keywords for the chart.
kubeVersion String Kubernetes versions for the chart.
maintainers [PackageHelmMaintainerType!] Maintainers of the chart.
name String! Name of the chart.
sources [String!] URLs of the source code for the chart.
tags String Tags for the chart.
type String Type of the chart.
version String! Version of the chart.

Represents links to perform actions on the package.

Fields

Name Type Description
webPath String Path to the package details page.

PackagePermissions

Fields

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

PackageSettings

Namespace-level Package Registry settings.

Fields

Name Type Description
auditEventsEnabled {{< icon name=”warning-solid” >}} Boolean Introduced in GitLab 17.10. Status: Experiment. Indicates whether audit events are created when publishing or deleting a package in the namespace (Premium and Ultimate only). Returns null if package_registry_audit_events feature flag is disabled.
genericDuplicateExceptionRegex UntrustedRegexp When generic_duplicates_allowed is false, you can publish duplicate packages with names that match this regex. Otherwise, this setting has no effect.
genericDuplicatesAllowed Boolean! Indicates whether duplicate generic packages are allowed for the namespace.
lockMavenPackageRequestsForwarding Boolean! Indicates whether Maven package forwarding is locked for all descendent namespaces.
lockNpmPackageRequestsForwarding Boolean! Indicates whether npm package forwarding is locked for all descendent namespaces.
lockPypiPackageRequestsForwarding Boolean! Indicates whether PyPI package forwarding is locked for all descendent namespaces.
mavenDuplicateExceptionRegex UntrustedRegexp When maven_duplicates_allowed is false, you can publish duplicate packages with names that match this regex. Otherwise, this setting has no effect.
mavenDuplicatesAllowed Boolean! Indicates whether duplicate Maven packages are allowed for the namespace.
mavenPackageRequestsForwarding Boolean Indicates whether Maven package forwarding is allowed for the namespace.
mavenPackageRequestsForwardingLocked Boolean! Indicates whether Maven package forwarding settings are locked by a parent namespace.
npmPackageRequestsForwarding Boolean Indicates whether npm package forwarding is allowed for the namespace.
npmPackageRequestsForwardingLocked Boolean! Indicates whether npm package forwarding settings are locked by a parent namespace.
nugetDuplicateExceptionRegex UntrustedRegexp When nuget_duplicates_allowed is false, you can publish duplicate packages with names that match this regex. Otherwise, this setting has no effect.
nugetDuplicatesAllowed Boolean! Indicates whether duplicate NuGet packages are allowed for the namespace.
nugetSymbolServerEnabled Boolean! Indicates whether the NuGet symbol server is enabled for the namespace.
pypiPackageRequestsForwarding Boolean Indicates whether PyPI package forwarding is allowed for the namespace.
pypiPackageRequestsForwardingLocked Boolean! Indicates whether PyPI package forwarding settings are locked by a parent namespace.
terraformModuleDuplicateExceptionRegex UntrustedRegexp When terraform_module_duplicates_allowed is false, you can publish duplicate packages with names that match this regex. Otherwise, this setting has no effect.
terraformModuleDuplicatesAllowed Boolean! Indicates whether duplicate Terraform packages are allowed for the namespace.

PackageTag

Represents a package tag.

Fields

Name Type Description
createdAt Time! Created date.
id ID! ID of the tag.
name String! Name of the tag.
updatedAt Time! Updated date.

PackagesCleanupPolicy

A packages cleanup policy designed to keep only packages and packages assets that matter most.

Fields

Name Type Description
keepNDuplicatedPackageFiles PackagesCleanupKeepDuplicatedPackageFilesEnum! Number of duplicated package files to retain.
nextRunAt Time Next time that the packages cleanup policy will be executed.

PackagesProtectionRule

A packages protection rule designed to protect packages from being pushed by users with a certain access level.

Fields

Name Type Description
id PackagesProtectionRuleID! Global ID of the package protection rule.
minimumAccessLevelForDelete {{< icon name=”warning-solid” >}} PackagesProtectionRuleAccessLevelForDelete Introduced in GitLab 17.10. Status: Experiment. Minimum GitLab access required to delete packages from the package registry. Valid values include OWNER or ADMIN. If the value is nil, the default minimum access level is MAINTAINER. Available only when feature flag packages_protected_packages_delete is enabled.
minimumAccessLevelForPush PackagesProtectionRuleAccessLevel Minimum GitLab access required to push packages to the package registry. Valid values include MAINTAINER, OWNER, or ADMIN. If the value is nil, the default minimum access level is DEVELOPER.
packageNamePattern String! Package name protected by the protection rule. For example, @my-scope/my-package-*. Wildcard character * allowed.
packageType PackagesProtectionRulePackageType! Package type protected by the protection rule. For example, NPM, PYPI.

PageInfo

Information about pagination in a connection.

Fields

Name Type Description
endCursor String When paginating forwards, the cursor to continue.
hasNextPage Boolean! When paginating forwards, are there more items?.
hasPreviousPage Boolean! When paginating backwards, are there more items?.
startCursor String When paginating backwards, the cursor to continue.

PagesDeployment

Represents a pages deployment.

Fields

Name Type Description
active Boolean! Whether the deployment is currently active.
ciBuildId ID ID of the CI build that created the deployment.
createdAt ISO8601DateTime! Time the deployment was created.
deletedAt ISO8601DateTime Time the deployment was deleted.
expiresAt ISO8601DateTime Time the deployment will expire.
fileCount Int Number of files that were published with the deployment.
id ID! ID of the Pages Deployment.
pathPrefix String URL path Prefix that points to the deployment.
project Project! Project the deployment belongs to.
rootDirectory String Path within the build assets that functions as the root directory for Pages sites.
size Int Size of the storage used.
updatedAt ISO8601DateTime! Time the deployment was last updated.
url String! Publicly accessible URL of the deployment.

PagesDeploymentRegistry

Represents the Geo replication and verification state of a pages_deployment.

Fields

Name Type Description
checksumMismatch Boolean Indicate if the checksums of the PagesDeploymentRegistry do not match on the primary and secondary.
createdAt Time Timestamp when the PagesDeploymentRegistry was created.
forceToRedownload {{< icon name=”warning-solid” >}} Boolean Deprecated in GitLab 17.10. Removed from registry tables in the database in favor of the newer reusable framework.
id ID! ID of the PagesDeploymentRegistry.
lastSyncFailure String Error message during sync of the PagesDeploymentRegistry.
lastSyncedAt Time Timestamp of the most recent successful sync of the PagesDeploymentRegistry.
missingOnPrimary Boolean Indicate if the PagesDeploymentRegistry is missing on primary.
modelRecordId Int ID of the PagesDeploymentRegistry’s model record.
pagesDeploymentId ID! ID of the Pages Deployment.
retryAt Time Timestamp after which the PagesDeploymentRegistry is resynced.
retryCount Int Number of consecutive failed sync attempts of the PagesDeploymentRegistry.
state RegistryState Sync state of the PagesDeploymentRegistry.
verificationChecksum String The local checksum of the PagesDeploymentRegistry.
verificationChecksumMismatched String The expected checksum of the PagesDeploymentRegistry in case of mismatch.
verificationFailure String Error message during verification of the PagesDeploymentRegistry.
verificationRetryAt Time Timestamp after which the PagesDeploymentRegistry is reverified.
verificationRetryCount Int Number of consecutive failed verification attempts of the PagesDeploymentRegistry.
verificationStartedAt Time Timestamp when the verification of PagesDeploymentRegistry started.
verificationState VerificationStateEnum Verification state of the PagesDeploymentRegistry.
verifiedAt Time Timestamp of the most recent successful verification of the PagesDeploymentRegistry.

PathLock

Represents a file or directory in the project repository that has been locked.

Fields

Name Type Description
id PathLockID! ID of the path lock.
path String Locked path.
user UserCore User that has locked the path.
userPermissions PathLockPermissions! Permissions for the current user on the resource.

PathLockPermissions

Fields

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

PendingGroupMember

Represents a Pending Group Membership.

Fields

Name Type Description
accessLevel AccessLevel GitLab::Access level.
approved Boolean Whether the pending member has been approved.
avatarUrl String URL to avatar image file of the pending member.
createdAt Time Date and time the membership was created.
createdBy UserCore User that authorized membership.
email String Public email of the pending member.
expiresAt Time Date and time the membership expires.
id ID! ID of the member.
invited Boolean Whether the pending member has been invited.
name String Name of the pending member.
updatedAt Time Date and time the membership was last updated.
user UserCore User that is associated with the member object.
username String Username of the pending member.
webUrl String Web URL of the pending member.

Fields with arguments

PendingGroupMember.mergeRequestInteraction

Find a merge request.

Returns UserMergeRequestInteraction.

Arguments
Name Type Description
id MergeRequestID! Global ID of the merge request.

PendingProjectMember

Represents a Pending Project Membership.

Fields

Name Type Description
accessLevel AccessLevel GitLab::Access level.
approved Boolean Whether the pending member has been approved.
avatarUrl String URL to avatar image file of the pending member.
createdAt Time Date and time the membership was created.
createdBy UserCore User that authorized membership.
email String Public email of the pending member.
expiresAt Time Date and time the membership expires.
id ID! ID of the member.
invited Boolean Whether the pending member has been invited.
name String Name of the pending member.
updatedAt Time Date and time the membership was last updated.
user UserCore User that is associated with the member object.
username String Username of the pending member.
webUrl String Web URL of the pending member.

Fields with arguments

PendingProjectMember.mergeRequestInteraction

Find a merge request.

Returns UserMergeRequestInteraction.

Arguments
Name Type Description
id MergeRequestID! Global ID of the merge request.

Pipeline

Fields

Name Type Description
active Boolean! Indicates if the pipeline is active.
beforeSha String Base SHA of the source branch.
cancelable Boolean! Specifies if a pipeline can be canceled.
child Boolean! If the pipeline is a child or not.
codeQualityReportSummary CodeQualityReportSummary Code Quality report summary for a pipeline.
codeQualityReports CodeQualityDegradationConnection Code Quality degradations reported on the pipeline. (see Connections)
commit Commit Git commit of the pipeline.
commitPath String Path to the commit that triggered the pipeline.
committedAt Time Timestamp of the pipeline’s commit.
complete Boolean! Indicates if a pipeline is complete.
computeMinutes Float Total minutes consumed by the pipeline.
configSource PipelineConfigSourceEnum Configuration source of the pipeline (UNKNOWN_SOURCE, REPOSITORY_SOURCE, AUTO_DEVOPS_SOURCE, WEBIDE_SOURCE, REMOTE_SOURCE, EXTERNAL_PROJECT_SOURCE, BRIDGE_SOURCE, PARAMETER_SOURCE, COMPLIANCE_SOURCE, SECURITY_POLICIES_DEFAULT_SOURCE, PIPELINE_EXECUTION_POLICY_FORCED).
coverage Float Coverage percentage.
createdAt Time! Timestamp of the pipeline’s creation.
dastProfile DastProfile DAST profile associated with the pipeline.
detailedStatus DetailedStatus! Detailed status of the pipeline.
downstream PipelineConnection Pipelines the pipeline will trigger. (see Connections)
duration Int Duration of the pipeline in seconds.
errorMessages PipelineMessageConnection Pipeline error messages. (see Connections)
failureReason String Reason why the pipeline failed.
finishedAt Time Timestamp of the pipeline’s completion.
id ID! ID of the pipeline.
iid String! Internal ID of the pipeline.
jobArtifacts [CiJobArtifact!] Job artifacts of the pipeline.
latest Boolean! If the pipeline is the latest one or not.
manualVariables PipelineManualVariableConnection CI/CD variables added to a manual pipeline. (see Connections)
mergeRequest MergeRequest MR which the Pipeline is attached to.
mergeRequestEventType PipelineMergeRequestEventType Event type of the pipeline associated with a merge request.
name String Name of the pipeline.
path String Relative path to the pipeline’s page.
project Project Project the pipeline belongs to.
queuedDuration Duration How long the pipeline was queued before starting.
ref String Reference to the branch from which the pipeline was triggered.
refPath String Reference path to the branch from which the pipeline was triggered.
refText String! Reference text from the presenter.
retryable Boolean! Specifies if a pipeline’s jobs can be retried.
securityReportSummary SecurityReportSummary Vulnerability and scanned resource counts for each security scanner of the pipeline.
source String Source of the pipeline.
sourceJob CiJob Job where pipeline was triggered from.
stages CiStageConnection Stages of the pipeline. (see Connections)
startedAt Time Timestamp when the pipeline was started.
status PipelineStatusEnum! Status of the pipeline (CREATED, WAITING_FOR_RESOURCE, PREPARING, WAITING_FOR_CALLBACK, PENDING, RUNNING, FAILED, SUCCESS, CANCELED, CANCELING, SKIPPED, MANUAL, SCHEDULED).
stuck Boolean! If the pipeline is stuck.
testReportSummary TestReportSummary! Summary of the test report generated by the pipeline.
totalJobs Int! Total number of jobs in the pipeline.
trigger Boolean! If the pipeline was created by a Trigger request.
triggeredByPath String Path that triggered the pipeline.
troubleshootJobWithAi Boolean! If the user can troubleshoot jobs of a pipeline.
type String! Type of the pipeline.
updatedAt Time! Timestamp of the pipeline’s last activity.
upstream Pipeline Pipeline that triggered the pipeline.
user UserCore Pipeline user.
userPermissions PipelinePermissions! Permissions for the current user on the resource.
usesNeeds Boolean Indicates if the pipeline has jobs with needs dependencies.
warningMessages PipelineMessageConnection Pipeline warning messages. (see Connections)
warnings Boolean! Indicates if a pipeline has warnings.
yamlErrorMessages String Pipeline YAML errors.
yamlErrors Boolean! If the pipeline has YAML errors.

Fields with arguments

Pipeline.job

Specific job in the pipeline, either by name or ID.

Returns CiJob.

Arguments
Name Type Description
id JobID ID of the job.
name String Name of the job.
Pipeline.jobs

Jobs belonging to the pipeline.

Returns CiJobConnection.

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

Arguments
Name Type Description
jobKind CiJobKind Filter jobs by kind.
retried Boolean Filter jobs by retry-status.
securityReportTypes [SecurityReportTypeEnum!] Filter jobs by the type of security report they produce.
statuses [CiJobStatus!] Filter jobs by status.
whenExecuted [String!] Filter jobs by when they are executed.
Pipeline.securityReportFinding

Vulnerability finding reported on the pipeline.

Returns PipelineSecurityReportFinding.

Arguments
Name Type Description
uuid String! UUID of the security report finding.
Pipeline.securityReportFindings

Vulnerability findings reported on the pipeline. 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
Name Type Description
reportType [String!] Filter vulnerability findings by report type.
scanner [String!] Filter vulnerability findings by Scanner.externalId.
severity [String!] Filter vulnerability findings by severity.
sort PipelineSecurityReportFindingSort List vulnerability findings by sort order.
state [VulnerabilityState!] Filter vulnerability findings by state.
Pipeline.sha

SHA of the pipeline’s commit.

Returns String.

Arguments
Name Type Description
format ShaFormat Format of the SHA.
Pipeline.testSuite

A specific test suite in a pipeline test report.

Returns TestSuite.

Arguments
Name Type Description
buildIds [ID!]! IDs of the builds used to run the test suite.

PipelineAnalytics

Fields

Name Type Description
aggregate {{< icon name=”warning-solid” >}} PipelineAnalyticsPeriod Introduced 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.

{{< details >}} Introduced in GitLab 17.9. Status: Experiment. {{< /details >}}

Returns [PipelineAnalyticsPeriod!].

Arguments
Name Type Description
period AnalyticsAggregationPeriod! Periodicity of aggregated data.

PipelineAnalyticsPeriod

Fields

Name Type Description
durationStatistics {{< icon name=”warning-solid” >}} CiDurationStatistics Introduced in GitLab 17.5. Status: Experiment. Pipeline duration statistics.
label {{< icon name=”warning-solid” >}} Date Introduced in GitLab 17.5. Status: Experiment. Data point label (UTC time).

Fields with arguments

PipelineAnalyticsPeriod.count

Pipeline count, optionally filtered by status.

{{< details >}} Introduced in GitLab 17.5. Status: Experiment. {{< /details >}}

Returns BigInt.

Arguments
Name Type Description
status PipelineAnalyticsJobStatus! 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

Name Type Description
checksumMismatch Boolean Indicate if the checksums of the PipelineArtifactRegistry do not match on the primary and secondary.
createdAt Time Timestamp when the PipelineArtifactRegistry was created.
forceToRedownload {{< icon name=”warning-solid” >}} Boolean Deprecated in GitLab 17.10. Removed from registry tables in the database in favor of the newer reusable framework.
id ID! ID of the PipelineArtifactRegistry.
lastSyncFailure String Error message during sync of the PipelineArtifactRegistry.
lastSyncedAt Time Timestamp of the most recent successful sync of the PipelineArtifactRegistry.
missingOnPrimary Boolean Indicate if the PipelineArtifactRegistry is missing on primary.
modelRecordId Int ID of the PipelineArtifactRegistry’s model record.
pipelineArtifactId ID! ID of the pipeline artifact.
retryAt Time Timestamp after which the PipelineArtifactRegistry is resynced.
retryCount Int Number of consecutive failed sync attempts of the PipelineArtifactRegistry.
state RegistryState Sync state of the PipelineArtifactRegistry.
verificationChecksum String The local checksum of the PipelineArtifactRegistry.
verificationChecksumMismatched String The expected checksum of the PipelineArtifactRegistry in case of mismatch.
verificationFailure String Error message during verification of the PipelineArtifactRegistry.
verificationRetryAt Time Timestamp after which the PipelineArtifactRegistry is reverified.
verificationRetryCount Int Number of consecutive failed verification attempts of the PipelineArtifactRegistry.
verificationStartedAt Time Timestamp when the verification of PipelineArtifactRegistry started.
verificationState VerificationStateEnum Verification state of the PipelineArtifactRegistry.
verifiedAt Time Timestamp of the most recent successful verification of the PipelineArtifactRegistry.

PipelineCounts

Represents pipeline counts for the project.

Fields

Name Type Description
all Int Total number of pipelines for the project.
finished Int Number of pipelines with scope FINISHED for the project.
pending Int Number of pipelines with scope PENDING for the project.
running Int Number of pipelines with scope RUNNING for the project.

PipelineExecutionPolicy

Represents the pipeline execution policy.

Fields

Name Type Description
description String! Description of the policy.
editPath String! URL of policy edit page.
enabled Boolean! Indicates whether the policy is enabled.
name String! Name of the policy.
policyBlobFilePath String! Path to the policy file in the project.
policyScope PolicyScope Scope of the policy.
source SecurityPolicySource! Source of the policy. Its fields depend on the source type.
updatedAt Time! Timestamp of when the policy YAML was last updated.
warnings [String!]! Warnings associated with the policy.
yaml String! YAML definition of the policy.

PipelineExecutionSchedulePolicy

Represents the pipeline execution schedule policy.

Fields

Name Type Description
description String! Description of the policy.
editPath String! URL of policy edit page.
enabled Boolean! Indicates whether the policy is enabled.
name String! Name of the policy.
policyBlobFilePath String! Path to the policy file in the project.
policyScope PolicyScope Scope of the policy.
source SecurityPolicySource! Source of the policy. Its fields depend on the source type.
updatedAt Time! Timestamp of when the policy YAML was last updated.
warnings [String!]! Warnings associated with the policy.
yaml String! YAML definition of the policy.

PipelineManualVariable

CI/CD variables added to a manual pipeline.

Fields

Name Type Description
id ID! ID of the variable.
key String Name of the variable.
value String Value of the variable.

PipelineMessage

Fields

Name Type Description
content String! Content of the pipeline message.
id ID! ID of the pipeline message.

PipelineMinimalAccess

Fields

Name Type Description
id ID! ID of the pipeline.
iid String Internal ID of the pipeline.
path String Relative path to the pipeline’s page.
project ProjectInterface Project the pipeline belongs to.
user UserCore Pipeline user.

PipelinePermissions

Fields

Name Type Description
adminPipeline Boolean! If true, the user can perform admin_pipeline on this resource.
cancelPipeline Boolean! If true, the user can perform cancel_pipeline on this resource.
destroyPipeline Boolean! If true, the user can perform destroy_pipeline on this resource.
updatePipeline Boolean! If true, the user can perform update_pipeline on this resource.

PipelineSchedule

Represents a pipeline schedule.

Fields

Name Type Description
active Boolean! Indicates if the pipeline schedule is active.
createdAt Time! Timestamp of when the pipeline schedule was created.
cron String! Cron notation for the schedule.
cronTimezone String! Timezone for the pipeline schedule.
description String Description of the pipeline schedule.
editPath String Edit path of the pipeline schedule.
forTag Boolean! Indicates if a pipelines schedule belongs to a tag.
id ID! ID of the pipeline schedule.
inputs {{< icon name=”warning-solid” >}} CiInputsFieldConnection Introduced in GitLab 17.10. Status: Experiment. Inputs configured for the pipeline schedule.
lastPipeline Pipeline Last pipeline object.
nextRunAt Time Time when the next pipeline will run.
owner UserCore Owner of the pipeline schedule.
project Project Project of the pipeline schedule.
realNextRun Time Time when the next pipeline will run.
ref String Ref of the pipeline schedule.
refForDisplay String Git ref for the pipeline schedule.
refPath String Path to the ref that triggered the pipeline.
updatedAt Time! Timestamp of when the pipeline schedule was last updated.
userPermissions PipelineSchedulePermissions! Permissions for the current user on the resource.
variables PipelineScheduleVariableConnection Pipeline schedule variables. (see Connections)

PipelineSchedulePermissions

Fields

Name Type Description
adminPipelineSchedule Boolean! If true, the user can perform admin_pipeline_schedule on this resource.
playPipelineSchedule Boolean! If true, the user can perform play_pipeline_schedule on this resource.
takeOwnershipPipelineSchedule {{< icon name=”warning-solid” >}} Boolean! Deprecated in GitLab 15.9. Use admin_pipeline_schedule permission to determine if the user can take ownership of a pipeline schedule.
updatePipelineSchedule Boolean! If true, the user can perform update_pipeline_schedule on this resource.

PipelineScheduleVariable

Fields

Name Type Description
id ID! ID of the variable.
key String Name of the variable.
raw Boolean Indicates whether the variable is raw.
value String Value of the variable.
variableType CiVariableType Type of the variable.

PipelineSecurityReportFinding

Represents vulnerability finding of a security report on the pipeline.

Fields

Name Type Description
aiResolutionAvailable Boolean Indicates whether the type of finding can be resolved with AI.
aiResolutionEnabled Boolean Indicates whether the specific finding can be resolved with AI.
assets [AssetType!] List of assets associated with the vulnerability.
description String Description of the vulnerability finding.
descriptionHtml String GitLab Flavored Markdown rendering of description.
details [VulnerabilityDetail!]! Details of the security finding.
dismissalReason VulnerabilityDismissalReason Reason for the dismissal of the security report finding.
dismissedAt Time Time of the dismissal of the security report finding.
dismissedBy UserCore User who dismissed the security report finding.
evidence VulnerabilityEvidence Evidence for the vulnerability.
falsePositive Boolean Indicates whether the vulnerability is a false positive.
identifiers [VulnerabilityIdentifier!]! Identifiers of the vulnerability finding.
issueLinks VulnerabilityIssueLinkConnection List of issue links related to the vulnerability. (see Connections)
links [VulnerabilityLink!] List of links associated with the vulnerability.
location VulnerabilityLocation Location metadata for the vulnerability. Its fields depend on the type of security scan that found the vulnerability.
mergeRequest MergeRequest Merge request that fixes the vulnerability.
project Project Project on which the vulnerability finding was found.
remediations [VulnerabilityRemediationType!] Remediations of the security report finding.
reportType VulnerabilityReportType Type of the security report that found the vulnerability finding.
scanner VulnerabilityScanner Scanner metadata for the vulnerability.
severity VulnerabilitySeverity Severity of the vulnerability finding.
severityOverrides SeverityOverrideConnection List of severity changes for the vulnerability finding. (see Connections)
solution String Solution for resolving the security report finding.
solutionHtml String GitLab Flavored Markdown rendering of solution.
state VulnerabilityState Finding status.
stateComment String Comment for the state of the security report finding.
title String Title of the vulnerability finding.
userPermissions PipelineSecurityReportFindingPermissions! Permissions for the current user on the resource.
uuid String UUIDv5 digest based on the vulnerability’s report type, primary identifier, location, fingerprint, project identifier.
vulnerability Vulnerability Vulnerability related to the security report finding.

PipelineSecurityReportFindingPermissions

Check permissions for the current user on a vulnerability finding.

Fields

Name Type Description
adminVulnerability Boolean! If true, the user can perform admin_vulnerability on this resource.
createIssue Boolean! If true, the user can perform create_issue on this resource.

PipelineTrigger

Fields

Name Type Description
canAccessProject Boolean! Indicates if the pipeline trigger token has access to the project.
description String Description of the pipeline trigger token.
expiresAt Time Timestamp of when the pipeline trigger token expires.
hasTokenExposed Boolean! Indicates if the token is exposed.
id ID! ID of the pipeline trigger token.
lastUsed Time Timestamp of the last usage of the pipeline trigger token.
owner UserCore! Owner of the pipeline trigger token.
token String! Value of the pipeline trigger token.

PolicyAnyMergeRequestViolation

Represents policy violation for any_merge_request report_type.

Fields

Name Type Description
commits JSON List of unsigned commits causing the violation. If policy targets any commits, it returns true.
name String! Represents the policy name.

PolicyApprovalGroup

Fields

Name Type Description
avatarUrl String Avatar URL of the group.
fullPath ID! Full path of the namespace.
id ID! ID of the namespace.
webUrl String! Web URL of the group.

PolicyApprovalSettingsOverride

Represents the approval settings of merge request overridden by a policy.

Fields

Name Type Description
editPath {{< icon name=”warning-solid” >}} String Introduced in GitLab 17.8. Status: Experiment. Path to edit the policy.
name {{< icon name=”warning-solid” >}} String Introduced in GitLab 17.8. Status: Experiment. Policy name.
settings JSON! Overridden project approval settings.

PolicyApproversType

Multiple approvers action.

Fields

Name Type Description
allGroups [PolicyApprovalGroup!] All potential approvers of the group type, including groups inaccessible to the user.
customRoles [MemberRole!] Approvers of the custom role type. Users belonging to these role(s) alone will be approvers.
roles [MemberAccessLevelName!] Approvers of the role type. Users belonging to these role(s) alone will be approvers.
users [UserCore!] Approvers of the user type.

PolicyComparisonPipeline

Represents the source and target pipelines used for comparison in the policy evaluation.

Fields

Name Type Description
reportType ApprovalReportType! Represents the report_type for which the pipeline IDs were evaluated.
source [CiPipelineID!] Represents the list of pipeline GIDs for the source branch.
target [CiPipelineID!] Represents the list of pipeline GIDs for the target branch.

PolicyError

Represents an error that can occur during policy evaluation.

Fields

Name Type Description
data JSON Represents the error-specific data.
error PolicyViolationErrorType! Represents error code.
message String! Represents the error message.
reportType ApprovalReportType! Represents the report type.

PolicyLicenseScanningViolation

Represents policy violation for license_scanning report_type.

Fields

Name Type Description
dependencies [String!]! List of dependencies using the violated license.
license String! License name.
url String URL of the license.

PolicyProjectCreated

Response of security policy creation.

Fields

Name Type Description
errorMessage {{< icon name=”warning-solid” >}} String Deprecated in GitLab 17.5. Use errors instead.
errors [String!] Error messages in case status is :error.
project Project Security Policy Project that was created.
status PolicyProjectCreatedStatus Status of the creation of the security policy project.

PolicyScanFindingViolation

Represents policy violation for scan_finding report_type.

Fields

Name Type Description
location JSON Location of the finding determined by the scanner.
name String Represents the name of the finding.
path String Represents the URL path to the finding.
reportType VulnerabilityReportType! Represents the report type.
severity VulnerabilitySeverity Severity of the finding.

PolicyScope

Fields

Name Type Description
complianceFrameworks ComplianceFrameworkConnection! Compliance Frameworks linked to the policy. (see Connections)
excludingGroups GroupConnection! Groups to which the policy should not be applied. (see Connections)
excludingProjects ProjectConnection! Projects to which the policy should not be applied. (see Connections)
includingGroups GroupConnection! Groups to which the policy should be applied. (see Connections)
includingProjects ProjectConnection! Projects to which the policy should be applied. (see Connections)

PolicyViolationDetails

Represents the details of merge request approval policy violations.

Fields

Name Type Description
anyMergeRequest [PolicyAnyMergeRequestViolation!]! Represents the violations of any_merge_request rules.
comparisonPipelines [PolicyComparisonPipeline!]! Represents the pipelines used for comparison in the policy evaluation.
errors [PolicyError!]! Represents the policy errors.
licenseScanning [PolicyLicenseScanningViolation!]! Represents the violations of license_scanning rules.
newScanFinding [PolicyScanFindingViolation!]! Represents the newly detected violations of scan_finding rules.
policies [PolicyViolationInfo!]! Information about policies that were violated.
previousScanFinding [PolicyScanFindingViolation!]! Represents the violations of scan_finding rules for previously existing vulnerabilities.
violationsCount Int! Total count of violations.

PolicyViolationInfo

Represents generic policy violation information.

Fields

Name Type Description
name String! Represents the name of the violated policy.
reportType ApprovalReportType! Represents the report type.
status PolicyViolationStatus Represents the status of the violated policy.

PreviewBillableUserChange

Fields

Name Type Description
newBillableUserCount Int Total number of billable users after change.
seatsInSubscription Int Number of seats in subscription.
willIncreaseOverage Boolean If the group will have an increased overage after change.

Principal

Representation of who is provided access to. For eg: User/Role/MemberRole/Group.

Fields

Name Type Description
id ID! ID of the principal (User, MemberRole, Role, Group).
type String! Name of the principal (User, MemberRole, Role, Group).

ProductAnalyticsProjectSettings

Project-level settings for product analytics provider.

Fields

Name Type Description
cubeApiBaseUrl String Base URL for the Cube API.
cubeApiKey String API key for the Cube API.
productAnalyticsConfiguratorConnectionString String Connection string for the product analytics configurator.
productAnalyticsDataCollectorHost String Host for the product analytics data collector.

Project

Fields

Name Type Description
actualRepositorySizeLimit Float Size limit for the repository in bytes.
agentConfigurations AgentConfigurationConnection Agent configurations defined by the project. (see Connections)
aiAgents {{< icon name=”warning-solid” >}} AiAgentConnection Introduced in GitLab 16.9. Status: Experiment. Ai Agents for the project.
aiUsageData {{< icon name=”warning-solid” >}} AiUsageData Introduced in GitLab 17.5. Status: Experiment. AI-related data.
aiXrayReports {{< icon name=”warning-solid” >}} AiXrayReportConnection! Introduced in GitLab 17.8. Status: Experiment. X-ray reports of the project.
allowMergeOnSkippedPipeline Boolean If only_allow_merge_if_pipeline_succeeds is true, indicates if merge requests of the project can also be merged with skipped jobs.
allowsMultipleMergeRequestAssignees Boolean! Project allows assigning multiple users to a merge request.
allowsMultipleMergeRequestReviewers Boolean! Project allows assigning multiple reviewers to a merge request.
apiFuzzingCiConfiguration ApiFuzzingCiConfiguration API fuzzing configuration for the project.
archived Boolean Indicates the archived status of the project.
autocloseReferencedIssues Boolean Indicates if issues referenced by merge requests and commits within the default branch are closed automatically.
avatarUrl String Avatar URL of the project.
ciAccessAuthorizedAgents ClusterAgentAuthorizationCiAccessConnection Authorized cluster agents for the project through ci_access keyword. (see Connections)
ciCdSettings ProjectCiCdSetting CI/CD settings for the project.
ciConfigPathOrDefault String! Path of the CI configuration file.
ciDownstreamProjectSubscriptions {{< icon name=”warning-solid” >}} CiProjectSubscriptionConnection Introduced 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 {{< icon name=”warning-solid” >}} CiJobTokenAuthLogConnection Introduced in GitLab 17.6. Status: Experiment. The CI Job Tokens authorization logs.
ciJobTokenScope CiJobTokenScopeType The CI Job Tokens scope of access.
ciJobTokenScopeAllowlist {{< icon name=”warning-solid” >}} CiJobTokenScopeAllowlist Introduced in GitLab 17.6. Status: Experiment. List of CI job token scopes where the project is the source.
ciSubscribedProjects {{< icon name=”warning-solid” >}} CiSubscriptionsProjectConnection Deprecated in GitLab 17.6. Use ciDownstreamProjectSubscriptions.
ciSubscriptionsProjects {{< icon name=”warning-solid” >}} CiSubscriptionsProjectConnection Deprecated in GitLab 17.6. Use ciUpstreamProjectSubscriptions.
ciUpstreamProjectSubscriptions {{< icon name=”warning-solid” >}} CiProjectSubscriptionConnection Introduced 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).
codeCoverageSummary CodeCoverageSummary Code coverage summary associated with the project.
complianceFrameworks ComplianceFrameworkConnection Compliance frameworks associated with the project. (see Connections)
componentUsages CiCatalogResourceComponentUsageConnection Component(s) used by the project. (see Connections)
containerExpirationPolicy {{< icon name=”warning-solid” >}} ContainerExpirationPolicy Deprecated in GitLab 17.5. Use container_tags_expiration_policy.
containerProtectionRepositoryRules {{< icon name=”warning-solid” >}} ContainerProtectionRepositoryRuleConnection Introduced in GitLab 16.10. Status: Experiment. Container protection rules for the project.
containerProtectionTagRules {{< icon name=”warning-solid” >}} ContainerProtectionTagRuleConnection Introduced in GitLab 17.8. Status: Experiment. Container repository tag protection rules for the project.
containerRegistryEnabled Boolean Indicates if Container registry is enabled for the current user.
containerRepositoriesCount Int! Number of container repositories in the project.
containerTagsExpirationPolicy ContainerTagsExpirationPolicy Container tags expiration policy of the project.
corpuses CoverageFuzzingCorpusConnection Find corpuses of the project. (see Connections)
createdAt Time Timestamp of the project creation.
dastScannerProfiles DastScannerProfileConnection DAST scanner profiles associated with the project. (see Connections)
dastSiteProfiles DastSiteProfileConnection DAST Site Profiles associated with the project. (see Connections)
dependencyProxyPackagesSetting DependencyProxyPackagesSetting Packages Dependency Proxy settings for the project. Requires the packages and dependency proxy to be enabled in the config. Requires the packages feature to be enabled at the project level.
description String Short description of the project.
descriptionHtml String GitLab Flavored Markdown rendering of description.
detailedImportStatus DetailedImportStatus Detailed import status of the project.
dora Dora Project’s DORA metrics.
duoFeaturesEnabled {{< icon name=”warning-solid” >}} Boolean Introduced in GitLab 16.9. Status: Experiment. Indicates whether GitLab Duo features are enabled for the project.
duoWorkflowStatusCheck {{< icon name=”warning-solid” >}} DuoWorkflowEnablement Introduced in GitLab 17.7. Status: Experiment. Indicates whether GitLab Duo Workflow is enabled for the project.
exploreCatalogPath {{< icon name=”warning-solid” >}} String Introduced in GitLab 17.6. Status: Experiment. Path to the project catalog resource.
flowMetrics {{< icon name=”warning-solid” >}} ProjectValueStreamAnalyticsFlowMetrics Introduced in GitLab 15.10. Status: Experiment. Flow metrics for value stream analytics.
forkedFrom Project Project the project was forked from.
forkingAccessLevel ProjectFeatureAccess Access level required for forking access.
forksCount Int! Number of times the project has been forked.
fullPath ID! Full path of the project.
googleCloudArtifactRegistryRepository {{< icon name=”warning-solid” >}} GoogleCloudArtifactRegistryRepository Introduced in GitLab 16.10. Status: Experiment. Google Artifact Registry repository. Returns null if the GitLab instance is not a SaaS instance.
grafanaIntegration GrafanaIntegration Grafana integration details for the project.
group Group Group of the project.
hasJiraVulnerabilityIssueCreationEnabled Boolean! Indicates whether Jira issue creation from vulnerabilities is enabled.
httpUrlToRepo String URL to connect to the project via HTTPS.
id ID! ID of the project.
importStatus String Status of import background job of the project.
incidentManagementTimelineEventTags [TimelineEventTagType!] Timeline event tags for the project.
isAdjournedDeletionEnabled {{< icon name=”warning-solid” >}} Boolean! Introduced in GitLab 16.11. Status: Experiment. Indicates if delayed project deletion is enabled.
isCatalogResource {{< icon name=”warning-solid” >}} Boolean Introduced in GitLab 15.11. Status: Experiment. Indicates if a project is a catalog resource.
isForked Boolean! Project is forked.
issuesAccessLevel ProjectFeatureAccess Access level required for issues access.
issuesEnabled Boolean Indicates if Issues are enabled for the current user.
jiraImportStatus String Status of Jira import background job of the project.
jiraImports JiraImportConnection Jira imports into the project. (see Connections)
jobsEnabled Boolean Indicates if CI/CD pipeline jobs are enabled for the current user.
languages [RepositoryLanguage!] Programming languages used in the project.
lastActivityAt Time Timestamp of the project last activity.
lfsEnabled Boolean Indicates if the project has Large File Storage (LFS) enabled.
markedForDeletionOn {{< icon name=”warning-solid” >}} Time Introduced in GitLab 16.10. Status: Experiment. Date when project was scheduled to be deleted.
maxAccessLevel AccessLevel! Maximum access level of the current user in the project.
mergeCommitTemplate String Template used to create merge commit message in merge requests.
mergeRequestTitleRegex String Regex used to validate the title of merge requests.
mergeRequestsAccessLevel ProjectFeatureAccess Access level required for merge requests access.
mergeRequestsDisableCommittersApproval Boolean! Indicates that committers of the given merge request cannot approve.
mergeRequestsEnabled Boolean Indicates if Merge requests are enabled for the current user.
mergeRequestsFfOnlyEnabled Boolean Indicates if no merge commits should be created and all merges should instead be fast-forwarded, which means that merging is only allowed if the branch could be fast-forwarded.
name String! Name of the project without the namespace.
nameWithNamespace String! Name of the project including the namespace.
namespace Namespace Namespace of the project.
onlyAllowMergeIfAllDiscussionsAreResolved Boolean Indicates if merge requests of the project can only be merged when all the discussions are resolved.
onlyAllowMergeIfAllStatusChecksPassed Boolean Indicates that merges of merge requests should be blocked unless all status checks have passed.
onlyAllowMergeIfPipelineSucceeds Boolean Indicates if merge requests of the project can only be merged with successful jobs.
openIssuesCount Int Number of open issues for the project.
openMergeRequestsCount Int Number of open merge requests for the project.
organizationEditPath {{< icon name=”warning-solid” >}} String Introduced in GitLab 16.11. Status: Experiment. Path for editing project at the organization level.
packagesCleanupPolicy PackagesCleanupPolicy Packages cleanup policy for the project.
packagesProtectionRules {{< icon name=”warning-solid” >}} PackagesProtectionRuleConnection Introduced in GitLab 16.6. Status: Experiment. Packages protection rules for the project.
pagesForceHttps Boolean! Project’s Pages site redirects unsecured connections to HTTPS.
pagesUseUniqueDomain Boolean! Project’s Pages site uses a unique subdomain.
path String! Path of the project.
pathLocks PathLockConnection The project’s path locks. (see Connections)
pendingMemberApprovals {{< icon name=”warning-solid” >}} MemberApprovalConnection Introduced in GitLab 17.3. Status: Experiment. Pending member promotions of the project.
permanentDeletionDate {{< icon name=”warning-solid” >}} String Introduced in GitLab 16.11. Status: Experiment. Date when project will be deleted if delayed project deletion is enabled.
pipelineTriggers {{< icon name=”warning-solid” >}} PipelineTriggerConnection Introduced in GitLab 16.3. Status: Experiment. List of pipeline trigger tokens.
preReceiveSecretDetectionEnabled Boolean Indicates whether Secret Push Protection is on or not for the project.
preventMergeWithoutJiraIssueEnabled Boolean! Indicates if an associated issue from Jira is required.
printingMergeRequestLinkEnabled Boolean Indicates if a link to create or view a merge request should display after a push to Git repositories of the project from the command line.
productAnalyticsInstrumentationKey {{< icon name=”warning-solid” >}} String Introduced in GitLab 16.0. Status: Experiment. Product Analytics instrumentation key assigned to the project.
productAnalyticsSettings ProductAnalyticsProjectSettings Project-level settings for product analytics.
productAnalyticsState {{< icon name=”warning-solid” >}} ProductAnalyticsState Introduced 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 {{< icon name=”warning-solid” >}} ProjectPlanLimits Introduced in GitLab 16.9. Status: Experiment. Plan limits for the current project.
protectableBranches {{< icon name=”warning-solid” >}} [String!] Introduced in GitLab 16.9. Status: Experiment. List of unprotected branches, ignoring any wildcard branch rules.
publicJobs Boolean Indicates if there is public access to pipelines and job details of the project, including output logs and artifacts.
pushRules PushRules Project’s push rules settings.
recentIssueBoards BoardConnection List of recently visited boards of the project. Maximum size is 4. (see Connections)
removeSourceBranchAfterMerge Boolean Indicates if Delete source branch option should be enabled by default for all new merge requests of the project.
repository Repository Git repository of the project.
repositorySizeExcess Float Size of repository that exceeds the limit in bytes.
requestAccessEnabled Boolean Indicates if users can request member access to the project.
requirementStatesCount RequirementStatesCount Number of requirements for the project by their state.
sastCiConfiguration SastCiConfiguration SAST CI configuration for the project.
savedReplies ProjectSavedReplyConnection Saved replies available to the project. (see Connections)
secretPushProtectionEnabled Boolean Indicates whether Secret Push Protection is on or not for the project.
securityDashboardPath String Path to project’s security dashboard.
securityPolicyProject Project Security policy project assigned to the project, absent if assigned to a parent group.
securityPolicyProjectLinkedNamespaces {{< icon name=”warning-solid” >}} NamespaceConnection Deprecated in GitLab 17.4. This was renamed. Use: security_policy_project_linked_groups.
securityPolicyProjectLinkedProjects ProjectConnection Projects linked to the project, when used as Security Policy Project. (see Connections)
securityScanners SecurityScanners Information about security analyzers used in the project.
sentryErrors SentryErrorCollection Paginated collection of Sentry errors on the project.
serviceDeskAddress String E-mail address of the Service Desk.
serviceDeskEnabled Boolean Indicates if the project has Service Desk enabled.
sharedRunnersEnabled Boolean Indicates if shared runners are enabled for the project.
snippetsEnabled Boolean Indicates if Snippets are enabled for the current user.
squashCommitTemplate String Template used to create squash commit message in merge requests.
squashReadOnly Boolean! Indicates if squashReadOnly is enabled.
sshUrlToRepo String URL to connect to the project via SSH.
starCount Int! Number of times the project has been starred.
statistics ProjectStatistics Statistics of the project.
statisticsDetailsPaths ProjectStatisticsRedirect Redirects for Statistics of the project.
suggestionCommitMessage String Commit message used to apply merge request suggestions.
tagList {{< icon name=”warning-solid” >}} String Deprecated in GitLab 13.12. Use topics.
targetBranchRules ProjectTargetBranchRuleConnection Target branch rules of the project. (see Connections)
terraformStates TerraformStateConnection Terraform states associated with the project. (see Connections)
timelogCategories {{< icon name=”warning-solid” >}} TimeTrackingTimelogCategoryConnection Introduced in GitLab 15.3. Status: Experiment. Timelog categories for the project.
topics [String!] List of project topics.
trackingKey {{< icon name=”warning-solid” >}} String Introduced in GitLab 16.0. Status: Experiment. Tracking key assigned to the project.
updatedAt Time Timestamp of when the project was last updated.
userAccessAuthorizedAgents ClusterAgentAuthorizationUserAccessConnection Authorized cluster agents for the project through user_access keyword. (see Connections)
userPermissions ProjectPermissions! Permissions for the current user on the resource.
valueStreamAnalytics ValueStreamAnalytics Information about Value Stream Analytics within the project.
visibility String Visibility of the project.
vulnerabilityArchives {{< icon name=”warning-solid” >}} [VulnerabilityArchive!] Introduced in GitLab 17.9. Status: Experiment. All vulnerability archives of the project.
vulnerabilityImages VulnerabilityContainerImageConnection Container images reported on the project vulnerabilities. (see Connections)
vulnerabilityScanners VulnerabilityScannerConnection Vulnerability scanners reported on the project vulnerabilities. (see Connections)
vulnerabilityStatistic {{< icon name=”warning-solid” >}} VulnerabilityStatisticType Introduced in GitLab 18.0. Status: Experiment. Counts for each vulnerability severity in the project.
webUrl String Web URL of the project.
wikiEnabled Boolean Indicates if Wikis are enabled for the current user.

Fields with arguments

Project.aiAgent

Find a specific AI Agent.

{{< details >}} Introduced in GitLab 16.10. Status: Experiment. {{< /details >}}

Returns AiAgent.

Arguments
Name Type Description
id AiAgentID! ID of the Agent.
Project.aiMetrics

AI-related metrics.

{{< details >}} Introduced in GitLab 16.11. Status: Experiment. {{< /details >}}

Returns AiMetrics.

Arguments
Name Type Description
endDate Date Date range to end at. Default is the end of current month.
startDate Date Date range to start from. Default is the beginning of current month.
Project.aiUserMetrics

AI-related user metrics.

{{< details >}} Introduced in GitLab 17.5. Status: Experiment. {{< /details >}}

Returns AiUserMetricsConnection.

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

Arguments
Name Type Description
endDate Date Date range to end at. Default is the end of current month.
startDate Date Date range to start from. Default is the beginning of current month.
Project.alertManagementAlert

A single Alert Management alert of the project.

Returns AlertManagementAlert.

Arguments
Name Type Description
assigneeUsername String Username of a user assigned to the issue.
domain AlertManagementDomainFilter! Filter query for given domain.
iid String IID of the alert. For example, “1”.
search String Search query for title, description, service, or monitoring_tool.
sort AlertManagementAlertSort Sort alerts by 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
Name Type Description
assigneeUsername String Username of a user assigned to the issue.
search String Search query for title, description, service, or monitoring_tool.
Project.alertManagementAlerts

Alert Management alerts of the project.

Returns AlertManagementAlertConnection.

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

Arguments
Name Type Description
assigneeUsername String Username of a user assigned to the issue.
domain AlertManagementDomainFilter! Filter query for given domain.
iid String IID of the alert. For example, “1”.
search String Search query for title, description, service, or monitoring_tool.
sort AlertManagementAlertSort Sort alerts by 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
Name Type Description
id AlertManagementHttpIntegrationID ID of the integration.
Project.alertManagementIntegrations

Integrations which can receive alerts for the project.

Returns AlertManagementIntegrationConnection.

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

Arguments
Name Type Description
id GlobalID ID of the integration.
Project.alertManagementPayloadFields

Extract alert fields from payload for custom mapping.

Returns [AlertManagementPayloadAlertField!].

Arguments
Name Type Description
payloadExample String! Sample payload for extracting alert fields for custom mappings.
Project.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
Name Type Description
includeUnscoped Boolean Filter policies that are scoped to the project.
relationship SecurityPolicyRelationType Filter policies by the given policy relationship. Default is DIRECT.
Project.autocompleteUsers

Search users for autocompletion.

Returns [AutocompletedUser!].

Arguments
Name Type Description
search String Query to search users by name, username, or public email.
Project.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
Name Type Description
titleQuery String Term by which to search deploy key titles.
Project.board

A single board of the project.

Returns Board.

Arguments
Name Type Description
id BoardID! ID of the board.
Project.boards

Boards of the project.

Returns BoardConnection.

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

Arguments
Name Type Description
id BoardID Find a board by its ID.
Project.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
Name Type Description
buildMissing Boolean Return unpersisted custom branch rules.
Project.ciConfigVariables

CI/CD config variable.

{{< details >}} Introduced in GitLab 15.3. Status: Experiment. {{< /details >}}

Returns [CiConfigVariable!].

Arguments
Name Type Description
ref String! Ref.
Project.ciPipelineCreationInputs

Inputs to create a pipeline.

{{< details >}} Introduced in GitLab 17.10. Status: Experiment. {{< /details >}}

Returns [CiInputsSpec!].

Arguments
Name Type Description
ref String! Ref where to create the pipeline.
Project.ciPipelineCreationRequest

Get information about an asynchronous pipeline creation request.

{{< details >}} Introduced in GitLab 17.9. Status: Experiment. {{< /details >}}

Returns CiPipelineCreationRequest.

Arguments
Name Type Description
requestId String! ID of the pipeline creation request.
Project.ciTemplate

Find a single CI/CD template by name.

Returns CiTemplate.

Arguments
Name Type Description
name String! Name of the CI/CD template to search for. Template must be formatted as Name.gitlab-ci.yml.
Project.ciVariables

List of the project’s CI/CD variables.

Returns CiProjectVariableConnection.

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

Arguments
Name Type Description
sort CiVariableSort Sort order of results.
Project.clusterAgent

Find a single cluster agent by name.

Returns ClusterAgent.

Arguments
Name Type Description
hasRemoteDevelopmentAgentConfig {{< icon name=”warning-solid” >}} Boolean Deprecated in GitLab 17.10. Use has_workspaces_agent_config filter instead.
hasRemoteDevelopmentEnabled Boolean Returns only cluster agents which have been enabled with the remote development feature.
hasVulnerabilities Boolean Returns only cluster agents which have vulnerabilities.
hasWorkspacesAgentConfig Boolean Returns only cluster agents which have an associated workspaces agent config.
name String! Name of the cluster agent.
Project.clusterAgents

Cluster agents associated with the project.

Returns ClusterAgentConnection.

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

Arguments
Name Type Description
hasRemoteDevelopmentAgentConfig {{< icon name=”warning-solid” >}} Boolean Deprecated in GitLab 17.10. Use has_workspaces_agent_config filter instead.
hasRemoteDevelopmentEnabled Boolean Returns only cluster agents which have been enabled with the remote development feature.
hasVulnerabilities Boolean Returns only cluster agents which have vulnerabilities.
hasWorkspacesAgentConfig Boolean Returns only cluster agents which have an associated workspaces agent config.
Project.commitReferences

Get tag names containing a given commit.

{{< details >}} Introduced in GitLab 16.0. Status: Experiment. {{< /details >}}

Returns CommitReferences.

Arguments
Name Type Description
commitSha String! Project commit SHA identifier. For example, 287774414568010855642518513f085491644061.
Project.complianceControlStatus

Compliance control statuses for a project.

{{< details >}} Introduced in GitLab 17.11. Status: Experiment. {{< /details >}}

Returns ProjectComplianceControlStatusTypeConnection.

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

Arguments
Name Type Description
filters ProjectComplianceControlStatusInput Filters applied when retrieving compliance control statuses for the project.
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
Name Type Description
filters ComplianceStandardsProjectAdherenceInput Filters applied when retrieving compliance standards adherence.
Project.componentVersions

Find software dependency versions by component name.

{{< details >}} Introduced in GitLab 17.10. Status: Experiment. {{< /details >}}

Returns ComponentVersionConnection!.

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

Arguments
Name Type Description
componentName String! Name of the SBoM component.
Project.components

Find software dependencies by name.

{{< details >}} Introduced in GitLab 17.9. Status: Experiment. {{< /details >}}

Returns [Component!].

Arguments
Name Type Description
name String Entire 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
Name Type Description
name String Filter the container repositories by their name.
sort ContainerRepositorySort Sort container repositories by the criteria.
Project.customizableDashboardVisualizations

Visualizations of the project or associated configuration project.

{{< details >}} Introduced in GitLab 16.1. Status: Experiment. {{< /details >}}

Returns CustomizableDashboardVisualizationConnection.

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

Arguments
Name Type Description
slug String Slug of the visualization to return.
Project.customizableDashboards

Customizable dashboards for the project.

{{< details >}} Introduced in GitLab 15.6. Status: Experiment. {{< /details >}}

Returns CustomizableDashboardConnection.

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

Arguments
Name Type Description
category CustomizableDashboardCategory Find by dashboard type.
slug String Find by dashboard slug.
Project.dastProfile

DAST Profile associated with the project.

Returns DastProfile.

Arguments
Name Type Description
hasDastProfileSchedule Boolean Filter DAST Profiles by whether or not they have a schedule.
id DastProfileID! ID of the DAST Profile.
Project.dastProfiles

DAST Profiles associated with the project.

Returns DastProfileConnection.

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

Arguments
Name Type Description
hasDastProfileSchedule Boolean Filter DAST Profiles by whether or not they have a schedule.
Project.dastSiteProfile

DAST Site Profile associated with the project.

Returns DastSiteProfile.

Arguments
Name Type Description
id DastSiteProfileID! ID of the site profile.
Project.dastSiteValidations

DAST Site Validations associated with the project.

Returns DastSiteValidationConnection.

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

Arguments
Name Type Description
normalizedTargetUrls [String!] Normalized URL of the target to be scanned.
status DastSiteValidationStatusEnum Status of the site validation.
Project.dataTransfer

Data transfer data point for a specific period. This is mocked data under a development feature flag.

Returns ProjectDataTransfer.

Arguments
Name Type Description
from Date Retain egress data for one year. Data for the current month will increase dynamically as egress occurs.
to Date End date for the data.
Project.dependencies

Software dependencies used by the project.

Returns DependencyConnection.

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

Arguments
Name Type Description
componentIds [SbomComponentID!] Filter dependencies by component IDs.
componentNames [String!] Filter dependencies by component names.
packageManagers [PackageManager!] Filter dependencies by package managers.
sort DependencySort Sort dependencies by given criteria.
sourceTypes [SbomSourceType!] Filter dependencies by source type.
Project.dependencyPaths

Ancestor dependency paths for a dependency used by the project. \ Returns null if dependency_graph_graphql feature flag is disabled.

{{< details >}} Introduced in GitLab 17.10. Status: Experiment. {{< /details >}}

Returns [DependencyPath!].

Arguments
Name Type Description
occurrence SbomOccurrenceID! Dependency path for occurrence.
Project.deployment

Details of the deployment of the project.

Returns Deployment.

Arguments
Name Type Description
iid ID! Project-level internal ID of the Deployment.
Project.environment

A single environment of the project.

Returns Environment.

Arguments
Name Type Description
name String Name of the environment.
search String Search query for environment name.
states [String!] States of environments that should be included in result.
type String Search query for environment type.
Project.environments

Environments of the project. This field can only be resolved for one project in any single request.

Returns EnvironmentConnection.

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

Arguments
Name Type Description
name String Name of the environment.
search String Search query for environment name.
states [String!] States of environments that should be included in result.
type String Search query for environment type.
Project.forkDetails

Details of the fork project compared to its upstream project.

{{< details >}} Introduced in GitLab 15.7. Status: Experiment. {{< /details >}}

Returns ForkDetails.

Arguments
Name Type Description
ref String Ref of the fork. Default value is HEAD.
Project.forkTargets

Namespaces in which the current user can fork the project into.

Returns NamespaceConnection.

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

Arguments
Name Type Description
search String Search query for path or name.
Project.gitlabSubscriptionsPreviewBillableUserChange

Preview Billable User Changes.

Returns PreviewBillableUserChange.

Arguments
Name Type Description
addGroupId Int Group ID to add.
addUserEmails [String!] User emails to add.
addUserIds [Int!] User IDs to add.
memberRoleId Int Custom role assigned to the users.
role GitlabSubscriptionsUserRole! Role of users being added to group.
Project.incidentManagementEscalationPolicies

Incident Management escalation policies of the project.

Returns EscalationPolicyTypeConnection.

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

Arguments
Name Type Description
name String Fuzzy search by escalation policy name.
Project.incidentManagementEscalationPolicy

Incident Management escalation policy of the project.

Returns EscalationPolicyType.

Arguments
Name Type Description
id IncidentManagementEscalationPolicyID! ID of the escalation policy.
name String Fuzzy search by escalation policy name.
Project.incidentManagementOncallSchedules

Incident Management On-call schedules of the project.

Returns IncidentManagementOncallScheduleConnection.

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

Arguments
Name Type Description
iids [ID!] IIDs of on-call schedules.
Project.incidentManagementTimelineEvent

Incident Management Timeline event associated with the incident.

Returns TimelineEventType.

Arguments
Name Type Description
id IncidentManagementTimelineEventID! ID of the timeline event.
incidentId IssueID! ID of the incident.
Project.incidentManagementTimelineEvents

Incident Management Timeline events associated with the incident.

Returns TimelineEventTypeConnection.

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

Arguments
Name Type Description
incidentId IssueID! ID of the incident.
Project.inheritedCiVariables

List of CI/CD variables the project inherited from its parent group and ancestors.

Returns InheritedCiVariableConnection.

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

Arguments
Name Type Description
sort CiGroupVariablesSort Sort variables by the criteria.
Project.issue

A single issue of the project.

Returns Issue.

Arguments
Name Type Description
assigneeId String ID of a user assigned to the issues. Wildcard values “NONE” and “ANY” are supported.
assigneeUsername {{< icon name=”warning-solid” >}} String Deprecated in GitLab 13.11. Use assigneeUsernames.
assigneeUsernames [String!] Usernames of users assigned to the issue.
assigneeWildcardId AssigneeWildcardId Filter by assignee wildcard. Incompatible with assigneeUsername and assigneeUsernames.
authorUsername String Username of the author of the issue.
closedAfter Time Issues closed after the date.
closedBefore Time Issues closed before the date.
confidential Boolean Filter for confidential issues. If “false”, excludes confidential issues. If “true”, returns only confidential issues.
createdAfter Time Issues created after the date.
createdBefore Time Issues created before the date.
crmContactId String ID of a contact assigned to the issues.
crmOrganizationId String ID of an organization assigned to the issues.
customField {{< icon name=”warning-solid” >}} [WorkItemWidgetCustomFieldFilterInputType!] Introduced in GitLab 17.10. Status: Experiment. Filter by custom fields.
dueAfter Time Return issues due on or after the given time.
dueBefore Time Return issues due on or before the given time.
epicId String ID of an epic associated with the issues, “none” and “any” values are supported.
epicWildcardId EpicWildcardId Filter by epic ID wildcard. Incompatible with epicId.
healthStatus {{< icon name=”warning-solid” >}} HealthStatus Deprecated in GitLab 15.4. Use healthStatusFilter.
healthStatusFilter HealthStatusFilter Health status of the issue, “none” and “any” values are supported.
iid String IID of the issue. For example, “1”.
iids [String!] List of IIDs of issues. For example, ["1", "2"].
in [IssuableSearchableField!] Specify the fields to perform the search in. Defaults to [TITLE, DESCRIPTION]. Requires the search argument.’.
includeSubepics Boolean Whether to include subepics when filtering issues by epicId.
iterationCadenceId [IterationsCadenceID!] Filter by a list of iteration cadence IDs.
iterationId [ID] List of iteration Global IDs applied to the issue.
iterationTitle String Filter by iteration title.
iterationWildcardId IterationWildcardId Filter by iteration ID wildcard.
labelName [String] Labels applied to the issue.
milestoneTitle [String] Milestone applied to the issue.
milestoneWildcardId MilestoneWildcardId Filter issues by milestone ID wildcard.
myReactionEmoji String Filter by reaction emoji applied by the current user. Wildcard values “NONE” and “ANY” are supported.
not NegatedIssueFilterInput Negated arguments.
or UnionedIssueFilterInput List of arguments with inclusive OR.
releaseTag [String!] Release tag associated with the issue’s milestone.
releaseTagWildcardId ReleaseTagWildcardId Filter issues by release tag ID wildcard.
search String Search query for title or description.
sort IssueSort Sort issues by the criteria.
state IssuableState Current state of the issue.
subscribed SubscriptionStatus Issues the current user is subscribed to.
types [IssueType!] Filter issues by the given issue types.
updatedAfter Time Issues updated after the date.
updatedBefore Time Issues updated before the date.
weight String Weight applied to the issue, “none” and “any” values are supported.
weightWildcardId WeightWildcardId Filter by weight ID wildcard. Incompatible with weight.
Project.issueStatusCounts

Counts of issues by status for the project.

Returns IssueStatusCountsType.

Arguments
Name Type Description
assigneeId String ID of a user assigned to the issues. Wildcard values “NONE” and “ANY” are supported.
assigneeUsername {{< icon name=”warning-solid” >}} String Deprecated in GitLab 13.11. Use assigneeUsernames.
assigneeUsernames [String!] Usernames of users assigned to the issue.
assigneeWildcardId AssigneeWildcardId Filter by assignee wildcard. Incompatible with assigneeUsername and assigneeUsernames.
authorUsername String Username of the author of the issue.
closedAfter Time Issues closed after the date.
closedBefore Time Issues closed before the date.
confidential Boolean Filter for confidential issues. If “false”, excludes confidential issues. If “true”, returns only confidential issues.
createdAfter Time Issues created after the date.
createdBefore Time Issues created before the date.
crmContactId String ID of a contact assigned to the issues.
crmOrganizationId String ID of an organization assigned to the issues.
customField {{< icon name=”warning-solid” >}} [WorkItemWidgetCustomFieldFilterInputType!] Introduced in GitLab 17.10. Status: Experiment. Filter by custom fields.
dueAfter Time Return issues due on or after the given time.
dueBefore Time Return issues due on or before the given time.
epicId String ID of an epic associated with the issues, “none” and “any” values are supported.
epicWildcardId EpicWildcardId Filter by epic ID wildcard. Incompatible with epicId.
healthStatusFilter HealthStatusFilter Health status of the issue, “none” and “any” values are supported.
iid String IID of the issue. For example, “1”.
iids [String!] List of IIDs of issues. For example, ["1", "2"].
in [IssuableSearchableField!] Specify the fields to perform the search in. Defaults to [TITLE, DESCRIPTION]. Requires the search argument.’.
includeSubepics Boolean Whether to include subepics when filtering issues by epicId.
iterationCadenceId [IterationsCadenceID!] Filter by a list of iteration cadence IDs.
iterationId [ID] List of iteration Global IDs applied to the issue.
iterationTitle String Filter by iteration title.
iterationWildcardId IterationWildcardId Filter by iteration ID wildcard.
labelName [String] Labels applied to the issue.
milestoneTitle [String] Milestone applied to the issue.
milestoneWildcardId MilestoneWildcardId Filter issues by milestone ID wildcard.
myReactionEmoji String Filter by reaction emoji applied by the current user. Wildcard values “NONE” and “ANY” are supported.
not NegatedIssueFilterInput Negated arguments.
or UnionedIssueFilterInput List of arguments with inclusive OR.
releaseTag [String!] Release tag associated with the issue’s milestone.
releaseTagWildcardId ReleaseTagWildcardId Filter issues by release tag ID wildcard.
search String Search query for title or description.
subscribed SubscriptionStatus Issues the current user is subscribed to.
types [IssueType!] Filter issues by the given issue types.
updatedAfter Time Issues updated after the date.
updatedBefore Time Issues updated before the date.
weight String Weight applied to the issue, “none” and “any” values are supported.
weightWildcardId WeightWildcardId Filter by weight ID wildcard. Incompatible with weight.
Project.issues

Issues of the project.

Returns IssueConnection.

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

Arguments
Name Type Description
assigneeId String ID of a user assigned to the issues. Wildcard values “NONE” and “ANY” are supported.
assigneeUsername {{< icon name=”warning-solid” >}} String Deprecated in GitLab 13.11. Use assigneeUsernames.
assigneeUsernames [String!] Usernames of users assigned to the issue.
assigneeWildcardId AssigneeWildcardId Filter by assignee wildcard. Incompatible with assigneeUsername and assigneeUsernames.
authorUsername String Username of the author of the issue.
closedAfter Time Issues closed after the date.
closedBefore Time Issues closed before the date.
confidential Boolean Filter for confidential issues. If “false”, excludes confidential issues. If “true”, returns only confidential issues.
createdAfter Time Issues created after the date.
createdBefore Time Issues created before the date.
crmContactId String ID of a contact assigned to the issues.
crmOrganizationId String ID of an organization assigned to the issues.
customField {{< icon name=”warning-solid” >}} [WorkItemWidgetCustomFieldFilterInputType!] Introduced in GitLab 17.10. Status: Experiment. Filter by custom fields.
dueAfter Time Return issues due on or after the given time.
dueBefore Time Return issues due on or before the given time.
epicId String ID of an epic associated with the issues, “none” and “any” values are supported.
epicWildcardId EpicWildcardId Filter by epic ID wildcard. Incompatible with epicId.
healthStatus {{< icon name=”warning-solid” >}} HealthStatus Deprecated in GitLab 15.4. Use healthStatusFilter.
healthStatusFilter HealthStatusFilter Health status of the issue, “none” and “any” values are supported.
iid String IID of the issue. For example, “1”.
iids [String!] List of IIDs of issues. For example, ["1", "2"].
in [IssuableSearchableField!] Specify the fields to perform the search in. Defaults to [TITLE, DESCRIPTION]. Requires the search argument.’.
includeSubepics Boolean Whether to include subepics when filtering issues by epicId.
iterationCadenceId [IterationsCadenceID!] Filter by a list of iteration cadence IDs.
iterationId [ID] List of iteration Global IDs applied to the issue.
iterationTitle String Filter by iteration title.
iterationWildcardId IterationWildcardId Filter by iteration ID wildcard.
labelName [String] Labels applied to the issue.
milestoneTitle [String] Milestone applied to the issue.
milestoneWildcardId MilestoneWildcardId Filter issues by milestone ID wildcard.
myReactionEmoji String Filter by reaction emoji applied by the current user. Wildcard values “NONE” and “ANY” are supported.
not NegatedIssueFilterInput Negated arguments.
or UnionedIssueFilterInput List of arguments with inclusive OR.
releaseTag [String!] Release tag associated with the issue’s milestone.
releaseTagWildcardId ReleaseTagWildcardId Filter issues by release tag ID wildcard.
search String Search query for title or description.
sort IssueSort Sort issues by the criteria.
state IssuableState Current state of the issue.
subscribed SubscriptionStatus Issues the current user is subscribed to.
types [IssueType!] Filter issues by the given issue types.
updatedAfter Time Issues updated after the date.
updatedBefore Time Issues updated before the date.
weight String Weight applied to the issue, “none” and “any” values are supported.
weightWildcardId WeightWildcardId Filter by weight ID wildcard. Incompatible with weight.
Project.iterationCadences

Find iteration cadences.

Returns IterationCadenceConnection.

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

Arguments
Name Type Description
active Boolean Whether the iteration cadence is active.
automatic Boolean Whether the iteration cadence should automatically generate upcoming iterations.
durationInWeeks Int Duration in weeks of the iterations within the cadence.
id IterationsCadenceID Global ID of the iteration cadence to look up.
includeAncestorGroups Boolean Whether to include ancestor groups to search iterations cadences in.
title String Fuzzy search by title.
Project.iterations

Find iterations.

Returns IterationConnection.

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

Arguments
Name Type Description
id ID Global ID of the Iteration to look up.
iid ID Internal ID of the Iteration to look up.
in [IterationSearchableField!] Fields in which the fuzzy-search should be performed with the query given in the argument search. Defaults to [title].
includeAncestors Boolean Whether to include ancestor iterations. Defaults to true.
includeDescendants Boolean Whether to include descendant iterations.
iterationCadenceIds [IterationsCadenceID!] Global iteration cadence IDs by which to look up the iterations.
search String Query used for fuzzy-searching in the fields selected in the argument in. Returns all iterations if empty.
sort IterationSort List iterations by sort order. If unspecified, an arbitrary order (subject to change) is used.
state IterationState Filter iterations by state.
timeframe Timeframe List items overlapping the given timeframe.
title {{< icon name=”warning-solid” >}} String Deprecated 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
Name Type Description
id JobID! ID of the job.
Project.jobs

Jobs of a project. This field can only be resolved for one project in any single request.

Returns CiJobConnection.

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

Arguments
Name Type Description
name {{< icon name=”warning-solid” >}} String Introduced in GitLab 17.11. Status: Experiment. Filter jobs by name.
sources {{< icon name=”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.
withArtifacts Boolean Filter by artifacts presence.
Project.label

Label available on the project.

Returns Label.

Arguments
Name Type Description
title String! Title of the label.
Project.labels

Labels available on this project.

Returns LabelConnection.

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

Arguments
Name Type Description
includeAncestorGroups Boolean Include labels from ancestor groups.
searchIn [LabelSearchFieldList!]! Specify which fields to search in. Ignored if using title.
searchTerm String Search term to find labels with.
title String Exact match on title. Cannot be used with searchTerm. searchIn will be ignored if title argument is provided.
Project.memberRoles

Member roles available for the group.

{{< details >}} Introduced in GitLab 16.5. Status: Experiment. {{< /details >}}

Returns MemberRoleConnection.

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

Arguments
Name Type Description
id MemberRoleID Global ID of the member role to look up.
ids [MemberRoleID!] Global IDs of the member role to look up.
orderBy MemberRolesOrderBy Ordering column. Default is NAME.
sort SortDirectionEnum Ordering column. Default is ASC.
Project.mergeRequest

A single merge request of the project.

Returns MergeRequest.

Arguments
Name Type Description
iid String! IID of the merge request, for example 1.
Project.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
Name Type Description
filters ComplianceViolationProjectInput Filters applied when retrieving compliance violations.
sort ComplianceViolationSort List 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
Name Type Description
approved Boolean Limit 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.
assigneeUsername String Username of the assignee.
assigneeUsernames [String!] Usernames of users assigned to the merge request.
assigneeWildcardId AssigneeWildcardId Filter by assignee presence. Incompatible with assigneeUsernames and assigneeUsername.
authorUsername String Username of the author.
blobPath {{< icon name=”warning-solid” >}} String Introduced 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.
createdAfter Time Merge requests created after the timestamp.
createdBefore Time Merge requests created before the timestamp.
deployedAfter Time Merge requests deployed after the timestamp.
deployedBefore Time Merge requests deployed before the timestamp.
deploymentId String ID of the deployment.
draft Boolean Limit result to draft merge requests.
environmentName String Environment merge requests have been deployed to.
ignoredReviewerUsername {{< icon name=”warning-solid” >}} String Introduced in GitLab 18.0. Status: Experiment. Username of the reviewer to ignore when searching by reviewer state.
iids [String!] Array of IIDs of merge requests, for example [1, 2].
in [IssuableSearchableField!] Specify the fields to perform the search in. Defaults to [TITLE, DESCRIPTION]. Requires the search argument.’.
labelName [String] Labels applied to the merge request.
labels {{< icon name=”warning-solid” >}} [String!] Deprecated in GitLab 17.1. Use labelName.
mergedAfter Time Merge requests merged after the date.
mergedBefore Time Merge requests merged before the date.
mergedBy String Username of the merger.
milestoneTitle String Title of the milestone. Incompatible with milestoneWildcardId.
milestoneWildcardId MilestoneWildcardId Filter issues by milestone ID wildcard. Incompatible with milestoneTitle.
myReactionEmoji String Filter by your reaction emoji.
not MergeRequestsResolverNegatedParams List of negated arguments. Warning: this argument is experimental and a subject to change in future.
or UnionedMergeRequestFilterInput List of arguments with inclusive OR.
releaseTag String Filter by release tag.
reviewState {{< icon name=”warning-solid” >}} MergeRequestReviewState Introduced in GitLab 17.0. Status: Experiment. Reviewer state of the merge request.
reviewStates {{< icon name=”warning-solid” >}} [MergeRequestReviewState!] Introduced in GitLab 17.0. Status: Experiment. Reviewer states of the merge request.
reviewerUsername String Username of the reviewer.
reviewerWildcardId ReviewerWildcardId Filter by reviewer presence. Incompatible with reviewerUsername.
search String Search query for title or description.
sort MergeRequestSort Sort merge requests by the criteria.
sourceBranches [String!] Array of source branch names. All resolved merge requests will have one of these branches as their source.
state MergeRequestState Merge request state. If provided, all resolved merge requests will have the state.
subscribed SubscriptionStatus Merge requests the current user is subscribed to.
targetBranches [String!] Array of target branch names. All resolved merge requests will have one of these branches as their target.
updatedAfter Time Merge requests updated after the timestamp.
updatedBefore Time Merge requests updated before the timestamp.
Project.mergeTrains

Merge trains available to the project.

{{< details >}} Introduced in GitLab 17.1. Status: Experiment. {{< /details >}}

Returns MergeTrainConnection.

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

Arguments
Name Type Description
status MergeTrainStatus Filter 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
Name Type Description
containingDate Time Date the milestone contains.
ids [ID!] Array of global milestone IDs, e.g., "gid://gitlab/Milestone/1".
includeAncestors Boolean Also return milestones in the project’s parent group and its ancestors.
searchTitle String Search string for the title.
sort MilestoneSort Sort milestones by the criteria.
state MilestoneStateEnum Filter milestones by state.
timeframe Timeframe List items overlapping the given timeframe.
title String Title 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
Name Type Description
name String Search for names that include the string.
orderBy MlModelsOrderBy Ordering column. Default is created_at.
sort SortDirectionEnum Ordering direction. Default is desc.
Project.mlModels

Finds machine learning models.

{{< details >}} Introduced in GitLab 16.8. Status: Experiment. {{< /details >}}

Returns MlModelConnection.

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

Arguments
Name Type Description
name String Search for names that include the string.
orderBy MlModelsOrderBy Ordering column. Default is created_at.
sort SortDirectionEnum Ordering 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
Name Type Description
name String Name of the environment.
search String Search query for environment name.
states [String!] States of environments that should be included in result.
type String Search query for environment type.

Logs attached to the project.

{{< details >}} Introduced in GitLab 17.4. Status: Experiment. {{< /details >}}

Returns ObservabilityLogConnection.

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

Arguments
Name Type Description
fingerprint String Fingerprint of the log.
serviceName String Service name of the log.
severityNumber Int Severity number of the log.
timestamp ISO8601DateTime Log timestamp of the log.
traceIdentifier String Trace id of the log.

Metrics attached to the project.

{{< details >}} Introduced in GitLab 17.4. Status: Experiment. {{< /details >}}

Returns ObservabilityMetricConnection.

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

Arguments
Name Type Description
name String Name of the metric.
type OpenTelemetryMetricType Type of the metric.

Traces attached to the project.

{{< details >}} Introduced in GitLab 17.4. Status: Experiment. {{< /details >}}

Returns ObservabilityTraceConnection.

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

Arguments
Name Type Description
traceIdentifier String Identifier 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
Name Type Description
includeVersionless Boolean Include versionless packages.
packageName String Search a package by name.
packageType PackageTypeEnum Filter a package by type.
packageVersion String Filter a package by version. If used in combination with include_versionless, then no versionless packages are returned.
sort PackageSort Sort packages by the criteria.
status PackageStatus Filter 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
Name Type Description
active Boolean Filter by active or inactive state.
sort Sort Sort results.
versioned Boolean Filter 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
Name Type Description
id CiPipelineID Global ID of the Pipeline. For example, “gid://gitlab/Ci::Pipeline/314”.
iid ID IID of the Pipeline. For example, “1”.
sha String SHA of the Pipeline. For example, “dyd0f15ay83993f5ab66k927w28673882x99100b”.
Project.pipelineAnalytics

Pipeline analytics.

Returns PipelineAnalytics.

Arguments
Name Type Description
fromTime {{< icon name=”warning-solid” >}} Time Introduced in GitLab 17.5. Status: Experiment. Start of the requested time (in UTC). Defaults to the pipelines started in the past week.
ref {{< icon name=”warning-solid” >}} String Introduced in GitLab 17.5. Status: Experiment. Branch that triggered the pipeline.
source {{< icon name=”warning-solid” >}} CiPipelineSources Introduced in GitLab 17.5. Status: Experiment. Source of the pipeline.
toTime {{< icon name=”warning-solid” >}} Time Introduced 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
Name Type Description
ref String Filter pipelines by the ref they are run for.
sha String Filter pipelines by the SHA of the commit they are run for.
source String Filter pipelines by their source.
Project.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
Name Type Description
includeUnscoped Boolean Filter policies that are scoped to the project.
relationship SecurityPolicyRelationType Filter policies by the given policy relationship. Default is DIRECT.
Project.pipelineExecutionSchedulePolicies

Pipeline Execution Schedule Policies of the namespace.

Returns PipelineExecutionSchedulePolicyConnection.

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

Arguments
Name Type Description
includeUnscoped Boolean Filter policies that are scoped to the project.
relationship SecurityPolicyRelationType Filter policies by the given policy relationship. Default is DIRECT.
Project.pipelineSchedules

Pipeline schedules of the project. This field can only be resolved for one project per request.

Returns PipelineScheduleConnection.

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

Arguments
Name Type Description
ids [ID!] Filter pipeline schedules by IDs.
sort PipelineScheduleSort List pipeline schedules by sort order. Default is id_desc.
status PipelineScheduleStatus Filter 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
Name Type Description
ref String Filter pipelines by the ref they are run for.
scope PipelineScopeEnum Filter pipelines by scope.
sha String Filter pipelines by the sha of the commit they are run for.
source String Filter pipelines by their source.
status PipelineStatusEnum Filter pipelines by their status.
updatedAfter Time Pipelines updated after the date.
updatedBefore Time Pipelines updated before the date.
username String Filter pipelines by the user that triggered the pipeline.
Project.productAnalyticsEventsStored

Count of all events used, broken down by month.

{{< details >}} Introduced in GitLab 16.7. Status: Experiment. {{< /details >}}

Returns [MonthlyUsage!].

Arguments
Name Type Description
monthSelection [MonthSelectionInput!]! Selection for the period to return.
Project.projectMembers

Members of the project.

Returns MemberInterfaceConnection.

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

Arguments
Name Type Description
relations [ProjectMemberRelation!] Filter members by the given member relations.
search String Search query.
sort MemberSort sort query.
Project.release

A single release of the project.

Returns Release.

Arguments
Name Type Description
tagName String! Name of the tag associated to the release.
Project.releases

Releases of the project.

Returns ReleaseConnection.

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

Arguments
Name Type Description
sort ReleaseSort Sort releases by given criteria.
Project.requirement

Find a single requirement.

Returns Requirement.

Arguments
Name Type Description
authorUsername [String!] Filter requirements by author username.
iid {{< icon name=”warning-solid” >}} ID Deprecated in GitLab 15.8. Use work_item_iid instead.
iids {{< icon name=”warning-solid” >}} [ID!] Deprecated in GitLab 15.8. Use work_item_iids instead.
lastTestReportState RequirementStatusFilter State of latest requirement test report.
search String Search query for requirement title.
sort Sort List requirements by sort order.
state RequirementState Filter requirements by state.
workItemIid ID IID of the requirement work item, for example, “1”.
workItemIids [ID!] List of IIDs of requirement work items, for example, [1, 2].
Project.requirements

Find requirements.

Returns RequirementConnection.

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

Arguments
Name Type Description
authorUsername [String!] Filter requirements by author username.
iid {{< icon name=”warning-solid” >}} ID Deprecated in GitLab 15.8. Use work_item_iid instead.
iids {{< icon name=”warning-solid” >}} [ID!] Deprecated in GitLab 15.8. Use work_item_iids instead.
lastTestReportState RequirementStatusFilter State of latest requirement test report.
search String Search query for requirement title.
sort Sort List requirements by sort order.
state RequirementState Filter requirements by state.
workItemIid ID IID of the requirement work item, for example, “1”.
workItemIids [ID!] List of IIDs of requirement work items, for example, [1, 2].
Project.runnerCloudProvisioning

Information used for provisioning the runner on a cloud provider. Returns null if the GitLab instance is not a SaaS instance.

{{< details >}} Introduced in GitLab 16.9. Status: Experiment. {{< /details >}}

Returns CiRunnerCloudProvisioning.

Arguments
Name Type Description
cloudProjectId GoogleCloudProject! Identifier of the cloud project.
provider CiRunnerCloudProvider! 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: In