The text is longer than 1048576 characters and has been visually truncated.
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.
WARNING: Fields that are deprecated are marked with {warning-solid}. Items (fields, enums, etc) that have been removed according to our deprecation process can be found in Removed Items.
Query
type
The Query
type contains the API's top-level entry points for all executable queries.
Query.abuseReport
Find an abuse report.
DETAILS: Introduced in GitLab 16.3. Status: Experiment.
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.
Returns LabelConnection
.
This field returns a connection. It accepts the
four standard pagination arguments:
before: String
, after: String
, first: Int
, and last: Int
.
Arguments
Name | Type | Description |
---|---|---|
searchTerm
|
String |
Search term to find labels with. |
Query.addOnPurchase
Retrieve the active add-on purchase. This query can be used in GitLab SaaS and self-managed environments.
DETAILS: Deprecated in GitLab 17.4. Use add_on_purchases instead.
Returns AddOnPurchase
.
Arguments
Name | Type | Description |
---|---|---|
addOnType
|
GitlabSubscriptionsAddOnType! |
Type of add-on for the add-on purchase. |
namespaceId
|
NamespaceID |
ID of namespace that the add-on was purchased for. |
Query.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.aiFeatureSettings
List of configurable AI features.
DETAILS: Introduced in GitLab 17.4. Status: Experiment.
Returns AiFeatureSettingConnection
.
This field returns a connection. It accepts the
four standard pagination arguments:
before: String
, after: String
, first: Int
, and last: Int
.
Arguments
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.
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. |
requestIds
|
[ID!] |
Array of request IDs to fetch. |
roles
|
[AiMessageRole!] |
Array of roles to fetch. |
Query.aiSelfHostedModels
List of self-hosted LLM servers.
DETAILS: Introduced in GitLab 17.1. Status: Experiment.
Returns AiSelfHostedModelConnection
.
This field returns a connection. It accepts the
four standard pagination arguments:
before: String
, after: String
, first: Int
, and last: Int
.
Query.aiSlashCommands
Get available 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.
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.
Returns BlobSearch
.
Arguments
Name | Type | Description |
---|---|---|
chunkCount {warning-solid}
|
Int |
Introduced in GitLab 17.2. Status: Experiment. Maximum chunks per file. |
groupId {warning-solid}
|
GroupID |
Introduced in GitLab 17.2. Status: Experiment. Group to search in. |
page {warning-solid}
|
Int |
Introduced in GitLab 17.2. Status: Experiment. Page number to fetch the results. |
perPage {warning-solid}
|
Int |
Introduced in GitLab 17.2. Status: Experiment. Number of results per page. |
projectId {warning-solid}
|
ProjectID |
Introduced in GitLab 17.2. Status: Experiment. Project to search in. |
regex {warning-solid}
|
Boolean |
Introduced in GitLab 17.3. Status: Experiment. Uses the regular expression search mode. Default is false. |
repositoryRef {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.
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.
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. |
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 {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.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.
DETAILS: Introduced in GitLab 16.4. Status: Experiment.
Returns QueueingDelayHistory
.
Arguments
Name | Type | Description |
---|---|---|
fromTime
|
Time |
Start of the requested time frame. Defaults to three hours ago. |
runnerType
|
CiRunnerType |
Filter jobs by the type of runner that executed them. |
toTime
|
Time |
End of the requested time frame. 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.
Returns CloudConnectorStatus
.
Query.containerRepository
Find a container repository.
Returns ContainerRepositoryDetails
.
Arguments
Name | Type | Description |
---|---|---|
id
|
ContainerRepositoryID! |
Global ID of the container repository. |
Query.currentLicense
Fields related to the current license.
Returns CurrentLicense
.
Query.currentUser
Get information about current user.
Returns CurrentUser
.
Query.designManagement
Fields related to design management.
Returns DesignManagement!
.
Query.devopsAdoptionEnabledNamespaces
Get configured DevOps adoption namespaces. 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.duoWorkflowEvents
List the events for a Duo Workflow.
DETAILS: Introduced in GitLab 17.2. Status: Experiment.
Returns DuoWorkflowEventConnection!
.
This field returns a connection. It accepts the
four standard pagination arguments:
before: String
, after: String
, first: Int
, and last: Int
.
Arguments
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.
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.
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.
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 |
---|---|---|
ids
|
[ID!] |
Filter groups by IDs. |
markedForDeletionOn
|
Date |
Date when the group was marked for deletion. |
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 . |
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.
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.
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 {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. |
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 {warning-solid}
|
SubscriptionStatus |
Introduced in GitLab 17.5. Status: Experiment. Issues the current user is subscribed to. Is ignored if filter_subscriptions feature flag is disabled. |
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 CiJobConnection
.
This field returns a connection. It accepts the
four standard pagination arguments:
before: String
, after: String
, first: Int
, and last: Int
.
Arguments
Name | Type | Description |
---|---|---|
failureReason {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 {warning-solid}
|
[CiRunnerType!] |
Introduced in GitLab 16.4. Status: Experiment. Filter jobs by runner type if feature flag :admin_jobs_filter_runner_type is enabled. |
statuses
|
[CiJobStatus!] |
Filter jobs by status. |
Query.licenseHistoryEntries
Fields related to entries in the license history.
Returns LicenseHistoryEntryConnection
.
This field returns a connection. It accepts the
four standard pagination arguments:
before: String
, after: String
, first: Int
, and last: Int
.
Query.memberRole
Finds a single custom role for the instance. Available only for self-managed.
DETAILS: Introduced in GitLab 16.6. Status: Experiment.
Returns MemberRole
.
Arguments
Name | Type | Description |
---|---|---|
id
|
MemberRoleID |
Global ID 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 customizable permissions.
DETAILS: Introduced in GitLab 16.4. Status: Experiment.
Returns CustomizablePermissionConnection
.
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 self-managed.
DETAILS: Introduced in GitLab 16.7. Status: Experiment.
Returns MemberRoleConnection
.
This field returns a connection. It accepts the
four standard pagination arguments:
before: String
, after: String
, first: Int
, and last: Int
.
Arguments
Name | Type | Description |
---|---|---|
id
|
MemberRoleID |
Global ID 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.mlModel
Find machine learning models.
DETAILS: Introduced in GitLab 16.7. Status: Experiment.
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.
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.
Returns Organization
.
Arguments
Name | Type | Description |
---|---|---|
id
|
OrganizationsOrganizationID! |
ID of the organization. |
Query.organizations
List organizations.
DETAILS: Introduced in GitLab 16.8. Status: Experiment.
Returns OrganizationConnection
.
This field returns a connection. It accepts the
four standard pagination arguments:
before: String
, after: String
, first: Int
, and last: Int
.
Query.package
Find a package. This field can only be resolved for one query in any single request. Returns null
if a package has no default
status.
Returns PackageDetailsType
.
Arguments
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.projectSecretsManager
Find a project secrets manager.
DETAILS: Introduced in GitLab 17.4. Status: Experiment.
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. |
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. |
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.
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.
Returns RunnerSetup
.
Arguments
Name | Type | Description |
---|---|---|
architecture
|
String! |
Architecture to generate the instructions for. |
groupId {warning-solid}
|
GroupID |
Deprecated in GitLab 13.11. No longer used. |
platform
|
String! |
Platform to generate the instructions for. |
projectId {warning-solid}
|
ProjectID |
Deprecated in GitLab 13.11. No longer used. |
Query.runnerUsage
Runner usage by runner.
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.
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 {warning-solid}
|
Boolean |
Deprecated in GitLab 14.8. This was renamed. Use: paused . |
creatorId
|
UserID |
Filter runners by creator ID. |
creatorUsername {warning-solid}
|
String |
Introduced in GitLab 16.7. Status: Experiment. Filter runners by creator username. |
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 {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.selfManagedAddOnEligibleUsers
Users within the self-managed instance who are eligible for add-ons.
DETAILS: Introduced in GitLab 16.7. Status: Experiment.
Returns AddOnUserConnection
.
This field returns a connection. It accepts the
four standard pagination arguments:
before: String
, after: String
, first: Int
, and last: Int
.
Arguments
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.
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 self-managed.
DETAILS: Introduced in GitLab 17.6. Status: Experiment.
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 self-managed.
DETAILS: Introduced in GitLab 17.3. Status: Experiment.
Returns StandardRoleConnection
.
This field returns a connection. It accepts the
four standard pagination arguments:
before: String
, after: String
, first: Int
, and last: Int
.
Arguments
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.
Returns Note
.
Arguments
Name | Type | Description |
---|---|---|
noteableId
|
NoteableID! |
Global ID of the resource to search synthetic note on. |
sha
|
String! |
Global ID of the note. |
Query.timelogs
Find timelogs visible to the current user.
Returns TimelogConnection
.
This field returns a connection. It accepts the
four standard pagination arguments:
before: String
, after: String
, first: Int
, and last: Int
.
Arguments
Name | Type | Description |
---|---|---|
endDate
|
Time |
List timelogs within a date range where the logged date is equal to or before endDate. |
endTime
|
Time |
List timelogs within a time range where the logged time is equal to or before endTime. |
groupId
|
GroupID |
List timelogs for a group. |
projectId
|
ProjectID |
List timelogs for a project. |
sort
|
TimelogSort |
List timelogs in a particular order. |
startDate
|
Time |
List timelogs within a date range where the logged date is equal to or after startDate. |
startTime
|
Time |
List timelogs within a time range where the logged time is equal to or after startTime. |
username
|
String |
List timelogs for a user. |
Query.todo
Retrieve a single to-do item.
Returns Todo
.
Arguments
Name | Type | Description |
---|---|---|
id
|
TodoID! |
ID of the to-do item. |
Query.topics
Find project topics.
Returns TopicConnection
.
This field returns a connection. It accepts the
four standard pagination arguments:
before: String
, after: String
, first: Int
, and last: Int
.
Arguments
Name | Type | Description |
---|---|---|
search
|
String |
Search query for topic name. |
Query.usageTrendsMeasurements
Get statistics on the instance.
Returns UsageTrendsMeasurementConnection
.
This field returns a connection. It accepts the
four standard pagination arguments:
before: String
, after: String
, first: Int
, and last: Int
.
Arguments
Name | Type | Description |
---|---|---|
identifier
|
MeasurementIdentifier! |
Type of measurement or statistics to retrieve. |
recordedAfter
|
Time |
Measurement recorded after 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 {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 {warning-solid}
|
String |
Introduced in GitLab 17.6. Status: Experiment. Filter vulnerabilities by identifier name. Applicable only on project level when feature flag vulnerability_filtering_by_identifier is enabled. Ignored when applied on group level or instance securitydashboard 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.
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.
Returns WorkItem
.
Arguments
Name | Type | Description |
---|---|---|
id
|
WorkItemID! |
Global ID of the work item. |
Query.workItemsByReference
Find work items by their reference.
DETAILS: Introduced in GitLab 16.7. Status: Experiment.
Returns WorkItemConnection
.
This field returns a connection. It accepts the
four standard pagination arguments:
before: String
, after: String
, first: Int
, and last: Int
.
Arguments
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 {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.
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.
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.
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.
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.
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.
Input type: AchievementsUpdateInput
Arguments
Name | Type | Description |
---|---|---|
achievementId
|
AchievementsAchievementID! |
Global ID of the achievement being updated. |
avatar
|
Upload |
Avatar for the achievement. |
clientMutationId
|
String |
A unique identifier for the client performing the mutation. |
description
|
String |
Description of or notes for the achievement. |
name
|
String |
Name for the achievement. |
Fields
Name | Type | Description |
---|---|---|
achievement
|
Achievement |
Achievement. |
clientMutationId
|
String |
A unique identifier for the client performing the mutation. |
errors
|
[String!]! |
Errors encountered during execution of the mutation. |
Mutation.addProjectToSecurityDashboard
Input type: AddProjectToSecurityDashboardInput
Arguments
Name | Type | Description |
---|---|---|
clientMutationId
|
String |
A unique identifier for the client performing the mutation. |
id
|
ProjectID! |
ID of the project to be added to Instance Security Dashboard. |
Fields
Name | Type | Description |
---|---|---|
clientMutationId
|
String |
A unique identifier for the client performing the mutation. |
errors
|
[String!]! |
Errors encountered during execution of the mutation. |
project
|
Project |
Project that was added to the Instance Security Dashboard. |
Mutation.adminSidekiqQueuesDeleteJobs
Input type: AdminSidekiqQueuesDeleteJobsInput
Arguments
Name | Type | Description |
---|---|---|
aiResource
|
String |
Delete jobs matching ai_resource in the context metadata. |
artifactSize
|
String |
Delete jobs matching artifact_size in the context metadata. |
artifactUsedCdn
|
String |
Delete jobs matching artifact_used_cdn in the context metadata. |
artifactsDependenciesCount
|
String |
Delete jobs matching artifacts_dependencies_count in the context metadata. |
artifactsDependenciesSize
|
String |
Delete jobs matching artifacts_dependencies_size in the context metadata. |
bulkImportEntityId
|
String |
Delete jobs matching bulk_import_entity_id in the context metadata. |
callerId
|
String |
Delete jobs matching caller_id in the context metadata. |
clientId
|
String |
Delete jobs matching client_id in the context metadata. |
clientMutationId
|
String |
A unique identifier for the client performing the mutation. |
featureCategory
|
String |
Delete jobs matching feature_category in the context metadata. |
jobId
|
String |
Delete jobs matching job_id in the context metadata. |
mergeActionStatus
|
String |
Delete jobs matching merge_action_status in the context metadata. |
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. |
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.
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. |
explainCode
|
AiExplainCodeInput |
Input for explain_code 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. |
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. |
Fields
Name | Type | Description |
---|---|---|
clientMutationId
|
String |
A unique identifier for the client performing the mutation. |
errors
|
[String!]! |
Errors encountered during execution of the mutation. |
requestId
|
String |
ID of the request. |
Mutation.aiAgentCreate
DETAILS: Introduced in GitLab 16.8. Status: Experiment.
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.
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.
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 create setting for the AI feature.
DETAILS: Introduced in GitLab 17.4. Status: Experiment.
Input type: AiFeatureSettingUpdateInput
Arguments
Name | Type | Description |
---|---|---|
aiSelfHostedModelId
|
AiSelfHostedModelID |
Global ID of the self-hosted model provide the AI setting. |
clientMutationId
|
String |
A unique identifier for the client performing the mutation. |
feature
|
AiFeatures! |
AI feature being configured. |
provider
|
AiFeatureProviders! |
Provider for AI setting. |
Fields
Name | Type | Description |
---|---|---|
aiFeatureSetting
|
AiFeatureSetting |
AI feature setting after mutation. |
clientMutationId
|
String |
A unique identifier for the client performing the mutation. |
errors
|
[String!]! |
Errors encountered during execution of the mutation. |
Mutation.aiSelfHostedModelCreate
DETAILS: Introduced in GitLab 17.1. Status: Experiment.
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.
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. |
selfHostedModel
|
AiSelfHostedModel |
Self-hosted model after mutation. |
Mutation.aiSelfHostedModelUpdate
Updates a self-hosted model.
DETAILS: Introduced in GitLab 17.2. Status: Experiment.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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. |
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.branchRuleApprovalProjectRuleCreate
DETAILS: Introduced in GitLab 16.10. Status: Experiment.
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.
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.
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.
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.
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.
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.branchRuleUpdate
DETAILS: Introduced in GitLab 16.7. Status: Experiment.
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.buildForecast
DETAILS: Introduced in GitLab 16.0. Status: Experiment.
Input type: BuildForecastInput
Arguments
Name | Type | Description |
---|---|---|
clientMutationId
|
String |
A unique identifier for the client performing the mutation. |
contextId
|
GlobalID! |
Global ID of the context for the forecast to pick an appropriate model. |
horizon
|
Int! |
Number of data points to forecast. |
type
|
String! |
Type of the forecast. |
Fields
Name | Type | Description |
---|---|---|
clientMutationId
|
String |
A unique identifier for the client performing the mutation. |
errors
|
[String!]! |
Errors encountered during execution of the mutation. |
forecast
|
Forecast! |
Created forecast. |
Mutation.bulkDestroyJobArtifacts
DETAILS: Introduced in GitLab 15.10. Status: Experiment.
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.
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.
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.
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. |
jobTokenPolicies {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 {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 {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 {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.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 {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 {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 {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.
Input type: CiJobTokenScopeUpdatePoliciesInput
Arguments
Name | Type | Description |
---|---|---|
clientMutationId
|
String |
A unique identifier for the client performing the mutation. |
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 {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.
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.
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. |
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.createContainerRegistryProtectionRule
Creates a protection rule to restrict access to a project's container registry. Available only when feature flag container_registry_protected_containers
is enabled.
DETAILS: Introduced in GitLab 16.6. Status: Experiment.
Input type: CreateContainerRegistryProtectionRuleInput
Arguments
Name | Type | Description |
---|---|---|
clientMutationId
|
String |
A unique identifier for the client performing the mutation. |
minimumAccessLevelForDelete
|
ContainerRegistryProtectionRuleAccessLevel |
Minimum GitLab access level to allow to delete container images from the container registry. For example, MAINTAINER , OWNER , or ADMIN . If the value is nil , the minimum access level for delete is ignored. Users with at least the Developer role are allowed to delete container images. Introduced in GitLab 16.6: Status: Experiment. |
minimumAccessLevelForPush
|
ContainerRegistryProtectionRuleAccessLevel |
Minimum GitLab access level to allow to push container images to the container registry. For example, MAINTAINER , OWNER , or ADMIN . If the value is nil , the minimum access level for push is ignored. Users with at least the Developer role are allowed to push container images. Introduced in GitLab 16.6: Status: Experiment. |
projectPath
|
ID! |
Full path of the project where a protection rule is located. |
repositoryPathPattern
|
String! |
Container repository path pattern protected by the protection rule. For example, my-project/my-container-* . Wildcard character * allowed. Introduced in GitLab 16.6: Status: Experiment. |
Fields
Name | Type | Description |
---|---|---|
clientMutationId
|
String |
A unique identifier for the client performing the mutation. |
containerRegistryProtectionRule {warning-solid}
|
ContainerRegistryProtectionRule |
Deprecated: Status: Experiment. Introduced in GitLab 16.6. |
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.
Input type: CreateEpicInput
Arguments
Name | Type | Description |
---|---|---|
addLabelIds
|
[ID!] |
IDs of labels to be added to the epic. |
addLabels
|
[String!] |
Array of labels to be added to the epic. |
clientMutationId
|
String |
A unique identifier for the client performing the mutation. |
color
|
Color |
Color of the epic. Available only when feature flag epic_color_highlight is enabled. This flag is disabled by default, because the feature is experimental and is subject to change without notice. |
confidential
|
Boolean |
Indicates if the epic is confidential. |
description
|
String |
Description of the epic. |
dueDateFixed
|
String |
End date of the epic. |
dueDateIsFixed
|
Boolean |
Indicates end date should be sourced from due_date_fixed field not the issue milestones. |
groupPath
|
ID! |
Group the epic to mutate is in. |
removeLabelIds
|
[ID!] |
IDs of labels to be removed from the epic. |
startDateFixed
|
String |
Start date of the epic. |
startDateIsFixed
|
Boolean |
Indicates start date should be sourced from start_date_fixed field not the issue milestones. |
title
|
String |
Title of the epic. |
Fields
Name | Type | Description |
---|---|---|
clientMutationId
|
String |
A unique identifier for the client performing the mutation. |
epic
|
Epic |
Created epic. |
errors
|
[String!]! |
Errors encountered during execution of the mutation. |
Mutation.createImageDiffNote
Input type: CreateImageDiffNoteInput
Arguments
Name | Type | Description |
---|---|---|
body
|
String! |
Content of the note. |
clientMutationId
|
String |
A unique identifier for the client performing the mutation. |
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 {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.
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.
DETAILS: Introduced in GitLab 16.5. Status: Experiment.
Input type: CreatePackagesProtectionRuleInput
Arguments
Name | Type | Description |
---|---|---|
clientMutationId
|
String |
A unique identifier for the client performing the mutation. |
minimumAccessLevelForPush
|
PackagesProtectionRuleAccessLevel! |
Minimum GitLab access required to push packages to the package registry. For example, MAINTAINER , OWNER , or ADMIN . Introduced in GitLab 16.5: Status: Experiment. |
packageNamePattern
|
String! |
Package name protected by the protection rule. For example @my-scope/my-package-* . Wildcard character * allowed. |
packageType
|
PackagesProtectionRulePackageType! |
Package type protected by the protection rule. For example NPM . |
projectPath
|
ID! |
Full path of the project where a protection rule is located. |
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 {warning-solid}
|
PackagesProtectionRule |
Deprecated: Status: Experiment. Introduced in GitLab 16.5. |
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.customFieldCreate
DETAILS: Introduced in GitLab 17.6. Status: Experiment.
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. |
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.customFieldUpdate
DETAILS: Introduced in GitLab 17.6. Status: Experiment.
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. |
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 {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 {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 {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 {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 {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 {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 {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 {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. |
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 {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 {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 {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. |
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 {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.
Input type: DeleteAnnotationInput
Arguments
Name | Type | Description |
---|---|---|
clientMutationId
|
String |
A unique identifier for the client performing the mutation. |
id
|
String! |
Global ID of the annotation to delete. |
Fields
Name | Type | Description |
---|---|---|
clientMutationId
|
String |
A unique identifier for the client performing the mutation. |
errors
|
[String!]! |
Errors encountered during execution of the mutation. |
Mutation.deleteContainerRegistryProtectionRule
Deletes a container registry protection rule. Available only when feature flag container_registry_protected_containers
is enabled.
DETAILS: Introduced in GitLab 16.7. Status: Experiment.
Input type: DeleteContainerRegistryProtectionRuleInput
Arguments
Name | Type | Description |
---|---|---|
clientMutationId
|
String |
A unique identifier for the client performing the mutation. |
id
|
ContainerRegistryProtectionRuleID! |
Global ID of the container registry protection rule to delete. |
Fields
Name | Type | Description |
---|---|---|
clientMutationId
|
String |
A unique identifier for the client performing the mutation. |
containerRegistryProtectionRule {warning-solid}
|
ContainerRegistryProtectionRule |
Deprecated: Status: Experiment. Introduced in GitLab 16.7. |
errors
|
[String!]! |
Errors encountered during execution of the mutation. |
Mutation.deletePackagesProtectionRule
Deletes a protection rule for packages.
DETAILS: Introduced in GitLab 16.6. Status: Experiment.
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 {warning-solid}
|
PackagesProtectionRule |
Deprecated: Status: Experiment. Introduced in GitLab 16.6. |
Mutation.deletePagesDeployment
Deletes a Pages deployment.
DETAILS: Introduced in GitLab 17.1. Status: Experiment.
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.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.
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 20. |
Fields
Name | Type | Description |
---|---|---|
clientMutationId
|
String |
A unique identifier for the client performing the mutation. |
errors
|
[String!]! |
Errors encountered during execution of the mutation. |
Mutation.destroySnippet
Input type: DestroySnippetInput
Arguments
Name | Type | Description |
---|---|---|
clientMutationId
|
String |
A unique identifier for the client performing the mutation. |
id
|
SnippetID! |
Global ID of the snippet to destroy. |
Fields
Name | Type | Description |
---|---|---|
clientMutationId
|
String |
A unique identifier for the client performing the mutation. |
errors
|
[String!]! |
Errors encountered during execution of the mutation. |
snippet
|
Snippet |
Snippet after mutation. |
Mutation.disableDevopsAdoptionNamespace
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.duoUserFeedback
DETAILS: Introduced in GitLab 16.10. Status: Experiment.
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 |
---|---|---|
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 |
---|---|---|
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.
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.
Input type: EpicBoardCreateInput
Arguments
Name | Type | Description |
---|---|---|
clientMutationId
|
String |
A unique identifier for the client performing the mutation. |
displayColors
|
Boolean |
Whether or not display epic colors. Ignored unless epic_color_highlight flag is enabled. |
groupPath
|
ID |
Full path of the group with which the resource is associated. |
hideBacklogList
|
Boolean |
Whether or not backlog list is hidden. |
hideClosedList
|
Boolean |
Whether or not closed list is hidden. |
labelIds
|
[LabelID!] |
IDs of labels to be added to the board. |
labels
|
[String!] |
Labels of the issue. |
name
|
String |
Board name. |
Fields
Name | Type | Description |
---|---|---|
clientMutationId
|
String |
A unique identifier for the client performing the mutation. |
epicBoard
|
EpicBoard |
Created epic board. |
errors
|
[String!]! |
Errors encountered during execution of the mutation. |
Mutation.epicBoardListCreate
DETAILS: Deprecated in GitLab 17.5. Replaced by WorkItem type.
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.
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.
Input type: EpicBoardUpdateInput
Arguments
Name | Type | Description |
---|---|---|
clientMutationId
|
String |
A unique identifier for the client performing the mutation. |
displayColors
|
Boolean |
Whether or not display epic colors. Ignored unless epic_color_highlight flag is enabled. |
hideBacklogList
|
Boolean |
Whether or not backlog list is hidden. |
hideClosedList
|
Boolean |
Whether or not closed list is hidden. |
id
|
BoardsEpicBoardID! |
Epic board global ID. |
labelIds
|
[LabelID!] |
IDs of labels to be added to the board. |
labels
|
[String!] |
Labels of the issue. |
name
|
String |
Board name. |
Fields
Name | Type | Description |
---|---|---|
clientMutationId
|
String |
A unique identifier for the client performing the mutation. |
epicBoard
|
EpicBoard |
Updated epic board. |
errors
|
[String!]! |
Errors encountered during execution of the mutation. |
Mutation.epicMoveList
DETAILS: Deprecated in GitLab 17.5. Replaced by WorkItem type.
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.
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.
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.
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.
Input type: GeoRegistriesUpdateInput
Arguments
Name | Type | Description |
---|---|---|
action
|
GeoRegistryAction! |
Action to be executed on a Geo registry. |
clientMutationId
|
String |
A unique identifier for the client performing the mutation. |
registryClass
|
GeoRegistryClass |
Class of the Geo registry to be updated. |
registryId
|
GeoBaseRegistryID! |
ID of the Geo registry entry to be updated. |
Fields
Name | Type | Description |
---|---|---|
clientMutationId
|
String |
A unique identifier for the client performing the mutation. |
errors
|
[String!]! |
Errors encountered during execution of the mutation. |
registry
|
Registrable |
Updated Geo registry entry. |
Mutation.gitlabSubscriptionActivate
Input type: GitlabSubscriptionActivateInput
Arguments
Name | Type | Description |
---|---|---|
activationCode
|
String! |
Activation code received after purchasing a GitLab subscription. |
clientMutationId
|
String |
A unique identifier for the client performing the mutation. |
Fields
Name | Type | Description |
---|---|---|
clientMutationId
|
String |
A unique identifier for the client performing the mutation. |
errors
|
[String!]! |
Errors encountered during execution of the mutation. |
futureSubscriptions
|
[SubscriptionFutureEntry!] |
Array of future subscriptions. |
license
|
CurrentLicense |
Current license. |
Mutation.googleCloudLoggingConfigurationCreate
Input type: GoogleCloudLoggingConfigurationCreateInput
Arguments
Name | Type | Description |
---|---|---|
clientEmail
|
String! |
Email address associated with the service account that will be used to authenticate and interact with the Google Cloud Logging service. This is part of the IAM credentials. |
clientMutationId
|
String |
A unique identifier for the client performing the mutation. |
googleProjectIdName
|
String! |
Unique identifier of the Google Cloud project to which the logging configuration belongs. |
groupPath
|
ID! |
Group path. |
logIdName
|
String |
Unique identifier used to distinguish and manage different logs within the same Google Cloud project.(defaults to audit_events ). |
name
|
String |
Destination name. |
privateKey
|
String! |
Private Key associated with the service account. This key is used to authenticate the service account and authorize it to interact with the Google Cloud Logging service. |
Fields
Name | Type | Description |
---|---|---|
clientMutationId
|
String |
A unique identifier for the client performing the mutation. |
errors
|
[String!]! |
Errors encountered during execution of the mutation. |
googleCloudLoggingConfiguration
|
GoogleCloudLoggingConfigurationType |
configuration created. |
Mutation.googleCloudLoggingConfigurationDestroy
Input type: GoogleCloudLoggingConfigurationDestroyInput
Arguments
Name | Type | Description |
---|---|---|
clientMutationId
|
String |
A unique identifier for the client performing the mutation. |
id
|
AuditEventsGoogleCloudLoggingConfigurationID! |
ID of the Google Cloud logging configuration to destroy. |
Fields
Name | Type | Description |
---|---|---|
clientMutationId
|
String |
A unique identifier for the client performing the mutation. |
errors
|
[String!]! |
Errors encountered during execution of the mutation. |
Mutation.googleCloudLoggingConfigurationUpdate
Input type: GoogleCloudLoggingConfigurationUpdateInput
Arguments
Name | Type | Description |
---|---|---|
clientEmail
|
String |
Email address associated with the service account that will be used to authenticate and interact with the Google Cloud Logging service. This is part of the IAM credentials. |
clientMutationId
|
String |
A unique identifier for the client performing the mutation. |
googleProjectIdName
|
String |
Unique identifier of the Google Cloud project to which the logging configuration belongs. |
id
|
AuditEventsGoogleCloudLoggingConfigurationID! |
ID of the google Cloud configuration to update. |
logIdName
|
String |
Unique identifier used to distinguish and manage different logs within the same Google Cloud project. |
name
|
String |
Destination name. |
privateKey
|
String |
Private Key associated with the service account. This key is used to authenticate the service account and authorize it to interact with the Google Cloud Logging service. |
Fields
Name | Type | Description |
---|---|---|
clientMutationId
|
String |
A unique identifier for the client performing the mutation. |
errors
|
[String!]! |
Errors encountered during execution of the mutation. |
googleCloudLoggingConfiguration
|
GoogleCloudLoggingConfigurationType |
configuration updated. |
Mutation.groupAuditEventStreamingDestinationsCreate
DETAILS: Introduced in GitLab 16.11. Status: Experiment.
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.
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.
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.
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.
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.
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.
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 this group. |
name
|
String |
Name of the namespace. |
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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 {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.
Input type: IssueSetEpicInput
Arguments
Name | Type | Description |
---|---|---|
clientMutationId
|
String |
A unique identifier for the client performing the mutation. |
epicId {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.
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 {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 this cadence. |
groupPath
|
ID! |
Group where the iteration cadence is created. |
iterationsInAdvance
|
Int |
Upcoming iterations to be created when iteration cadence is set to automatic. |
rollOver
|
Boolean |
Whether the iteration cadence should roll over issues to the next iteration or not. |
startDate
|
Time |
Timestamp of the automation start date. |
title
|
String |
Title of the iteration cadence. |
Fields
Name | Type | Description |
---|---|---|
clientMutationId
|
String |
A unique identifier for the client performing the mutation. |
errors
|
[String!]! |
Errors encountered during execution of the mutation. |
iterationCadence
|
IterationCadence |
Created iteration cadence. |
Mutation.iterationCadenceDestroy
Input type: IterationCadenceDestroyInput
Arguments
Name | Type | Description |
---|---|---|
clientMutationId
|
String |
A unique identifier for the client performing the mutation. |
id
|
IterationsCadenceID! |
Global ID of the iteration cadence. |
Fields
Name | Type | Description |
---|---|---|
clientMutationId
|
String |
A unique identifier for the client performing the mutation. |
errors
|
[String!]! |
Errors encountered during execution of the mutation. |
group
|
Group! |
Group the iteration cadence belongs to. |
Mutation.iterationCadenceUpdate
Input type: IterationCadenceUpdateInput
Arguments
Name | Type | Description |
---|---|---|
active
|
Boolean |
Whether the iteration cadence is active. |
automatic
|
Boolean |
Whether the iteration cadence should automatically generate upcoming iterations. |
clientMutationId
|
String |
A unique identifier for the client performing the mutation. |
description
|
String |
Description of the iteration cadence. Maximum length is 5000 characters. |
durationInWeeks
|
Int |
Duration in weeks of the iterations within this cadence. |
id
|
IterationsCadenceID! |
Global ID of the iteration cadence. |
iterationsInAdvance
|
Int |
Upcoming iterations to be created when iteration cadence is set to automatic. |
rollOver
|
Boolean |
Whether the iteration cadence should roll over issues to the next iteration or not. |
startDate
|
Time |
Timestamp of the automation start date. |
title
|
String |
Title of the iteration cadence. |
Fields
Name | Type | Description |
---|---|---|
clientMutationId
|
String |
A unique identifier for the client performing the mutation. |
errors
|
[String!]! |
Errors encountered during execution of the mutation. |
iterationCadence
|
IterationCadence |
Updated iteration cadence. |
Mutation.iterationCreate
Input type: iterationCreateInput
Arguments
Name | Type | Description |
---|---|---|
clientMutationId
|
String |
A unique identifier for the client performing the mutation. |
description
|
String |
Description of the iteration. |
dueDate
|
String |
End date of the iteration. |
groupPath
|
ID |
Full path of the group with which the resource is associated. |
iterationsCadenceId
|
IterationsCadenceID |
Global ID of the iteration cadence to be assigned to the new iteration. |
projectPath
|
ID |
Full path of the project with which the resource is associated. |
startDate
|
String |
Start date of the iteration. |
title
|
String |
Title of the iteration. |
Fields
Name | Type | Description |
---|---|---|
clientMutationId
|
String |
A unique identifier for the client performing the mutation. |
errors
|
[String!]! |
Errors encountered during execution of the mutation. |
iteration
|
Iteration |
Created iteration. |
Mutation.iterationDelete
Input type: IterationDeleteInput
Arguments
Name | Type | Description |
---|---|---|
clientMutationId
|
String |
A unique identifier for the client performing the mutation. |
id
|
IterationID! |
ID of the iteration. |
Fields
Name | Type | Description |
---|---|---|
clientMutationId
|
String |
A unique identifier for the client performing the mutation. |
errors
|
[String!]! |
Errors encountered during execution of the mutation. |
group
|
Group! |
Group the iteration belongs to. |
Mutation.jiraImportStart
Input type: JiraImportStartInput
Arguments
Name | Type | Description |
---|---|---|
clientMutationId
|
String |
A unique identifier for the client performing the mutation. |
jiraProjectKey
|
String! |
Project key of the importer Jira project. |
jiraProjectName {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.markAsSpamSnippet
Input type: MarkAsSpamSnippetInput
Arguments
Name | Type | Description |
---|---|---|
clientMutationId
|
String |
A unique identifier for the client performing the mutation. |
id
|
SnippetID! |
Global ID of the snippet to update. |
Fields
Name | Type | Description |
---|---|---|
clientMutationId
|
String |
A unique identifier for the client performing the mutation. |
errors
|
[String!]! |
Errors encountered during execution of the mutation. |
snippet
|
Snippet |
Snippet after mutation. |
Mutation.memberRoleCreate
DETAILS: Introduced in GitLab 16.5. Status: Experiment.
Input type: MemberRoleCreateInput
Arguments
Name | Type | Description |
---|---|---|
baseAccessLevel
|
MemberAccessLevel! |
Base access level for the custom role. |
clientMutationId
|
String |
A unique identifier for the client performing the mutation. |
description
|
String |
Description of the member role. |
groupPath
|
ID |
Group the member role to mutate is in. Required for SaaS. |
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 |
Updated member role. |
Mutation.memberRoleDelete
DETAILS: Introduced in GitLab 16.7. Status: Experiment.
Input type: MemberRoleDeleteInput
Arguments
Name | Type | Description |
---|---|---|
clientMutationId
|
String |
A unique identifier for the client performing the mutation. |
id
|
MemberRoleID! |
ID of the member role to delete. |
Fields
Name | Type | Description |
---|---|---|
clientMutationId
|
String |
A unique identifier for the client performing the mutation. |
errors
|
[String!]! |
Errors encountered during execution of the mutation. |
memberRole
|
MemberRole |
Deleted member role. |
Mutation.memberRoleUpdate
Input type: MemberRoleUpdateInput
Arguments
Name | Type | Description |
---|---|---|
clientMutationId
|
String |
A unique identifier for the client performing the mutation. |
description
|
String |
Description of the member role. |
id
|
MemberRoleID! |
ID of the member role to mutate. |
name
|
String |
Name of the member role. |
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 |
Updated member role. |
Mutation.mergeRequestAccept
Accepts a merge request. When accepted, the source branch will be scheduled to merge into the target branch, either immediately if possible, or using one of the automatic merge strategies.
In GitLab 16.5, the merging happens asynchronously.
This results in mergeRequest
and state
not updating after a mutation request,
because the merging may not have happened yet.
Input type: MergeRequestAcceptInput
Arguments
Name | Type | Description |
---|---|---|
clientMutationId
|
String |
A unique identifier for the client performing the mutation. |
commitMessage
|
String |
Custom merge commit message. |
iid
|
String! |
IID of the merge request to mutate. |
projectPath
|
ID! |
Project the merge request to mutate is in. |
sha
|
String! |
HEAD SHA at the time when the merge was requested. |
shouldRemoveSourceBranch
|
Boolean |
Should the source branch be removed. |
squash
|
Boolean |
Squash commits on the source branch before merge. |
squashCommitMessage
|
String |
Custom squash commit message (if squash is true). |
strategy
|
MergeStrategyEnum |
How to merge the merge request. |
Fields
Name | Type | Description |
---|---|---|
clientMutationId
|
String |
A unique identifier for the client performing the mutation. |
errors
|
[String!]! |
Errors encountered during execution of the mutation. |
mergeRequest
|
MergeRequest |
Merge request after mutation. |
Mutation.mergeRequestCreate
Input type: MergeRequestCreateInput
Arguments
Name | Type | Description |
---|---|---|
clientMutationId
|
String |
A unique identifier for the client performing the mutation. |
description
|
String |
Description of the merge request (Markdown rendered as HTML for caching). |
labels
|
[String!] |
Labels of the merge request. |
projectPath
|
ID! |
Project full path the merge request is associated with. |
sourceBranch
|
String! |
Source branch of the merge request. |
targetBranch
|
String! |
Target branch of the merge request. |
title
|
String! |
Title of the merge request. |
Fields
Name | Type | Description |
---|---|---|
clientMutationId
|
String |
A unique identifier for the client performing the mutation. |
errors
|
[String!]! |
Errors encountered during execution of the mutation. |
mergeRequest
|
MergeRequest |
Merge request after mutation. |
Mutation.mergeRequestReviewerRereview
Input type: MergeRequestReviewerRereviewInput
Arguments
Name | Type | Description |
---|---|---|
clientMutationId
|
String |
A unique identifier for the client performing the mutation. |
iid
|
String! |
IID of the merge request to mutate. |
projectPath
|
ID! |
Project the merge request to mutate is in. |
userId
|
UserID! |
User ID for the user that has been requested for a new review. |
Fields
Name | Type | Description |
---|---|---|
clientMutationId
|
String |
A unique identifier for the client performing the mutation. |
errors
|
[String!]! |
Errors encountered during execution of the mutation. |
mergeRequest
|
MergeRequest |
Merge request after mutation. |
Mutation.mergeRequestSetAssignees
Input type: MergeRequestSetAssigneesInput
Arguments
Name | Type | Description |
---|---|---|
assigneeUsernames
|
[String!]! |
Usernames to assign to the resource. Replaces existing assignees by default. |
clientMutationId
|
String |
A unique identifier for the client performing the mutation. |
iid
|
String! |
IID of the merge request to mutate. |
operationMode
|
MutationOperationMode |
Operation to perform. Defaults to REPLACE. |
projectPath
|
ID! |
Project the merge request to mutate is in. |
Fields
Name | Type | Description |
---|---|---|
clientMutationId
|
String |
A unique identifier for the client performing the mutation. |
errors
|
[String!]! |
Errors encountered during execution of the mutation. |
mergeRequest
|
MergeRequest |
Merge request after mutation. |
Mutation.mergeRequestSetDraft
Input type: MergeRequestSetDraftInput
Arguments
Name | Type | Description |
---|---|---|
clientMutationId
|
String |
A unique identifier for the client performing the mutation. |
draft
|
Boolean! |
Whether or not to set the merge request as a draft. |
iid
|
String! |
IID of the merge request to mutate. |
projectPath
|
ID! |
Project the merge request to mutate is in. |
Fields
Name | Type | Description |
---|---|---|
clientMutationId
|
String |
A unique identifier for the client performing the mutation. |
errors
|
[String!]! |
Errors encountered during execution of the mutation. |
mergeRequest
|
MergeRequest |
Merge request after mutation. |
Mutation.mergeRequestSetLabels
Input type: MergeRequestSetLabelsInput
Arguments
Name | Type | Description |
---|---|---|
clientMutationId
|
String |
A unique identifier for the client performing the mutation. |
iid
|
String! |
IID of the merge request to mutate. |
labelIds
|
[LabelID!]! |
Label IDs to set. Replaces existing labels by default. |
operationMode
|
MutationOperationMode |
Changes the operation mode. Defaults to REPLACE. |
projectPath
|
ID! |
Project the merge request to mutate is in. |
Fields
Name | Type | Description |
---|---|---|
clientMutationId
|
String |
A unique identifier for the client performing the mutation. |
errors
|
[String!]! |
Errors encountered during execution of the mutation. |
mergeRequest
|
MergeRequest |
Merge request after mutation. |
Mutation.mergeRequestSetLocked
Input type: MergeRequestSetLockedInput
Arguments
Name | Type | Description |
---|---|---|
clientMutationId
|
String |
A unique identifier for the client performing the mutation. |
iid
|
String! |
IID of the merge request to mutate. |
locked
|
Boolean! |
Whether or not to lock the merge request. |
projectPath
|
ID! |
Project the merge request to mutate is in. |
Fields
Name | Type | Description |
---|---|---|
clientMutationId
|
String |
A unique identifier for the client performing the mutation. |
errors
|
[String!]! |
Errors encountered during execution of the mutation. |
mergeRequest
|
MergeRequest |
Merge request after mutation. |
Mutation.mergeRequestSetMilestone
Input type: MergeRequestSetMilestoneInput
Arguments
Name | Type | Description |
---|---|---|
clientMutationId
|
String |
A unique identifier for the client performing the mutation. |
iid
|
String! |
IID of the merge request to mutate. |
milestoneId
|
MilestoneID |
Milestone to assign to the merge request. |
projectPath
|
ID! |
Project the merge request to mutate is in. |
Fields
Name | Type | Description |
---|---|---|
clientMutationId
|
String |
A unique identifier for the client performing the mutation. |
errors
|
[String!]! |
Errors encountered during execution of the mutation. |
mergeRequest
|
MergeRequest |
Merge request after mutation. |
Mutation.mergeRequestSetReviewers
Input type: MergeRequestSetReviewersInput
Arguments
Name | Type | Description |
---|---|---|
clientMutationId
|
String |
A unique identifier for the client performing the mutation. |
iid
|
String! |
IID of the merge request to mutate. |
operationMode
|
MutationOperationMode |
Operation to perform. Defaults to REPLACE. |
projectPath
|
ID! |
Project the merge request to mutate is in. |
reviewerUsernames
|
[String!]! |
Usernames of reviewers to assign. Replaces existing reviewers by default. |
Fields
Name | Type | Description |
---|---|---|
clientMutationId
|
String |
A unique identifier for the client performing the mutation. |
errors
|
[String!]! |
Errors encountered during execution of the mutation. |
mergeRequest
|
MergeRequest |
Merge request after mutation. |
Mutation.mergeRequestSetSubscription
Input type: MergeRequestSetSubscriptionInput
Arguments
Name | Type | Description |
---|---|---|
clientMutationId
|
String |
A unique identifier for the client performing the mutation. |
iid
|
String! |
IID of the merge request to mutate. |
projectPath
|
ID! |
Project the merge request to mutate is in. |
subscribedState
|
Boolean! |
Desired state of the subscription. |
Fields
Name | Type | Description |
---|---|---|
clientMutationId
|
String |
A unique identifier for the client performing the mutation. |
errors
|
[String!]! |
Errors encountered during execution of the mutation. |
mergeRequest
|
MergeRequest |
Merge request after mutation. |
Mutation.mergeRequestUpdate
Update attributes of a merge request.
Input type: MergeRequestUpdateInput
Arguments
Name | Type | Description |
---|---|---|
clientMutationId
|
String |
A unique identifier for the client performing the mutation. |
description
|
String |
Description of the merge request (Markdown rendered as HTML for caching). |
iid
|
String! |
IID of the merge request to mutate. |
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.
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.
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.
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.
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.
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.
Input type: MlModelVersionCreateInput
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.mlModelVersionDelete
DETAILS: Introduced in GitLab 17.0. Status: Experiment.
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.
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 this namespace should be periodically pruned. |
clientMutationId
|
String |
A unique identifier for the client performing the mutation. |
fullPath
|
ID! |
Full path of the namespace the settings belong to. |
Fields
Name | Type | Description |
---|---|---|
ciCdSettings
|
NamespaceCiCdSetting! |
CI/CD settings after mutation. |
clientMutationId
|
String |
A unique identifier for the client performing the mutation. |
errors
|
[String!]! |
Errors encountered during execution of the mutation. |
Mutation.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. |
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. |
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.
Input type: OrganizationCreateInput
Arguments
Name | Type | Description |
---|---|---|
avatar
|
Upload |
Avatar for the organization. |
clientMutationId
|
String |
A unique identifier for the client performing the mutation. |
description
|
String |
Description of the organization. |
name
|
String! |
Name for the organization. |
path
|
String! |
Path for the organization. |
Fields
Name | Type | Description |
---|---|---|
clientMutationId
|
String |
A unique identifier for the client performing the mutation. |
errors
|
[String!]! |
Errors encountered during execution of the mutation. |
organization
|
Organization |
Organization after mutation. |
Mutation.organizationUpdate
DETAILS: Introduced in GitLab 16.7. Status: Experiment.
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.
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 {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.pipelineDestroy
Input type: PipelineDestroyInput
Arguments
Name | Type | Description |
---|---|---|
clientMutationId
|
String |
A unique identifier for the client performing the mutation. |
id
|
CiPipelineID! |
ID of the pipeline to mutate. |
Fields
Name | Type | Description |
---|---|---|
clientMutationId
|
String |
A unique identifier for the client performing the mutation. |
errors
|
[String!]! |
Errors encountered during execution of the mutation. |
Mutation.pipelineRetry
Input type: PipelineRetryInput
Arguments
Name | Type | Description |
---|---|---|
clientMutationId
|
String |
A unique identifier for the client performing the mutation. |
id
|
CiPipelineID! |
ID of the pipeline to mutate. |
Fields
Name | Type | Description |
---|---|---|
clientMutationId
|
String |
A unique identifier for the client performing the mutation. |
errors
|
[String!]! |
Errors encountered during execution of the mutation. |
pipeline
|
Pipeline |
Pipeline after mutation. |
Mutation.pipelineScheduleCreate
Input type: PipelineScheduleCreateInput
Arguments
Name | Type | Description |
---|---|---|
active
|
Boolean |
Indicates if the pipeline schedule should be active or not. |
clientMutationId
|
String |
A unique identifier for the client performing the mutation. |
cron
|
String! |
Cron expression of the pipeline schedule. |
cronTimezone
|
String |
Cron time zone supported by ActiveSupport::TimeZone. For example: "Pacific Time (US & Canada)" (default: "UTC"). |
description
|
String! |
Description of the pipeline schedule. |
projectPath
|
ID! |
Full path of the project the pipeline schedule is associated with. |
ref
|
String! |
Ref of the pipeline schedule. |
variables
|
[PipelineScheduleVariableInput!] |
Variables for the pipeline schedule. |
Fields
Name | Type | Description |
---|---|---|
clientMutationId
|
String |
A unique identifier for the client performing the mutation. |
errors
|
[String!]! |
Errors encountered during execution of the mutation. |
pipelineSchedule
|
PipelineSchedule |
Created pipeline schedule. |
Mutation.pipelineScheduleDelete
Input type: PipelineScheduleDeleteInput
Arguments
Name | Type | Description |
---|---|---|
clientMutationId
|
String |
A unique identifier for the client performing the mutation. |
id
|
CiPipelineScheduleID! |
ID of the pipeline schedule to mutate. |
Fields
Name | Type | Description |
---|---|---|
clientMutationId
|
String |
A unique identifier for the client performing the mutation. |
errors
|
[String!]! |
Errors encountered during execution of the mutation. |
Mutation.pipelineSchedulePlay
Input type: PipelineSchedulePlayInput
Arguments
Name | Type | Description |
---|---|---|
clientMutationId
|
String |
A unique identifier for the client performing the mutation. |
id
|
CiPipelineScheduleID! |
ID of the pipeline schedule to mutate. |
Fields
Name | Type | Description |
---|---|---|
clientMutationId
|
String |
A unique identifier for the client performing the mutation. |
errors
|
[String!]! |
Errors encountered during execution of the mutation. |
pipelineSchedule
|
PipelineSchedule |
Pipeline schedule after mutation. |
Mutation.pipelineScheduleTakeOwnership
Input type: PipelineScheduleTakeOwnershipInput
Arguments
Name | Type | Description |
---|---|---|
clientMutationId
|
String |
A unique identifier for the client performing the mutation. |
id
|
CiPipelineScheduleID! |
ID of the pipeline schedule to mutate. |
Fields
Name | Type | Description |
---|---|---|
clientMutationId
|
String |
A unique identifier for the client performing the mutation. |
errors
|
[String!]! |
Errors encountered during execution of the mutation. |
pipelineSchedule
|
PipelineSchedule |
Updated pipeline schedule ownership. |
Mutation.pipelineScheduleUpdate
Input type: PipelineScheduleUpdateInput
Arguments
Name | Type | Description |
---|---|---|
active
|
Boolean |
Indicates if the pipeline schedule should be active or not. |
clientMutationId
|
String |
A unique identifier for the client performing the mutation. |
cron
|
String |
Cron expression of the pipeline schedule. |
cronTimezone
|
String |
Cron time zone supported by ActiveSupport::TimeZone. For example: "Pacific Time (US & Canada)" (default: "UTC"). |
description
|
String |
Description of the pipeline schedule. |
id
|
CiPipelineScheduleID! |
ID of the pipeline schedule to mutate. |
ref
|
String |
Ref of the pipeline schedule. |
variables
|
[PipelineScheduleVariableInput!] |
Variables for the pipeline schedule. |
Fields
Name | Type | Description |
---|---|---|
clientMutationId
|
String |
A unique identifier for the client performing the mutation. |
errors
|
[String!]! |
Errors encountered during execution of the mutation. |
pipelineSchedule
|
PipelineSchedule |
Updated pipeline schedule. |
Mutation.pipelineTriggerCreate
DETAILS: Introduced in GitLab 16.3. Status: Experiment.
Input type: PipelineTriggerCreateInput
Arguments
Name | Type | Description |
---|---|---|
clientMutationId
|
String |
A unique identifier for the client performing the mutation. |
description
|
String! |
Description of the pipeline trigger token. |
projectPath
|
ID! |
Full path of the project that the pipeline trigger token to mutate is in. |
Fields
Name | Type | Description |
---|---|---|
clientMutationId
|
String |
A unique identifier for the client performing the mutation. |
errors
|
[String!]! |
Errors encountered during execution of the mutation. |
pipelineTrigger
|
PipelineTrigger |
Mutated pipeline trigger token. |
Mutation.pipelineTriggerDelete
DETAILS: Introduced in GitLab 16.3. Status: Experiment.
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.
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.
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.
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 {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. |
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.
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.
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.
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 |
---|---|---|
clientMutationId
|
String |
A unique identifier for the client performing the mutation. |
description
|
String |
Description of the project 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.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.
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.
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.
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.
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.
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.
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.
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.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.
Input type: RunnerCreateInput
Arguments
Name | Type | Description |
---|---|---|
accessLevel
|
CiRunnerAccessLevel |
Access level of the runner. |
clientMutationId
|
String |
A unique identifier for the client performing the mutation. |
description
|
String |
Description of the runner. |
groupId
|
GroupID |
Global ID of the group that the runner is created in (valid only for group runner). |
locked
|
Boolean |
Indicates the runner is locked. |
maintenanceNote
|
String |
Runner's maintenance notes. |
maximumTimeout
|
Int |
Maximum timeout (in seconds) for jobs processed by the runner. |
paused
|
Boolean |
Indicates the runner is not allowed to receive jobs. |
projectId
|
ProjectID |
Global ID of the project that the runner is created in (valid only for project runner). |
runUntagged
|
Boolean |
Indicates the runner is able to run untagged jobs. |
runnerType
|
CiRunnerType! |
Type of the runner to create. |
tagList
|
[String!] |
Tags associated with the runner. |
Fields
Name | Type | Description |
---|---|---|
clientMutationId
|
String |
A unique identifier for the client performing the mutation. |
errors
|
[String!]! |
Errors encountered during execution of the mutation. |
runner
|
CiRunner |
Runner after mutation. |
Mutation.runnerDelete
Input type: RunnerDeleteInput
Arguments
Name | Type | Description |
---|---|---|
clientMutationId
|
String |
A unique identifier for the client performing the mutation. |
id
|
CiRunnerID! |
ID of the runner to delete. |
Fields
Name | Type | Description |
---|---|---|
clientMutationId
|
String |
A unique identifier for the client performing the mutation. |
errors
|
[String!]! |
Errors encountered during execution of the mutation. |
Mutation.runnerUpdate
Input type: RunnerUpdateInput
Arguments
Name | Type | Description |
---|---|---|
accessLevel
|
CiRunnerAccessLevel |
Access level of the runner. |
active {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
|
Float |
Private projects' "compute cost factor" associated with the runner (GitLab.com only). |
publicProjectsMinutesCostFactor
|
Float |
Public projects' "compute cost factor" associated with the runner (GitLab.com only). |
runUntagged
|
Boolean |
Indicates the runner is able to run untagged jobs. |
tagList
|
[String!] |
Tags associated with the runner. |
Fields
Name | Type | Description |
---|---|---|
clientMutationId
|
String |
A unique identifier for the client performing the mutation. |
errors
|
[String!]! |
Errors encountered during execution of the mutation. |
runner
|
CiRunner |
Runner after mutation. |
Mutation.runnersExportUsage
Input type: RunnersExportUsageInput
Arguments
Name | Type | Description |
---|---|---|
clientMutationId
|
String |
A unique identifier for the client performing the mutation. |
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
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 {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.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.
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.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 {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 {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.
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 {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.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. |
Mutation.starProject
DETAILS: Introduced in GitLab 16.7. Status: Experiment.
Input type: StarProjectInput
Arguments
Name | Type | Description |
---|---|---|
clientMutationId
|
String |
A unique identifier for the client performing the mutation. |
projectId
|
ProjectID! |
Full path of the project to star or unstar. |
starred
|
Boolean! |
Indicates whether to star or unstar the project. |
Fields
Name | Type | Description |
---|---|---|
clientMutationId
|
String |
A unique identifier for the client performing the mutation. |
count
|
String! |
Number of stars for the project. |
errors
|
[String!]! |
Errors encountered during execution of the mutation. |
Mutation.terraformStateDelete
Input type: TerraformStateDeleteInput
Arguments
Name | Type | Description |
---|---|---|
clientMutationId
|
String |
A unique identifier for the client performing the mutation. |
id
|
TerraformStateID! |
Global ID of the Terraform state. |
Fields
Name | Type | Description |
---|---|---|
clientMutationId
|
String |
A unique identifier for the client performing the mutation. |
errors
|
[String!]! |
Errors encountered during execution of the mutation. |
Mutation.terraformStateLock
Input type: TerraformStateLockInput
Arguments
Name | Type | Description |
---|---|---|
clientMutationId
|
String |
A unique identifier for the client performing the mutation. |
id
|
TerraformStateID! |
Global ID of the Terraform state. |
Fields
Name | Type | Description |
---|---|---|
clientMutationId
|
String |
A unique identifier for the client performing the mutation. |
errors
|
[String!]! |
Errors encountered during execution of the mutation. |
Mutation.terraformStateUnlock
Input type: TerraformStateUnlockInput
Arguments
Name | Type | Description |
---|---|---|
clientMutationId
|
String |
A unique identifier for the client performing the mutation. |
id
|
TerraformStateID! |
Global ID of the Terraform state. |
Fields
Name | Type | Description |
---|---|---|
clientMutationId
|
String |
A unique identifier for the client performing the mutation. |
errors
|
[String!]! |
Errors encountered during execution of the mutation. |
Mutation.timelineEventCreate
DETAILS: Introduced in GitLab 15.6. Status: Experiment.
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.todoMarkDone
Input type: TodoMarkDoneInput
Arguments
Name | Type | Description |
---|---|---|
clientMutationId
|
String |
A unique identifier for the client performing the mutation. |
id
|
TodoID! |
Global ID of the to-do item to mark as done. |
Fields
Name | Type | Description |
---|---|---|
clientMutationId
|
String |
A unique identifier for the client performing the mutation. |
errors
|
[String!]! |
Errors encountered during execution of the mutation. |
todo
|
Todo! |
Requested to-do item. |
Mutation.todoRestore
Input type: TodoRestoreInput
Arguments
Name | Type | Description |
---|---|---|
clientMutationId
|
String |
A unique identifier for the client performing the mutation. |
id
|
TodoID! |
Global ID of the to-do item to restore. |
Fields
Name | Type | Description |
---|---|---|
clientMutationId
|
String |
A unique identifier for the client performing the mutation. |
errors
|
[String!]! |
Errors encountered during execution of the mutation. |
todo
|
Todo! |
Requested to-do item. |
Mutation.todoRestoreMany
Input type: TodoRestoreManyInput
Arguments
Name | Type | Description |
---|---|---|
clientMutationId
|
String |
A unique identifier for the client performing the mutation. |
ids
|
[TodoID!]! |
Global IDs of the to-do items to restore (a maximum of 50 is supported at once). |
Fields
Name | Type | Description |
---|---|---|
clientMutationId
|
String |
A unique identifier for the client performing the mutation. |
errors
|
[String!]! |
Errors encountered during execution of the mutation. |
todos
|
[Todo!]! |
Updated to-do items. |
Mutation.todoSnooze
DETAILS: Introduced in GitLab 17.4. Status: Experiment.
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.todoUnSnooze
DETAILS: Introduced in GitLab 17.4. Status: Experiment.
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.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.
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.
Input type: UpdateBoardEpicUserPreferencesInput
Arguments
Name | Type | Description |
---|---|---|
boardId
|
BoardID! |
Board global ID. |
clientMutationId
|
String |
A unique identifier for the client performing the mutation. |
collapsed
|
Boolean! |
Whether the epic should be collapsed in the board. |
epicId
|
EpicID! |
ID of an epic to set preferences for. |
Fields
Name | Type | Description |
---|---|---|
clientMutationId
|
String |
A unique identifier for the client performing the mutation. |
epicUserPreferences
|
BoardEpicUserPreferences |
User preferences for the epic in the board after mutation. |
errors
|
[String!]! |
Errors encountered during execution of the mutation. |
Mutation.updateBoardList
Input type: UpdateBoardListInput
Arguments
Name | Type | Description |
---|---|---|
clientMutationId
|
String |
A unique identifier for the client performing the mutation. |
collapsed
|
Boolean |
Indicates if the list is collapsed for the user. |
listId
|
ListID! |
Global ID of the list. |
position
|
Int |
Position of list within the board. |
Fields
Name | Type | Description |
---|---|---|
clientMutationId
|
String |
A unique identifier for the client performing the mutation. |
errors
|
[String!]! |
Errors encountered during execution of the mutation. |
list
|
BoardList |
Mutated list. |
Mutation.updateComplianceFramework
Input type: UpdateComplianceFrameworkInput
Arguments
Name | Type | Description |
---|---|---|
clientMutationId
|
String |
A unique identifier for the client performing the mutation. |
id
|
ComplianceManagementFrameworkID! |
Global ID of the compliance framework to update. |
params
|
ComplianceFrameworkInput! |
Parameters to update the compliance framework with. |
Fields
Name | Type | Description |
---|---|---|
clientMutationId
|
String |
A unique identifier for the client performing the mutation. |
complianceFramework
|
ComplianceFramework |
Compliance framework after mutation. |
errors
|
[String!]! |
Errors encountered during execution of the mutation. |
Mutation.updateContainerExpirationPolicy
Input type: UpdateContainerExpirationPolicyInput
Arguments
Name | Type | Description |
---|---|---|
cadence
|
ContainerExpirationPolicyCadenceEnum |
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 {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.updateContainerRegistryProtectionRule
Updates a container registry protection rule to restrict access to project containers. You can prevent users without certain roles from altering containers. Available only when feature flag container_registry_protected_containers
is enabled.
DETAILS: Introduced in GitLab 16.7. Status: Experiment.
Input type: UpdateContainerRegistryProtectionRuleInput
Arguments
Name | Type | Description |
---|---|---|
clientMutationId
|
String |
A unique identifier for the client performing the mutation. |
id
|
ContainerRegistryProtectionRuleID! |
Global ID of the container registry protection rule to be updated. |
minimumAccessLevelForDelete {warning-solid}
|
ContainerRegistryProtectionRuleAccessLevel |
Deprecated: Status: Experiment. Introduced in GitLab 16.7. |
minimumAccessLevelForPush {warning-solid}
|
ContainerRegistryProtectionRuleAccessLevel |
Deprecated: Status: Experiment. Introduced in GitLab 16.7. |
repositoryPathPattern {warning-solid}
|
String |
Deprecated: Status: Experiment. Introduced in GitLab 16.7. |
Fields
Name | Type | Description |
---|---|---|
clientMutationId
|
String |
A unique identifier for the client performing the mutation. |
containerRegistryProtectionRule {warning-solid}
|
ContainerRegistryProtectionRule |
Deprecated: Status: Experiment. Introduced in GitLab 16.7. |
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. |
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.
Input type: UpdateEpicInput
Arguments
Name | Type | Description |
---|---|---|
addLabelIds
|
[ID!] |
IDs of labels to be added to the epic. |
addLabels
|
[String!] |
Array of labels to be added to the epic. |
clientMutationId
|
String |
A unique identifier for the client performing the mutation. |
color
|
Color |
Color of the epic. Available only when feature flag epic_color_highlight is enabled. This flag is disabled by default, because the feature is experimental and is subject to change without notice. |
confidential
|
Boolean |
Indicates if the epic is confidential. |
description
|
String |
Description of the epic. |
dueDateFixed
|
String |
End date of the epic. |
dueDateIsFixed
|
Boolean |
Indicates end date should be sourced from due_date_fixed field not the issue milestones. |
groupPath
|
ID! |
Group the epic to mutate is in. |
iid
|
ID! |
IID of the epic to mutate. |
removeLabelIds
|
[ID!] |
IDs of labels to be removed from the epic. |
removeLabels
|
[String!] |
Array of labels to be removed from the epic. |
startDateFixed
|
String |
Start date of the epic. |
startDateIsFixed
|
Boolean |
Indicates start date should be sourced from start_date_fixed field not the issue milestones. |
stateEvent
|
EpicStateEvent |
State event for the epic. |
title
|
String |
Title of the epic. |
Fields
Name | Type | Description |
---|---|---|
clientMutationId
|
String |
A unique identifier for the client performing the mutation. |
epic
|
Epic |
Epic after mutation. |
errors
|
[String!]! |
Errors encountered during execution of the mutation. |
Mutation.updateEpicBoardList
DETAILS: Deprecated in GitLab 17.5. Replaced by WorkItem type.
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 {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 |
---|---|---|
clientMutationId
|
String |
A unique identifier for the client performing the mutation. |
genericDuplicateExceptionRegex
|
UntrustedRegexp |
When generic_duplicates_allowed is false, you can publish duplicate packages with names that match this regex. Otherwise, this setting has no effect. |
genericDuplicatesAllowed
|
Boolean |
Indicates whether duplicate generic packages are allowed for this namespace. |
lockMavenPackageRequestsForwarding
|
Boolean |
Indicates whether Maven package forwarding is locked for all descendent namespaces. |
lockNpmPackageRequestsForwarding
|
Boolean |
Indicates whether npm package forwarding is locked for all descendent namespaces. |
lockPypiPackageRequestsForwarding
|
Boolean |
Indicates whether PyPI package forwarding is locked for all descendent namespaces. |
mavenDuplicateExceptionRegex
|
UntrustedRegexp |
When maven_duplicates_allowed is false, you can publish duplicate packages with names that match this regex. Otherwise, this setting has no effect. |
mavenDuplicatesAllowed
|
Boolean |
Indicates whether duplicate Maven packages are allowed for this namespace. |
mavenPackageRequestsForwarding
|
Boolean |
Indicates whether Maven package forwarding is allowed for this namespace. |
namespacePath
|
ID! |
Namespace path where the namespace package setting is located. |
npmPackageRequestsForwarding
|
Boolean |
Indicates whether npm package forwarding is allowed for this namespace. |
nugetDuplicateExceptionRegex
|
UntrustedRegexp |
When nuget_duplicates_allowed is false, you can publish duplicate packages with names that match this regex. Otherwise, this setting has no effect. |
nugetDuplicatesAllowed
|
Boolean |
Indicates whether duplicate NuGet packages are allowed for this namespace. |
nugetSymbolServerEnabled
|
Boolean |
Indicates wheather the NuGet symbol server is enabled for this namespace. |
pypiPackageRequestsForwarding
|
Boolean |
Indicates whether PyPI package forwarding is allowed for this namespace. |
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 this namespace. |
Fields
Name | Type | Description |
---|---|---|
clientMutationId
|
String |
A unique identifier for the client performing the mutation. |
errors
|
[String!]! |
Errors encountered during execution of the mutation. |
packageSettings
|
PackageSettings |
Namespace package setting after mutation. |
Mutation.updateNote
Updates a Note. If the body of the Note contains only quick actions, the Note will be destroyed during an update, and no Note will be returned.
Input type: UpdateNoteInput
Arguments
Name | Type | Description |
---|---|---|
body
|
String |
Content of the note. |
clientMutationId
|
String |
A unique identifier for the client performing the mutation. |
confidential {warning-solid}
|
Boolean |
Deprecated: No longer allowed to update confidentiality of notes. Deprecated in GitLab 14.10. |
id
|
NoteID! |
Global ID of the note to update. |
Fields
Name | Type | Description |
---|---|---|
clientMutationId
|
String |
A unique identifier for the client performing the mutation. |
errors
|
[String!]! |
Errors encountered during execution of the mutation. |
note
|
Note |
Note after mutation. |
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.
DETAILS: Introduced in GitLab 16.6. Status: Experiment.
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. |
minimumAccessLevelForPush {warning-solid}
|
PackagesProtectionRuleAccessLevel |
Deprecated: Status: Experiment. Introduced in GitLab 16.6. |
packageNamePattern {warning-solid}
|
String |
Deprecated: Status: Experiment. Introduced in GitLab 16.6. |
packageType {warning-solid}
|
PackagesProtectionRulePackageType |
Deprecated: Status: Experiment. Introduced in GitLab 16.6. |
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 {warning-solid}
|
PackagesProtectionRule |
Deprecated: Status: Experiment. Introduced in GitLab 16.6. |
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 {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.
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.
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.
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. |
mergeRequestsSort
|
MergeRequestSort |
Sort order for issue lists. |
organizationGroupsProjectsDisplay {warning-solid}
|
OrganizationGroupProjectDisplay |
Deprecated: Status: Experiment. Introduced in GitLab 17.2. |
organizationGroupsProjectsSort {warning-solid}
|
OrganizationGroupProjectSort |
Deprecated: Status: Experiment. Introduced in GitLab 17.2. |
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.
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.
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.
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.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.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.
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.
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.
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.
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.
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. |
crmContactsWidget
|
WorkItemWidgetCrmContactsCreateInput |
Input for CRM contacts widget. |
description {warning-solid}
|
String |
Deprecated: use description widget instead. Deprecated in GitLab 16.9. |
descriptionWidget
|
WorkItemWidgetDescriptionInput |
Input for description widget. |
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 {warning-solid}
|
ID |
Deprecated: Please use namespacePath instead. That will cover for both projects and groups. Deprecated in GitLab 15.10. |
rolledupDatesWidget {warning-solid}
|
WorkItemWidgetRolledupDatesInput |
Deprecated: Status: Experiment. Introduced in GitLab 16.9. |
startAndDueDateWidget
|
WorkItemWidgetStartAndDueDateUpdateInput |
Input for start and due date widget. |
title
|
String! |
Title of the work item. |
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.
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.
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 {warning-solid}
|
Project |
Deprecated: Use namespace . Deprecated in GitLab 16.9. |
Mutation.workItemExport
DETAILS: Introduced in GitLab 15.10. Status: Experiment.
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. |
confidential
|
Boolean |
Filter for confidential work items. If false , excludes confidential work items. If true , returns only confidential work items. |
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 {warning-solid}
|
SubscriptionStatus |
Deprecated: Status: Experiment. Introduced in GitLab 17.5. |
types
|
[IssueType!] |
Filter work items by the given work item types. |
Fields
Name | Type | Description |
---|---|---|
clientMutationId
|
String |
A unique identifier for the client performing the mutation. |
errors
|
[String!]! |
Errors encountered during execution of the mutation. |
message
|
String |
Export request result message. |
Mutation.workItemRemoveLinkedItems
Remove items linked to the work item.
DETAILS: Introduced in GitLab 16.3. Status: Experiment.
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.
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.
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. |
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. |
rolledupDatesWidget {warning-solid}
|
WorkItemWidgetRolledupDatesInput |
Deprecated: use StartAndDueDate instead. Deprecated in GitLab 17.5. |
startAndDueDateWidget
|
WorkItemWidgetStartAndDueDateUpdateInput |
Input for start and due date widget. |
stateEvent
|
WorkItemStateEvent |
Close or reopen a work item. |
statusWidget
|
StatusInput |
Input for status widget. |
timeTrackingWidget
|
WorkItemWidgetTimeTrackingInput |
Input for time tracking widget. |
title
|
String |
Title of the work item. |
weightWidget
|
WorkItemWidgetWeightInput |
Input for weight widget. |
Fields
Name | Type | Description |
---|---|---|
clientMutationId
|
String |
A unique identifier for the client performing the mutation. |
errors
|
[String!]! |
Errors encountered during execution of the mutation. |
workItem
|
WorkItem |
Updated work item. |
Mutation.workItemsHierarchyReorder
Reorder a work item in the hierarchy tree.
DETAILS: Introduced in GitLab 17.3. Status: Experiment.
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 repo git path containing the devfile used to configure the workspace. |
devfileRef
|
String! |
Project repo git ref containing the devfile used to configure the workspace. |
editor {warning-solid}
|
String |
Deprecated: Argument is not used. Deprecated in GitLab 17.5. |
maxHoursBeforeTermination
|
Int! |
Maximum hours the workspace can exist before it is automatically terminated. |
projectId
|
ProjectID! |
ID of the project that will provide the Devfile for the created workspace. |
variables
|
[WorkspaceVariableInput!] |
Variables to inject into 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. |
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. |
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. |
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. |
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. |
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. |
CiCatalogResourceConnection
The connection type for CiCatalogResource
.
Fields
Name | Type | Description |
---|---|---|
count
|
Int! |
Total count of collection. |
edges
|
[CiCatalogResourceEdge] |
A list of edges. |
nodes
|
[CiCatalogResource] |
A list of nodes. |
pageInfo
|
PageInfo! |
Information to aid in pagination. |
CiCatalogResourceEdge
The edge type for CiCatalogResource
.
Fields
Name | Type | Description |
---|---|---|
cursor
|
String! |
A cursor for use in pagination. |
node
|
CiCatalogResource |
The item at the end of the edge. |
CiCatalogResourceVersionConnection
The connection type for CiCatalogResourceVersion
.
Fields
Name | Type | Description |
---|---|---|
count
|
Int! |
Total count of collection. |
edges
|
[CiCatalogResourceVersionEdge] |
A list of edges. |
nodes
|
[CiCatalogResourceVersion] |
A list of nodes. |
pageInfo
|
PageInfo! |
Information to aid in pagination. |
CiCatalogResourceVersionEdge
The edge type for CiCatalogResourceVersion
.
Fields
Name | Type | Description |
---|---|---|
cursor
|
String! |
A cursor for use in pagination. |
node
|
CiCatalogResourceVersion |
The item at the end of the edge. |
CiConfigGroupConnection
The connection type for CiConfigGroup
.
Fields
Name | Type | Description |
---|---|---|
edges
|
[CiConfigGroupEdge] |
A list of edges. |
nodes
|
[CiConfigGroup] |
A list of nodes. |
pageInfo
|
PageInfo! |
Information to aid in pagination. |
CiConfigGroupEdge
The edge type for CiConfigGroup
.
Fields
Name | Type | Description |
---|---|---|
cursor
|
String! |
A cursor for use in pagination. |
node
|
CiConfigGroup |
The item at the end of the edge. |
CiConfigJobConnection
The connection type for CiConfigJob
.
Fields
Name | Type | Description |
---|---|---|
edges
|
[CiConfigJobEdge] |
A list of edges. |
nodes
|
[CiConfigJob] |
A list of nodes. |
pageInfo
|
PageInfo! |
Information to aid in pagination. |
CiConfigJobEdge
The edge type for CiConfigJob
.
Fields
Name | Type | Description |
---|---|---|
cursor
|
String! |
A cursor for use in pagination. |
node
|
CiConfigJob |
The item at the end of the edge. |
CiConfigNeedConnection
The connection type for CiConfigNeed
.
Fields
Name | Type | Description |
---|---|---|
edges
|
[CiConfigNeedEdge] |
A list of edges. |
nodes
|
[CiConfigNeed] |
A list of nodes. |
pageInfo
|
PageInfo! |
Information to aid in pagination. |
CiConfigNeedEdge
The edge type for CiConfigNeed
.
Fields
Name | Type | Description |
---|---|---|
cursor
|
String! |
A cursor for use in pagination. |
node
|
CiConfigNeed |
The item at the end of the edge. |
CiConfigStageConnection
The connection type for CiConfigStage
.
Fields
Name | Type | Description |
---|---|---|
edges
|
[CiConfigStageEdge] |
A list of edges. |
nodes
|
[CiConfigStage] |
A list of nodes. |
pageInfo
|
PageInfo! |
Information to aid in pagination. |
CiConfigStageEdge
The edge type for CiConfigStage
.
Fields
Name | Type | Description |
---|---|---|
cursor
|
String! |
A cursor for use in pagination. |
node
|
CiConfigStage |
The item at the end of the edge. |
CiGroupConnection
The connection type for CiGroup
.
Fields
Name | Type | Description |
---|---|---|
edges
|
[CiGroupEdge] |
A list of edges. |
nodes
|
[CiGroup] |
A list of nodes. |
pageInfo
|
PageInfo! |
Information to aid in pagination. |
CiGroupEdge
The edge type for CiGroup
.
Fields
Name | Type | Description |
---|---|---|
cursor
|
String! |
A cursor for use in pagination. |
node
|
CiGroup |
The item at the end of the edge. |
CiGroupEnvironmentScopeConnection
The connection type for CiGroupEnvironmentScope
.
Fields
Name | Type | Description |
---|---|---|
edges
|
[CiGroupEnvironmentScopeEdge] |
A list of edges. |
nodes
|
[CiGroupEnvironmentScope] |
A list of nodes. |
pageInfo
|
PageInfo! |
Information to aid in pagination. |
CiGroupEnvironmentScopeEdge
The edge type for CiGroupEnvironmentScope
.
Fields
Name | Type | Description |
---|---|---|
cursor
|
String! |
A cursor for use in pagination. |
node
|
CiGroupEnvironmentScope |
The item at the end of the edge. |
CiGroupVariableConnection
The connection type for CiGroupVariable
.
Fields
Name | Type | Description |
---|---|---|
edges
|
[CiGroupVariableEdge] |
A list of edges. |
limit
|
Int! |
Maximum amount of group CI/CD variables. |
nodes
|
[CiGroupVariable] |
A list of nodes. |
pageInfo
|
PageInfo! |
Information to aid in pagination. |
CiGroupVariableEdge
The edge type for CiGroupVariable
.
Fields
Name | Type | Description |
---|---|---|
cursor
|
String! |
A cursor for use in pagination. |
node
|
CiGroupVariable |
The item at the end of the edge. |
CiInstanceVariableConnection
The connection type for CiInstanceVariable
.
Fields
Name | Type | Description |
---|---|---|
edges
|
[CiInstanceVariableEdge] |
A list of edges. |
nodes
|
[CiInstanceVariable] |
A list of nodes. |
pageInfo
|
PageInfo! |
Information to aid in pagination. |
CiInstanceVariableEdge
The edge type for CiInstanceVariable
.
Fields
Name | Type | Description |
---|---|---|
cursor
|
String! |
A cursor for use in pagination. |
node
|
CiInstanceVariable |
The item at the end of the edge. |
CiJobArtifactConnection
The connection type for CiJobArtifact
.
Fields
Name | Type | Description |
---|---|---|
edges
|
[CiJobArtifactEdge] |
A list of edges. |
nodes
|
[CiJobArtifact] |
A list of nodes. |
pageInfo
|
PageInfo! |
Information to aid in pagination. |
CiJobArtifactEdge
The edge type for CiJobArtifact
.
Fields
Name | Type | Description |
---|---|---|
cursor
|
String! |
A cursor for use in pagination. |
node
|
CiJobArtifact |
The item at the end of the edge. |
CiJobConnection
The connection type for CiJob
.
Fields
Name | Type | Description |
---|---|---|
edges
|
[CiJobEdge] |
A list of edges. |
nodes
|
[CiJob] |
A list of nodes. |
pageInfo
|
PageInfo! |
Information to aid in pagination. |
Fields with arguments
CiJobConnection.count
Limited count of collection. Returns limit + 1 for counts greater than the limit.
Returns Int!
.
####### Arguments
Name | Type | Description |
---|---|---|
limit
|
Int |
Limit value to be applied to the count query. Default is 1000. |
CiJobEdge
The edge type for CiJob
.
Fields
Name | Type | Description |
---|---|---|
cursor
|
String! |
A cursor for use in pagination. |
node
|
CiJob |
The item at the end of the edge. |
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. |
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. |
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. |
ComplianceStandardsAdherenceConnection
The connection type for ComplianceStandardsAdherence
.
Fields
Name | Type | Description |
---|---|---|
edges
|
[ComplianceStandardsAdherenceEdge] |
A list of edges. |
nodes
|
[ComplianceStandardsAdherence] |
A list of nodes. |
pageInfo
|
PageInfo! |
Information to aid in pagination. |
ComplianceStandardsAdherenceEdge
The edge type for ComplianceStandardsAdherence
.
Fields
Name | Type | Description |
---|---|---|
cursor
|
String! |
A cursor for use in pagination. |
node
|
ComplianceStandardsAdherence |
The item at the end of the edge. |
ComplianceViolationConnection
The connection type for ComplianceViolation
.
Fields
Name | Type | Description |
---|---|---|
edges
|
[ComplianceViolationEdge] |
A list of edges. |
nodes
|
[ComplianceViolation] |
A list of nodes. |
pageInfo
|
PageInfo! |
Information to aid in pagination. |
ComplianceViolationEdge
The edge type for ComplianceViolation
.
Fields
Name | Type | Description |
---|---|---|
cursor
|
String! |
A cursor for use in pagination. |
node
|
ComplianceViolation |
The item at the end of the edge. |
ConnectedAgentConnection
The connection type for ConnectedAgent
.
Fields
Name | Type | Description |
---|---|---|
edges
|
[ConnectedAgentEdge] |
A list of edges. |
nodes
|
[ConnectedAgent] |
A list of nodes. |
pageInfo
|
PageInfo! |
Information to aid in pagination. |
ConnectedAgentEdge
The edge type for ConnectedAgent
.
Fields
Name | Type | Description |
---|---|---|
cursor
|
String! |
A cursor for use in pagination. |
node
|
ConnectedAgent |
The item at the end of the edge. |
ContainerRegistryProtectionRuleConnection
The connection type for ContainerRegistryProtectionRule
.
Fields
Name | Type | Description |
---|---|---|
edges
|
[ContainerRegistryProtectionRuleEdge] |
A list of edges. |
nodes
|
[ContainerRegistryProtectionRule] |
A list of nodes. |
pageInfo
|
PageInfo! |
Information to aid in pagination. |
ContainerRegistryProtectionRuleEdge
The edge type for ContainerRegistryProtectionRule
.
Fields
Name | Type | Description |
---|---|---|
cursor
|
String! |
A cursor for use in pagination. |
node
|
ContainerRegistryProtectionRule |
The item at the end of the edge. |
ContainerRepositoryConnection
The connection type for ContainerRepository
.
Fields
Name | Type | Description |
---|---|---|
edges
|
[ContainerRepositoryEdge] |
A list of edges. |
nodes
|
[ContainerRepository] |
A list of nodes. |
pageInfo
|
PageInfo! |
Information to aid in pagination. |
ContainerRepositoryEdge
The edge type for ContainerRepository
.
Fields
Name | Type | Description |
---|---|---|
cursor
|
String! |
A cursor for use in pagination. |
node
|
ContainerRepository |
The item at the end of the edge. |
ContainerRepositoryRegistryConnection
The connection type for ContainerRepositoryRegistry
.
Fields
Name | Type | Description |
---|---|---|
edges
|
[ContainerRepositoryRegistryEdge] |
A list of edges. |
nodes
|
[ContainerRepositoryRegistry] |
A list of nodes. |
pageInfo
|
PageInfo! |
Information to aid in pagination. |
ContainerRepositoryRegistryEdge
The edge type for ContainerRepositoryRegistry
.
Fields
Name | Type | Description |
---|---|---|
cursor
|
String! |
A cursor for use in pagination. |
node
|
ContainerRepositoryRegistry |
The item at the end of the edge. |
ContainerRepositoryTagConnection
The connection type for ContainerRepositoryTag
.
Fields
Name | Type | Description |
---|---|---|
edges
|
[ContainerRepositoryTagEdge] |
A list of edges. |
nodes
|
[ContainerRepositoryTag] |
A list of nodes. |
pageInfo
|
PageInfo! |
Information to aid in pagination. |
ContainerRepositoryTagEdge
The edge type for ContainerRepositoryTag
.
Fields
Name | Type | Description |
---|---|---|
cursor
|
String! |
A cursor for use in pagination. |
node
|
ContainerRepositoryTag |
The item at the end of the edge. |
ContributionAnalyticsContributionConnection
The connection type for ContributionAnalyticsContribution
.
Fields
Name | Type | Description |
---|---|---|
edges
|
[ContributionAnalyticsContributionEdge] |
A list of edges. |
nodes
|
[ContributionAnalyticsContribution] |
A list of nodes. |
pageInfo
|
PageInfo! |
Information to aid in pagination. |
ContributionAnalyticsContributionEdge
The edge type for ContributionAnalyticsContribution
.
Fields
Name | Type | Description |
---|---|---|
cursor
|
String! |
A cursor for use in pagination. |
node
|
ContributionAnalyticsContribution |
The item at the end of the edge. |
CoverageFuzzingCorpusConnection
The connection type for CoverageFuzzingCorpus
.
Fields
Name | Type | Description |
---|---|---|
edges
|
[CoverageFuzzingCorpusEdge] |
A list of edges. |
nodes
|
[CoverageFuzzingCorpus] |
A list of nodes. |
pageInfo
|
PageInfo! |
Information to aid in pagination. |
CoverageFuzzingCorpusEdge
The edge type for CoverageFuzzingCorpus
.
Fields
Name | Type | Description |
---|---|---|
cursor
|
String! |
A cursor for use in pagination. |
node
|
CoverageFuzzingCorpus |
The item at the end of the edge. |
CustomEmojiConnection
The connection type for CustomEmoji
.
Fields
Name | Type | Description |
---|---|---|
count
|
Int! |
Total count of collection. |
edges
|
[CustomEmojiEdge] |
A list of edges. |
nodes
|
[CustomEmoji] |
A list of nodes. |
pageInfo
|
PageInfo! |
Information to aid in pagination. |
CustomEmojiEdge
The edge type for CustomEmoji
.
Fields
Name | Type | Description |
---|---|---|
cursor
|
String! |
A cursor for use in pagination. |
node
|
CustomEmoji |
The item at the end of the edge. |
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. |
CustomizableDashboardConnection
The connection type for CustomizableDashboard
.
Fields
Name | Type | Description |
---|---|---|
edges
|
[CustomizableDashboardEdge] |
A list of edges. |
nodes
|
[CustomizableDashboard] |
A list of nodes. |
pageInfo
|
PageInfo! |
Information to aid in pagination. |
CustomizableDashboardEdge
The edge type for CustomizableDashboard
.
Fields
Name | Type | Description |
---|---|---|
cursor
|
String! |
A cursor for use in pagination. |
node
|
CustomizableDashboard |
The item at the end of the edge. |
CustomizableDashboardPanelConnection
The connection type for CustomizableDashboardPanel
.
Fields
Name | Type | Description |
---|---|---|
edges
|
[CustomizableDashboardPanelEdge] |
A list of edges. |
nodes
|
[CustomizableDashboardPanel] |
A list of nodes. |
pageInfo
|
PageInfo! |
Information to aid in pagination. |
CustomizableDashboardPanelEdge
The edge type for CustomizableDashboardPanel
.
Fields
Name | Type | Description |
---|---|---|
cursor
|
String! |
A cursor for use in pagination. |
node
|
CustomizableDashboardPanel |
The item at the end of the edge. |
CustomizableDashboardVisualizationConnection
The connection type for CustomizableDashboardVisualization
.
Fields
Name | Type | Description |
---|---|---|
edges
|
[CustomizableDashboardVisualizationEdge] |
A list of edges. |
nodes
|
[CustomizableDashboardVisualization] |
A list of nodes. |
pageInfo
|
PageInfo! |
Information to aid in pagination. |
CustomizableDashboardVisualizationEdge
The edge type for CustomizableDashboardVisualization
.
Fields
Name | Type | Description |
---|---|---|
cursor
|
String! |
A cursor for use in pagination. |
node
|
CustomizableDashboardVisualization |
The item at the end of the edge. |
CustomizablePermissionConnection
The connection type for CustomizablePermission
.
Fields
Name | Type | Description |
---|---|---|
edges
|
[CustomizablePermissionEdge] |
A list of edges. |
nodes
|
[CustomizablePermission] |
A list of nodes. |
pageInfo
|
PageInfo! |
Information to aid in pagination. |
CustomizablePermissionEdge
The edge type for CustomizablePermission
.
Fields
Name | Type | Description |
---|---|---|
cursor
|
String! |
A cursor for use in pagination. |
node
|
CustomizablePermission |
The item at the end of the edge. |
DastProfileConnection
The connection type for DastProfile
.
Fields
Name | Type | Description |
---|---|---|
count
|
Int! |
Total count of collection. |
edges
|
[DastProfileEdge] |
A list of edges. |
nodes
|
[DastProfile] |
A list of nodes. |
pageInfo
|
PageInfo! |
Information to aid in pagination. |
DastProfileEdge
The edge type for DastProfile
.
Fields
Name | Type | Description |
---|---|---|
cursor
|
String! |
A cursor for use in pagination. |
node
|
DastProfile |
The item at the end of the edge. |
DastScannerProfileConnection
The connection type for DastScannerProfile
.
Fields
Name | Type | Description |
---|---|---|
edges
|
[DastScannerProfileEdge] |
A list of edges. |
nodes
|
[DastScannerProfile] |
A list of nodes. |
pageInfo
|
PageInfo! |
Information to aid in pagination. |
DastScannerProfileEdge
The edge type for DastScannerProfile
.
Fields
Name | Type | Description |
---|---|---|
cursor
|
String! |
A cursor for use in pagination. |
node
|
DastScannerProfile |
The item at the end of the edge. |
DastSiteProfileConnection
The connection type for DastSiteProfile
.
Fields
Name | Type | Description |
---|---|---|
edges
|
[DastSiteProfileEdge] |
A list of edges. |
nodes
|
[DastSiteProfile] |
A list of nodes. |
pageInfo
|
PageInfo! |
Information to aid in pagination. |
DastSiteProfileEdge
The edge type for DastSiteProfile
.
Fields
Name | Type | Description |
---|---|---|
cursor
|
String! |
A cursor for use in pagination. |
node
|
DastSiteProfile |
The item at the end of the edge. |
DastSiteValidationConnection
The connection type for DastSiteValidation
.
Fields
Name | Type | Description |
---|---|---|
edges
|
[DastSiteValidationEdge] |
A list of edges. |
nodes
|
[DastSiteValidation] |
A list of nodes. |
pageInfo
|
PageInfo! |
Information to aid in pagination. |
DastSiteValidationEdge
The edge type for DastSiteValidation
.
Fields
Name | Type | Description |
---|---|---|
cursor
|
String! |
A cursor for use in pagination. |
node
|
DastSiteValidation |
The item at the end of the edge. |
DependencyConnection
The connection type for Dependency
.
Fields
Name | Type | Description |
---|---|---|
edges
|
[DependencyEdge] |
A list of edges. |
nodes
|
[Dependency] |
A list of nodes. |
pageInfo
|
PageInfo! |
Information to aid in pagination. |
DependencyEdge
The edge type for Dependency
.
Fields
Name | Type | Description |
---|---|---|
cursor
|
String! |
A cursor for use in pagination. |
node
|
Dependency |
The item at the end of the edge. |
DependencyProxyBlobConnection
The connection type for DependencyProxyBlob
.
Fields
Name | Type | Description |
---|---|---|
edges
|
[DependencyProxyBlobEdge] |
A list of edges. |
nodes
|
[DependencyProxyBlob] |
A list of nodes. |
pageInfo
|
PageInfo! |
Information to aid in pagination. |
DependencyProxyBlobEdge
The edge type for DependencyProxyBlob
.
Fields
Name | Type | Description |
---|---|---|
cursor
|
String! |
A cursor for use in pagination. |
node
|
DependencyProxyBlob |
The item at the end of the edge. |
DependencyProxyBlobRegistryConnection
The connection type for DependencyProxyBlobRegistry
.
Fields
Name | Type | Description |
---|---|---|
edges
|
[DependencyProxyBlobRegistryEdge] |
A list of edges. |
nodes
|
[DependencyProxyBlobRegistry] |
A list of nodes. |
pageInfo
|
PageInfo! |
Information to aid in pagination. |
DependencyProxyBlobRegistryEdge
The edge type for DependencyProxyBlobRegistry
.
Fields
Name | Type | Description |
---|---|---|
cursor
|
String! |
A cursor for use in pagination. |
node
|
DependencyProxyBlobRegistry |
The item at the end of the edge. |
DependencyProxyManifestConnection
The connection type for DependencyProxyManifest
.
Fields
Name | Type | Description |
---|---|---|
edges
|
[DependencyProxyManifestEdge] |
A list of edges. |
nodes
|
[DependencyProxyManifest] |
A list of nodes. |
pageInfo
|
PageInfo! |
Information to aid in pagination. |
DependencyProxyManifestEdge
The edge type for DependencyProxyManifest
.
Fields
Name | Type | Description |
---|---|---|
cursor
|
String! |
A cursor for use in pagination. |
node
|
DependencyProxyManifest |
The item at the end of the edge. |
DependencyProxyManifestRegistryConnection
The connection type for DependencyProxyManifestRegistry
.
Fields
Name | Type | Description |
---|---|---|
edges
|
[DependencyProxyManifestRegistryEdge] |
A list of edges. |
nodes
|
[DependencyProxyManifestRegistry] |
A list of nodes. |
pageInfo
|
PageInfo! |
Information to aid in pagination. |
DependencyProxyManifestRegistryEdge
The edge type for DependencyProxyManifestRegistry
.
Fields
Name | Type | Description |
---|---|---|
cursor
|
String! |
A cursor for use in pagination. |
node
|
DependencyProxyManifestRegistry |
The item at the end of the edge. |
DeploymentConnection
The connection type for Deployment
.
Fields
Name | Type | Description |
---|---|---|
edges
|
[DeploymentEdge] |
A list of edges. |
nodes
|
[Deployment] |
A list of nodes. |
pageInfo
|
PageInfo! |
Information to aid in pagination. |
DeploymentEdge
The edge type for Deployment
.
Fields
Name | Type | Description |
---|---|---|
cursor
|
String! |
A cursor for use in pagination. |
node
|
Deployment |
The item at the end of the edge. |
DesignAtVersionConnection
The connection type for DesignAtVersion
.
Fields
Name | Type | Description |
---|---|---|
edges
|
[DesignAtVersionEdge] |
A list of edges. |
nodes
|
[DesignAtVersion] |
A list of nodes. |
pageInfo
|
PageInfo! |
Information to aid in pagination. |
DesignAtVersionEdge
The edge type for DesignAtVersion
.
Fields
Name | Type | Description |
---|---|---|
cursor
|
String! |
A cursor for use in pagination. |
node
|
DesignAtVersion |
The item at the end of the edge. |
DesignConnection
The connection type for Design
.
Fields
Name | Type | Description |
---|---|---|
edges
|
[DesignEdge] |
A list of edges. |
nodes
|
[Design] |
A list of nodes. |
pageInfo
|
PageInfo! |
Information to aid in pagination. |
DesignEdge
The edge type for Design
.
Fields
Name | Type | Description |
---|---|---|
cursor
|
String! |
A cursor for use in pagination. |
node
|
Design |
The item at the end of the edge. |
DesignManagementRepositoryRegistryConnection
The connection type for DesignManagementRepositoryRegistry
.
Fields
Name | Type | Description |
---|---|---|
edges
|
[DesignManagementRepositoryRegistryEdge] |
A list of edges. |
nodes
|
[DesignManagementRepositoryRegistry] |
A list of nodes. |
pageInfo
|
PageInfo! |
Information to aid in pagination. |
DesignManagementRepositoryRegistryEdge
The edge type for DesignManagementRepositoryRegistry
.
Fields
Name | Type | Description |
---|---|---|
cursor
|
String! |
A cursor for use in pagination. |
node
|
DesignManagementRepositoryRegistry |
The item at the end of the edge. |
DesignVersionConnection
The connection type for DesignVersion
.
Fields
Name | Type | Description |
---|---|---|
edges
|
[DesignVersionEdge] |
A list of edges. |
nodes
|
[DesignVersion] |
A list of nodes. |
pageInfo
|
PageInfo! |
Information to aid in pagination. |
DesignVersionEdge
The edge type for DesignVersion
.
Fields
Name | Type | Description |
---|---|---|
cursor
|
String! |
A cursor for use in pagination. |
node
|
DesignVersion |
The item at the end of the edge. |
DevopsAdoptionEnabledNamespaceConnection
The connection type for DevopsAdoptionEnabledNamespace
.
Fields
Name | Type | Description |
---|---|---|
edges
|
[DevopsAdoptionEnabledNamespaceEdge] |
A list of edges. |
nodes
|
[DevopsAdoptionEnabledNamespace] |
A list of nodes. |
pageInfo
|
PageInfo! |
Information to aid in pagination. |
DevopsAdoptionEnabledNamespaceEdge
The edge type for DevopsAdoptionEnabledNamespace
.
Fields
Name | Type | Description |
---|---|---|
cursor
|
String! |
A cursor for use in pagination. |
node
|
DevopsAdoptionEnabledNamespace |
The item at the end of the edge. |
DevopsAdoptionSnapshotConnection
The connection type for DevopsAdoptionSnapshot
.
Fields
Name | Type | Description |
---|---|---|
edges
|
[DevopsAdoptionSnapshotEdge] |
A list of edges. |
nodes
|
[DevopsAdoptionSnapshot] |
A list of nodes. |
pageInfo
|
PageInfo! |
Information to aid in pagination. |
DevopsAdoptionSnapshotEdge
The edge type for DevopsAdoptionSnapshot
.
Fields
Name | Type | Description |
---|---|---|
cursor
|
String! |
A cursor for use in pagination. |
node
|
DevopsAdoptionSnapshot |
The item at the end of the edge. |
DiscussionConnection
The connection type for Discussion
.
Fields
Name | Type | Description |
---|---|---|
edges
|
[DiscussionEdge] |
A list of edges. |
nodes
|
[Discussion] |
A list of nodes. |
pageInfo
|
PageInfo! |
Information to aid in pagination. |
DiscussionEdge
The edge type for Discussion
.
Fields
Name | Type | Description |
---|---|---|
cursor
|
String! |
A cursor for use in pagination. |
node
|
Discussion |
The item at the end of the edge. |
DoraPerformanceScoreCountConnection
The connection type for DoraPerformanceScoreCount
.
Fields
Name | Type | Description |
---|---|---|
edges
|
[DoraPerformanceScoreCountEdge] |
A list of edges. |
noDoraDataProjectsCount
|
Int! |
Count of projects without any DORA scores within the scope. |
nodes
|
[DoraPerformanceScoreCount] |
A list of nodes. |
pageInfo
|
PageInfo! |
Information to aid in pagination. |
totalProjectsCount
|
Int! |
Count of total projects. |
DoraPerformanceScoreCountEdge
The edge type for DoraPerformanceScoreCount
.
Fields
Name | Type | Description |
---|---|---|
cursor
|
String! |
A cursor for use in pagination. |
node
|
DoraPerformanceScoreCount |
The item at the end of the edge. |
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. |
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. |
ForecastDatapointConnection
The connection type for ForecastDatapoint
.
Fields
Name | Type | Description |
---|---|---|
edges
|
[ForecastDatapointEdge] |
A list of edges. |
nodes
|
[ForecastDatapoint] |
A list of nodes. |
pageInfo
|
PageInfo! |
Information to aid in pagination. |
ForecastDatapointEdge
The edge type for ForecastDatapoint
.
Fields
Name | Type | Description |
---|---|---|
cursor
|
String! |
A cursor for use in pagination. |
node
|
ForecastDatapoint |
The item at the end of the edge. |
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. |
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. |
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. |
JobArtifactRegistryEdge
The edge type for JobArtifactRegistry
.
Fields
Name | Type | Description |
---|---|---|
cursor
|
String! |
A cursor for use in pagination. |
node
|
JobArtifactRegistry |
The item at the end of the edge. |
JobNeedUnionConnection
The connection type for JobNeedUnion
.
Fields
Name | Type | Description |
---|---|---|
edges
|
[JobNeedUnionEdge] |
A list of edges. |
nodes
|
[JobNeedUnion] |
A list of nodes. |
pageInfo
|
PageInfo! |
Information to aid in pagination. |
JobNeedUnionEdge
The edge type for JobNeedUnion
.
Fields
Name | Type | Description |
---|---|---|
cursor
|
String! |
A cursor for use in pagination. |
node
|
JobNeedUnion |
The item at the end of the edge. |
LabelConnection
The connection type for Label
.
Fields
Name | Type | Description |
---|---|---|
count
|
Int! |
Total count of collection. |
edges
|
[LabelEdge] |
A list of edges. |
nodes
|
[Label] |
A list of nodes. |
pageInfo
|
PageInfo! |
Information to aid in pagination. |
LabelEdge
The edge type for Label
.
Fields
Name | Type | Description |
---|---|---|
cursor
|
String! |
A cursor for use in pagination. |
node
|
Label |
The item at the end of the edge. |
LfsObjectRegistryConnection
The connection type for LfsObjectRegistry
.
Fields
Name | Type | Description |
---|---|---|
edges
|
[LfsObjectRegistryEdge] |
A list of edges. |
nodes
|
[LfsObjectRegistry] |
A list of nodes. |
pageInfo
|
PageInfo! |
Information to aid in pagination. |
LfsObjectRegistryEdge
The edge type for LfsObjectRegistry
.
Fields
Name | Type | Description |
---|---|---|
cursor
|
String! |
A cursor for use in pagination. |
node
|
LfsObjectRegistry |
The item at the end of the edge. |
LicenseHistoryEntryConnection
The connection type for LicenseHistoryEntry
.
Fields
Name | Type | Description |
---|---|---|
edges
|
[LicenseHistoryEntryEdge] |
A list of edges. |
nodes
|
[LicenseHistoryEntry] |
A list of nodes. |
pageInfo
|
PageInfo! |
Information to aid in pagination. |
LicenseHistoryEntryEdge
The edge type for LicenseHistoryEntry
.
Fields
Name | Type | Description |
---|---|---|
cursor
|
String! |
A cursor for use in pagination. |
node
|
LicenseHistoryEntry |
The item at the end of the edge. |
LinkedWorkItemTypeConnection
The connection type for LinkedWorkItemType
.
Fields
Name | Type | Description |
---|---|---|
edges
|
[LinkedWorkItemTypeEdge] |
A list of edges. |
nodes
|
[LinkedWorkItemType] |
A list of nodes. |
pageInfo
|
PageInfo! |
Information to aid in pagination. |
LinkedWorkItemTypeEdge
The edge type for LinkedWorkItemType
.
Fields
Name | Type | Description |
---|---|---|
cursor
|
String! |
A cursor for use in pagination. |
node
|
LinkedWorkItemType |
The item at the end of the edge. |
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. |
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. |
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. |
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. |
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. |
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. |
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. |
PipelineScheduleConnection
The connection type for PipelineSchedule
.
Fields
Name | Type | Description |
---|---|---|
count
|
Int! |
Total count of collection. |
edges
|
[PipelineScheduleEdge] |
A list of edges. |
nodes
|
[PipelineSchedule] |
A list of nodes. |
pageInfo
|
PageInfo! |
Information to aid in pagination. |
PipelineScheduleEdge
The edge type for PipelineSchedule
.
Fields
Name | Type | Description |
---|---|---|
cursor
|
String! |
A cursor for use in pagination. |
node
|
PipelineSchedule |
The item at the end of the edge. |
PipelineScheduleVariableConnection
The connection type for PipelineScheduleVariable
.
Fields
Name | Type | Description |
---|---|---|
edges
|
[PipelineScheduleVariableEdge] |
A list of edges. |
nodes
|
[PipelineScheduleVariable] |
A list of nodes. |
pageInfo
|
PageInfo! |
Information to aid in pagination. |
PipelineScheduleVariableEdge
The edge type for PipelineScheduleVariable
.
Fields
Name | Type | Description |
---|---|---|
cursor
|
String! |
A cursor for use in pagination. |
node
|
PipelineScheduleVariable |
The item at the end of the edge. |
PipelineSecurityReportFindingConnection
The connection type for PipelineSecurityReportFinding
.
Fields
Name | Type | Description |
---|---|---|
edges
|
[PipelineSecurityReportFindingEdge] |
A list of edges. |
nodes
|
[PipelineSecurityReportFinding] |
A list of nodes. |
pageInfo
|
PageInfo! |
Information to aid in pagination. |
PipelineSecurityReportFindingEdge
The edge type for PipelineSecurityReportFinding
.
Fields
Name | Type | Description |
---|---|---|
cursor
|
String! |
A cursor for use in pagination. |
node
|
PipelineSecurityReportFinding |
The item at the end of the edge. |
PipelineTriggerConnection
The connection type for PipelineTrigger
.
Fields
Name | Type | Description |
---|---|---|
count
|
Int! |
Total count of collection. |
edges
|
[PipelineTriggerEdge] |
A list of edges. |
nodes
|
[PipelineTrigger] |
A list of nodes. |
pageInfo
|
PageInfo! |
Information to aid in pagination. |
PipelineTriggerEdge
The edge type for PipelineTrigger
.
Fields
Name | Type | Description |
---|---|---|
cursor
|
String! |
A cursor for use in pagination. |
node
|
PipelineTrigger |
The item at the end of the edge. |
ProjectConnection
The connection type for Project
.
Fields
Name | Type | Description |
---|---|---|
count
|
Int! |
Total count of collection. |
edges
|
[ProjectEdge] |
A list of edges. |
nodes
|
[Project] |
A list of nodes. |
pageInfo
|
PageInfo! |
Information to aid in pagination. |
ProjectEdge
The edge type for Project
.
Fields
Name | Type | Description |
---|---|---|
cursor
|
String! |
A cursor for use in pagination. |
node
|
Project |
The item at the end of the edge. |
ProjectMemberConnection
The connection type for ProjectMember
.
Fields
Name | Type | Description |
---|---|---|
edges
|
[ProjectMemberEdge] |
A list of edges. |
nodes
|
[ProjectMember] |
A list of nodes. |
pageInfo
|
PageInfo! |
Information to aid in pagination. |
ProjectMemberEdge
The edge type for ProjectMember
.
Fields
Name | Type | Description |
---|---|---|
cursor
|
String! |
A cursor for use in pagination. |
node
|
ProjectMember |
The item at the end of the edge. |
ProjectRepositoryRegistryConnection
The connection type for ProjectRepositoryRegistry
.
Fields
Name | Type | Description |
---|---|---|
edges
|
[ProjectRepositoryRegistryEdge] |
A list of edges. |
nodes
|
[ProjectRepositoryRegistry] |
A list of nodes. |
pageInfo
|
PageInfo! |
Information to aid in pagination. |
ProjectRepositoryRegistryEdge
The edge type for ProjectRepositoryRegistry
.
Fields
Name | Type | Description |
---|---|---|
cursor
|
String! |
A cursor for use in pagination. |
node
|
ProjectRepositoryRegistry |
The item at the end of the edge. |
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. |
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. |
ProjectWikiRepositoryRegistryEdge
The edge type for ProjectWikiRepositoryRegistry
.
Fields
Name | Type | Description |
---|---|---|
cursor
|
String! |
A cursor for use in pagination. |
node
|
ProjectWikiRepositoryRegistry |
The item at the end of the edge. |
ProtectedEnvironmentApprovalRuleConnection
The connection type for ProtectedEnvironmentApprovalRule
.
Fields
Name | Type | Description |
---|---|---|
edges
|
[ProtectedEnvironmentApprovalRuleEdge] |
A list of edges. |
nodes
|
[ProtectedEnvironmentApprovalRule] |
A list of nodes. |
pageInfo
|
PageInfo! |
Information to aid in pagination. |
ProtectedEnvironmentApprovalRuleEdge
The edge type for ProtectedEnvironmentApprovalRule
.
Fields
Name | Type | Description |
---|---|---|
cursor
|
String! |
A cursor for use in pagination. |
node
|
ProtectedEnvironmentApprovalRule |
The item at the end of the edge. |
ProtectedEnvironmentConnection
The connection type for ProtectedEnvironment
.
Fields
Name | Type | Description |
---|---|---|
edges
|
[ProtectedEnvironmentEdge] |
A list of edges. |
nodes
|
[ProtectedEnvironment] |
A list of nodes. |
pageInfo
|
PageInfo! |
Information to aid in pagination. |
ProtectedEnvironmentDeployAccessLevelConnection
The connection type for ProtectedEnvironmentDeployAccessLevel
.
Fields
Name | Type | Description |
---|---|---|
edges
|
[ProtectedEnvironmentDeployAccessLevelEdge] |
A list of edges. |
nodes
|
[ProtectedEnvironmentDeployAccessLevel] |
A list of nodes. |
pageInfo
|
PageInfo! |
Information to aid in pagination. |
ProtectedEnvironmentDeployAccessLevelEdge
The edge type for ProtectedEnvironmentDeployAccessLevel
.
Fields
Name | Type | Description |
---|---|---|
cursor
|
String! |
A cursor for use in pagination. |
node
|
ProtectedEnvironmentDeployAccessLevel |
The item at the end of the edge. |
ProtectedEnvironmentEdge
The edge type for ProtectedEnvironment
.
Fields
Name | Type | Description |
---|---|---|
cursor
|
String! |
A cursor for use in pagination. |
node
|
ProtectedEnvironment |
The item at the end of the edge. |
PushAccessLevelConnection
The connection type for PushAccessLevel
.
Fields
Name | Type | Description |
---|---|---|
edges
|
[PushAccessLevelEdge] |
A list of edges. |
nodes
|
[PushAccessLevel] |
A list of nodes. |
pageInfo
|
PageInfo! |
Information to aid in pagination. |
PushAccessLevelEdge
The edge type for PushAccessLevel
.
Fields
Name | Type | Description |
---|---|---|
cursor
|
String! |
A cursor for use in pagination. |
node
|
PushAccessLevel |
The item at the end of the edge. |
ReleaseAssetLinkConnection
The connection type for ReleaseAssetLink
.
Fields
Name | Type | Description |
---|---|---|
edges
|
[ReleaseAssetLinkEdge] |
A list of edges. |
nodes
|
[ReleaseAssetLink] |
A list of nodes. |
pageInfo
|
PageInfo! |
Information to aid in pagination. |
ReleaseAssetLinkEdge
The edge type for ReleaseAssetLink
.
Fields
Name | Type | Description |
---|---|---|
cursor
|
String! |
A cursor for use in pagination. |
node
|
ReleaseAssetLink |
The item at the end of the edge. |
ReleaseConnection
The connection type for Release
.
Fields
Name | Type | Description |
---|---|---|
count
|
Int! |
Total count of collection. |
edges
|
[ReleaseEdge] |
A list of edges. |
nodes
|
[Release] |
A list of nodes. |
pageInfo
|
PageInfo! |
Information to aid in pagination. |
ReleaseEdge
The edge type for Release
.
Fields
Name | Type | Description |
---|---|---|
cursor
|
String! |
A cursor for use in pagination. |
node
|
Release |
The item at the end of the edge. |
ReleaseEvidenceConnection
The connection type for ReleaseEvidence
.
Fields
Name | Type | Description |
---|---|---|
edges
|
[ReleaseEvidenceEdge] |
A list of edges. |
nodes
|
[ReleaseEvidence] |
A list of nodes. |
pageInfo
|
PageInfo! |
Information to aid in pagination. |
ReleaseEvidenceEdge
The edge type for ReleaseEvidence
.
Fields
Name | Type | Description |
---|---|---|
cursor
|
String! |
A cursor for use in pagination. |
node
|
ReleaseEvidence |
The item at the end of the edge. |
ReleaseSourceConnection
The connection type for ReleaseSource
.
Fields
Name | Type | Description |
---|---|---|
edges
|
[ReleaseSourceEdge] |
A list of edges. |
nodes
|
[ReleaseSource] |
A list of nodes. |
pageInfo
|
PageInfo! |
Information to aid in pagination. |
ReleaseSourceEdge
The edge type for ReleaseSource
.
Fields
Name | Type | Description |
---|---|---|
cursor
|
String! |
A cursor for use in pagination. |
node
|
ReleaseSource |
The item at the end of the edge. |
RepositoryBlobConnection
The connection type for RepositoryBlob
.
Fields
Name | Type | Description |
---|---|---|
edges
|
[RepositoryBlobEdge] |
A list of edges. |
nodes
|
[RepositoryBlob] |
A list of nodes. |
pageInfo
|
PageInfo! |
Information to aid in pagination. |
RepositoryBlobEdge
The edge type for RepositoryBlob
.
Fields
Name | Type | Description |
---|---|---|
cursor
|
String! |
A cursor for use in pagination. |
node
|
RepositoryBlob |
The item at the end of the edge. |
RequirementConnection
The connection type for Requirement
.
Fields
Name | Type | Description |
---|---|---|
edges
|
[RequirementEdge] |
A list of edges. |
nodes
|
[Requirement] |
A list of nodes. |
pageInfo
|
PageInfo! |
Information to aid in pagination. |
RequirementEdge
The edge type for Requirement
.
Fields
Name | Type | Description |
---|---|---|
cursor
|
String! |
A cursor for use in pagination. |
node
|
Requirement |
The item at the end of the edge. |
RunnerArchitectureConnection
The connection type for RunnerArchitecture
.
Fields
Name | Type | Description |
---|---|---|
edges
|
[RunnerArchitectureEdge] |
A list of edges. |
nodes
|
[RunnerArchitecture] |
A list of nodes. |
pageInfo
|
PageInfo! |
Information to aid in pagination. |
RunnerArchitectureEdge
The edge type for RunnerArchitecture
.
Fields
Name | Type | Description |
---|---|---|
cursor
|
String! |
A cursor for use in pagination. |
node
|
RunnerArchitecture |
The item at the end of the edge. |
RunnerPlatformConnection
The connection type for RunnerPlatform
.
Fields
Name | Type | Description |
---|---|---|
edges
|
[RunnerPlatformEdge] |
A list of edges. |
nodes
|
[RunnerPlatform] |
A list of nodes. |
pageInfo
|
PageInfo! |
Information to aid in pagination. |
RunnerPlatformEdge
The edge type for RunnerPlatform
.
Fields
Name | Type | Description |
---|---|---|
cursor
|
String! |
A cursor for use in pagination. |
node
|
RunnerPlatform |
The item at the end of the edge. |
SastCiConfigurationAnalyzersEntityConnection
The connection type for SastCiConfigurationAnalyzersEntity
.
Fields
Name | Type | Description |
---|---|---|
edges
|
[SastCiConfigurationAnalyzersEntityEdge] |
A list of edges. |
nodes
|
[SastCiConfigurationAnalyzersEntity] |
A list of nodes. |
pageInfo
|
PageInfo! |
Information to aid in pagination. |
SastCiConfigurationAnalyzersEntityEdge
The edge type for SastCiConfigurationAnalyzersEntity
.
Fields
Name | Type | Description |
---|---|---|
cursor
|
String! |
A cursor for use in pagination. |
node
|
SastCiConfigurationAnalyzersEntity |
The item at the end of the edge. |
SastCiConfigurationEntityConnection
The connection type for SastCiConfigurationEntity
.
Fields
Name | Type | Description |
---|---|---|
edges
|
[SastCiConfigurationEntityEdge] |
A list of edges. |
nodes
|
[SastCiConfigurationEntity] |
A list of nodes. |
pageInfo
|
PageInfo! |
Information to aid in pagination. |
SastCiConfigurationEntityEdge
The edge type for SastCiConfigurationEntity
.
Fields
Name | Type | Description |
---|---|---|
cursor
|
String! |
A cursor for use in pagination. |
node
|
SastCiConfigurationEntity |
The item at the end of the edge. |
SastCiConfigurationOptionsEntityConnection
The connection type for SastCiConfigurationOptionsEntity
.
Fields
Name | Type | Description |
---|---|---|
edges
|
[SastCiConfigurationOptionsEntityEdge] |
A list of edges. |
nodes
|
[SastCiConfigurationOptionsEntity] |
A list of nodes. |
pageInfo
|
PageInfo! |
Information to aid in pagination. |
SastCiConfigurationOptionsEntityEdge
The edge type for SastCiConfigurationOptionsEntity
.
Fields
Name | Type | Description |
---|---|---|
cursor
|
String! |
A cursor for use in pagination. |
node
|
SastCiConfigurationOptionsEntity |
The item at the end of the edge. |
SavedReplyConnection
The connection type for SavedReply
.
Fields
Name | Type | Description |
---|---|---|
count
|
Int! |
Total count of collection. |
edges
|
[SavedReplyEdge] |
A list of edges. |
nodes
|
[SavedReply] |
A list of nodes. |
pageInfo
|
PageInfo! |
Information to aid in pagination. |
SavedReplyEdge
The edge type for SavedReply
.
Fields
Name | Type | Description |
---|---|---|
cursor
|
String! |
A cursor for use in pagination. |
node
|
SavedReply |
The item at the end of the edge. |
ScanConnection
The connection type for Scan
.
Fields
Name | Type | Description |
---|---|---|
edges
|
[ScanEdge] |
A list of edges. |
nodes
|
[Scan] |
A list of nodes. |
pageInfo
|
PageInfo! |
Information to aid in pagination. |
ScanEdge
The edge type for Scan
.
Fields
Name | Type | Description |
---|---|---|
cursor
|
String! |
A cursor for use in pagination. |
node
|
Scan |
The item at the end of the edge. |
ScanExecutionPolicyConnection
The connection type for ScanExecutionPolicy
.
Fields
Name | Type | Description |
---|---|---|
edges
|
[ScanExecutionPolicyEdge] |
A list of edges. |
nodes
|
[ScanExecutionPolicy] |
A list of nodes. |
pageInfo
|
PageInfo! |
Information to aid in pagination. |
ScanExecutionPolicyEdge
The edge type for ScanExecutionPolicy
.
Fields
Name | Type | Description |
---|---|---|
cursor
|
String! |
A cursor for use in pagination. |
node
|
ScanExecutionPolicy |
The item at the end of the edge. |
ScanResultPolicyConnection
The connection type for ScanResultPolicy
.
Fields
Name | Type | Description |
---|---|---|
edges
|
[ScanResultPolicyEdge] |
A list of edges. |
nodes
|
[ScanResultPolicy] |
A list of nodes. |
pageInfo
|
PageInfo! |
Information to aid in pagination. |
ScanResultPolicyEdge
The edge type for ScanResultPolicy
.
Fields
Name | Type | Description |
---|---|---|
cursor
|
String! |
A cursor for use in pagination. |
node
|
ScanResultPolicy |
The item at the end of the edge. |
ScannedResourceConnection
The connection type for ScannedResource
.
Fields
Name | Type | Description |
---|---|---|
edges
|
[ScannedResourceEdge] |
A list of edges. |
nodes
|
[ScannedResource] |
A list of nodes. |
pageInfo
|
PageInfo! |
Information to aid in pagination. |
ScannedResourceEdge
The edge type for ScannedResource
.
Fields
Name | Type | Description |
---|---|---|
cursor
|
String! |
A cursor for use in pagination. |
node
|
ScannedResource |
The item at the end of the edge. |
SentryErrorConnection
The connection type for SentryError
.
Fields
Name | Type | Description |
---|---|---|
edges
|
[SentryErrorEdge] |
A list of edges. |
nodes
|
[SentryError] |
A list of nodes. |
pageInfo
|
PageInfo! |
Information to aid in pagination. |
SentryErrorEdge
The edge type for SentryError
.
Fields
Name | Type | Description |
---|---|---|
cursor
|
String! |
A cursor for use in pagination. |
node
|
SentryError |
The item at the end of the edge. |
ServiceConnection
The connection type for Service
.
Fields
Name | Type | Description |
---|---|---|
edges
|
[ServiceEdge] |
A list of edges. |
nodes
|
[Service] |
A list of nodes. |
pageInfo
|
PageInfo! |
Information to aid in pagination. |
ServiceEdge
The edge type for Service
.
Fields
Name | Type | Description |
---|---|---|
cursor
|
String! |
A cursor for use in pagination. |
node
|
Service |
The item at the end of the edge. |
SnippetBlobConnection
The connection type for SnippetBlob
.
Fields
Name | Type | Description |
---|---|---|
edges
|
[SnippetBlobEdge] |
A list of edges. |
hasUnretrievableBlobs
|
Boolean! |
Indicates if the snippet has unretrievable blobs. |
nodes
|
[SnippetBlob] |
A list of nodes. |
pageInfo
|
PageInfo! |
Information to aid in pagination. |
SnippetBlobEdge
The edge type for SnippetBlob
.
Fields
Name | Type | Description |
---|---|---|
cursor
|
String! |
A cursor for use in pagination. |
node
|
SnippetBlob |
The item at the end of the edge. |
SnippetConnection
The connection type for Snippet
.
Fields
Name | Type | Description |
---|---|---|
edges
|
[SnippetEdge] |
A list of edges. |
nodes
|
[Snippet] |
A list of nodes. |
pageInfo
|
PageInfo! |
Information to aid in pagination. |
SnippetEdge
The edge type for Snippet
.
Fields
Name | Type | Description |
---|---|---|
cursor
|
String! |
A cursor for use in pagination. |
node
|
Snippet |
The item at the end of the edge. |
SnippetRepositoryRegistryConnection
The connection type for SnippetRepositoryRegistry
.
Fields
Name | Type | Description |
---|---|---|
edges
|
[SnippetRepositoryRegistryEdge] |
A list of edges. |
nodes
|
[SnippetRepositoryRegistry] |
A list of nodes. |
pageInfo
|
PageInfo! |
Information to aid in pagination. |
SnippetRepositoryRegistryEdge
The edge type for SnippetRepositoryRegistry
.
Fields
Name | Type | Description |
---|---|---|
cursor
|
String! |
A cursor for use in pagination. |
node
|
SnippetRepositoryRegistry |
The item at the end of the edge. |
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. |
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. |
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 |
---|---|---|
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. |
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. |
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
|
LabelConnection |
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
|
ID! |
Label ID. |
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 {warning-solid}
|
UserAchievementConnection |
Introduced in GitLab 15.10. Status: Experiment. Recipients for the achievement. |
AddOnPurchase
Represents AddOn purchase for Namespace.
Fields
Name | Type | Description |
---|---|---|
assignedQuantity
|
Int! |
Number of seats assigned. |
id
|
GitlabSubscriptionsAddOnPurchaseID! |
ID of AddOnPurchase. |
name
|
String! |
Name of AddOn. |
purchasedQuantity
|
Int! |
Number of seats purchased. |
AddOnUser
A user with add-on data.
Fields
Name | Type | Description |
---|---|---|
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 {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
|
ID! |
ID of the user. |
ide
|
Ide |
IDE settings. |
jobTitle
|
String |
Job title of the user. |
lastActivityOn
|
Date |
Date the user last performed any actions. |
lastLoginAt
|
Time |
Timestamp of the last sign in. |
linkedin
|
String |
LinkedIn profile name of the user. |
location
|
String |
Location of the user. |
name
|
String! |
Human-readable name of the user. Returns **** if the user is a project bot and the requester does not have permission to view the project. |
namespace
|
Namespace |
Personal namespace of the user. |
namespaceCommitEmails
|
NamespaceCommitEmailConnection |
User's custom namespace commit emails. (see Connections) |
organization
|
String |
Who the user represents or works for. |
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. |
userPermissions
|
UserPermissions! |
Permissions for the current user on the resource. |
userPreferences
|
UserPreferences |
Preferences for the user. |
username
|
String! |
Username of the user. Unique within this instance of GitLab. |
webPath
|
String! |
Web path of the user. |
webUrl
|
String! |
Web URL of the user. |
Fields with arguments
AddOnUser.addOnAssignments
Add-on purchase assignments for the user.
DETAILS: Introduced in GitLab 16.4. Status: Experiment.
Returns UserAddOnAssignmentConnection
.
This field returns a connection. It accepts the
four standard pagination arguments:
before: String
, after: String
, first: Int
, and last: Int
.
Arguments
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. |
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. |
iids
|
[String!] |
Array of IIDs of merge requests, for example [1, 2] . |
includeArchived
|
Boolean |
Merge requests from archived projects. |
labelName
|
[String] |
Labels applied to the merge request. |
labels {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. |
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 {warning-solid}
|
MergeRequestReviewState |
Introduced in GitLab 17.0. Status: Experiment. Reviewer state of the merge request. |
reviewStates {warning-solid}
|
[MergeRequestReviewState!] |
Introduced in GitLab 17.0. Status: Experiment. Reviewer states of the merge request. |
reviewerUsername
|
String |
Username of the reviewer. |
reviewerWildcardId
|
ReviewerWildcardId |
Filter by reviewer presence. Incompatible with reviewerUsername. |
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 {warning-solid}
|
SubscriptionStatus |
Introduced in GitLab 17.5. Status: Experiment. Merge requests the current user is subscribed to. Is ignored if filter_subscriptions feature flag is disabled. |
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. |
assigneeWildcardId
|
AssigneeWildcardId |
Filter by assignee presence. Incompatible with assigneeUsernames and assigneeUsername. |
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. |
iids
|
[String!] |
Array of IIDs of merge requests, for example [1, 2] . |
includeArchived
|
Boolean |
Merge requests from archived projects. |
labelName
|
[String] |
Labels applied to the merge request. |
labels {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. |
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 {warning-solid}
|
MergeRequestReviewState |
Introduced in GitLab 17.0. Status: Experiment. Reviewer state of the merge request. |
reviewStates {warning-solid}
|
[MergeRequestReviewState!] |
Introduced in GitLab 17.0. Status: Experiment. Reviewer states of the merge request. |
reviewerUsername
|
String |
Username of the reviewer. |
reviewerWildcardId
|
ReviewerWildcardId |
Filter by reviewer presence. Incompatible with reviewerUsername. |
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 {warning-solid}
|
SubscriptionStatus |
Introduced in GitLab 17.5. Status: Experiment. Merge requests the current user is subscribed to. Is ignored if filter_subscriptions feature flag is disabled. |
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. |
AddOnUser.organizations
Organizations where the user has access.
DETAILS: Introduced in GitLab 16.6. Status: Experiment.
Returns OrganizationConnection
.
This field returns a connection. It accepts the
four standard pagination arguments:
before: String
, after: String
, first: Int
, and last: Int
.
Arguments
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. |
assigneeWildcardId
|
AssigneeWildcardId |
Filter by assignee presence. Incompatible with assigneeUsernames and assigneeUsername. |
authorUsername
|
String |
Username of the author. |
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. |
iids
|
[String!] |
Array of IIDs of merge requests, for example [1, 2] . |
includeArchived
|
Boolean |
Merge requests from archived projects. |
labelName
|
[String] |
Labels applied to the merge request. |
labels {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. |
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 {warning-solid}
|
MergeRequestReviewState |
Introduced in GitLab 17.0. Status: Experiment. Reviewer state of the merge request. |
reviewStates {warning-solid}
|
[MergeRequestReviewState!] |
Introduced in GitLab 17.0. Status: Experiment. Reviewer states of the merge request. |
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 {warning-solid}
|
SubscriptionStatus |
Introduced in GitLab 17.5. Status: Experiment. Merge requests the current user is subscribed to. Is ignored if filter_subscriptions feature flag is disabled. |
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. |
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.
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 {warning-solid}
|
[String!] |
Deprecated in GitLab 16.7. Use actual_states instead. |
projectIds
|
[ProjectID!] |
Filter workspaces by project GlobalIDs. |
AgentConfiguration
Configuration details for an Agent.
Fields
Name | Type | Description |
---|---|---|
agentName
|
String |
Name of the agent. |
AgentMetadata
Information about a connected Agent.
Fields
Name | Type | Description |
---|---|---|
commit
|
String |
Agent version commit. |
podName
|
String |
Name of the pod running the Agent. |
podNamespace
|
String |
Namespace of the pod running the Agent. |
version
|
String |
Agent version tag. |
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. |
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. |
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
Fields
Name | Type | Description |
---|---|---|
codeContributorsCount
|
Int |
Number of code contributors. |
codeSuggestionsAcceptedCount
|
Int |
Total count of code suggestions accepted by code contributors. |
codeSuggestionsContributorsCount
|
Int |
Number of code contributors who used GitLab Duo Code Suggestions features. |
codeSuggestionsShownCount
|
Int |
Total count of code suggestions shown to code contributors. |
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. |
duoProAssignedUsersCount {warning-solid}
|
Int |
Deprecated in GitLab 17.6. use duoAssignedUsersCount for the same behavior. |
duoUsedCount
|
Int |
Number of contributors who used any GitLab Duo feature. |
AiSelfHostedModel
Self-hosted LLM servers.
Fields
Name | Type | Description |
---|---|---|
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. |
name
|
String! |
Deployment name of the self-hosted model. |
updatedAt
|
Time |
Timestamp of last update. |
AiUsageData
Fields
Name | Type | Description |
---|---|---|
codeSuggestionEvents
|
CodeSuggestionEventConnection |
Events related to code suggestions feature. (see Connections) |
AiUserMetrics
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
|
UserCore! |
Metrics user. |
AlertManagementAlert
Describes an alert from the project's Alert Management.
Fields
Name | Type | Description |
---|---|---|
assignees
|
UserCoreConnection |
Assignees of the alert. (see Connections) |
commenters
|
UserCoreConnection! |
All commenters on this noteable. (see Connections) |
createdAt
|
Time |
Timestamp the alert was created. |
description
|
String |
Description of the alert. |
details
|
JSON |
Alert details. |
detailsUrl
|
String! |
URL of the alert detail page. |
discussions
|
DiscussionConnection! |
All discussions on this noteable. (see Connections) |
endedAt
|
Time |
Timestamp the alert ended. |
environment
|
Environment |
Environment for the alert. |
eventCount
|
Int |
Number of events of 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 {warning-solid}
|
String |
Deprecated in GitLab 13.10. Use issue field. |
metricsDashboardUrl {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 this object. |
prometheusAlert {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. |
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. |
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. |
deprecatedProperties {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 this 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 this approval rule. (see Connections) |
id
|
GlobalID! |
ID of the rule. |
name
|
String |
Name of the rule. |
type
|
ApprovalRuleType |
Type of the rule. |
ApprovalRule
Describes a rule for who can approve merge requests.
Fields
Name | Type | Description |
---|---|---|
allowMergeWhenInvalid
|
Boolean |
Indicates if the rule can be ignored if it is invalid. |
approvalsRequired
|
Int |
Number of required approvals. |
approved
|
Boolean |
Indicates if the rule is satisfied. |
approvedBy
|
UserCoreConnection |
List of users defined in the rule that approved the merge request. (see Connections) |
commentedBy
|
UserCoreConnection |
List of users, defined in the rule, who commented on the merge request. (see Connections) |
containsHiddenGroups
|
Boolean |
Indicates if the rule contains approvers from a hidden group. |
eligibleApprovers
|
[UserCore!] |
List of all users eligible to approve the merge request (defined explicitly and from associated groups). |
groups
|
GroupConnection |
List of groups added as approvers for the rule. (see Connections) |
id
|
GlobalID! |
ID of the rule. |
invalid
|
Boolean |
Indicates if the rule is invalid and cannot be approved. |
name
|
String |
Name of the rule. |
overridden
|
Boolean |
Indicates if the rule was overridden for the merge request. |
scanResultPolicies
|
[ApprovalScanResultPolicy!] |
List of scan result policies associated with the rule. |
section
|
String |
Named section of the Code Owners file that the rule applies to. |
sourceRule
|
ApprovalRule |
Source rule used to create the rule. |
type
|
ApprovalRuleType |
Type of the rule. |
users
|
UserCoreConnection |
List of users added as approvers for the rule. (see Connections) |
ApprovalScanResultPolicy
Represents the scan result policy.
Fields
Name | Type | Description |
---|---|---|
approvalsRequired
|
Int! |
Represents the required approvals defined in the policy. |
name
|
String! |
Represents the name of the policy. |
reportType
|
ApprovalReportType! |
Represents the report_type of the approval rule. |
AssetType
Represents a vulnerability asset type.
Fields
Name | Type | Description |
---|---|---|
name
|
String! |
Name of the asset. |
type
|
String! |
Type of the asset. |
url
|
String! |
URL of the asset. |
AuditEventDefinition
Represents the YAML definitions for audit events defined in ee/config/audit_events/types/<event-type-name>.yml
and config/audit_events/types/<event-type-name>.yml
.
Fields
Name | Type | Description |
---|---|---|
description
|
String! |
Description of what action the audit event tracks. |
featureCategory
|
String! |
Feature category associated with the event. |
introducedByIssue
|
String |
Link to the issue introducing the event. For olderaudit events, it can be a commit URL rather than amerge request URL. |
introducedByMr
|
String |
Link to the merge request introducing the event. Forolder audit events, it can be a commit URL rather thana merge request URL. |
milestone
|
String! |
Milestone the event was introduced in. |
name
|
String! |
Key name of the audit event. |
savedToDatabase
|
Boolean! |
Indicates if the event is saved to PostgreSQL database. |
streamed
|
Boolean! |
Indicates if the event is streamed to an external destination. |
AuditEventStreamingHTTPNamespaceFilter
Represents a subgroup or project filter that belongs to an external audit event streaming destination.
Fields
Name | Type | Description |
---|---|---|
externalAuditEventDestination
|
ExternalAuditEventDestination! |
Destination to which the filter belongs. |
id
|
ID! |
ID of the filter. |
namespace
|
Namespace! |
Group or project namespace the filter belongs to. |
AuditEventStreamingHeader
Represents a HTTP header key/value that belongs to an audit streaming destination.
Fields
Name | Type | Description |
---|---|---|
active
|
Boolean! |
Header is active or not. |
id
|
ID! |
ID of the header. |
key
|
String! |
Key of the header. |
value
|
String! |
Value of the header. |
AuditEventsStreamingHTTPNamespaceFiltersAddPayload
Autogenerated return type of AuditEventsStreamingHTTPNamespaceFiltersAdd.
Fields
Name | Type | Description |
---|---|---|
clientMutationId
|
String |
A unique identifier for the client performing the mutation. |
errors
|
[String!]! |
Errors encountered during execution of the mutation. |
namespaceFilter
|
AuditEventStreamingHTTPNamespaceFilter |
Namespace filter created. |
AuditEventsStreamingHTTPNamespaceFiltersDeletePayload
Autogenerated return type of AuditEventsStreamingHTTPNamespaceFiltersDelete.
Fields
Name | Type | Description |
---|---|---|
clientMutationId
|
String |
A unique identifier for the client performing the mutation. |
errors
|
[String!]! |
Errors encountered during execution of the mutation. |
AuditEventsStreamingInstanceHeader
Represents a HTTP header key/value that belongs to an instance level audit streaming destination.
Fields
Name | Type | Description |
---|---|---|
active
|
Boolean! |
Header is active or not. |
id
|
ID! |
ID of the header. |
key
|
String! |
Key of the header. |
value
|
String! |
Value of the header. |
AutocompletedUser
Core representation of a GitLab user.
Fields
Name | Type | Description |
---|---|---|
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 {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
|
ID! |
ID of the user. |
ide
|
Ide |
IDE settings. |
jobTitle
|
String |
Job title of the user. |
lastActivityOn
|
Date |
Date the user last performed any actions. |
linkedin
|
String |
LinkedIn profile name of the user. |
location
|
String |
Location of the user. |
name
|
String! |
Human-readable name of the user. Returns **** if the user is a project bot and the requester does not have permission to view the project. |
namespace
|
Namespace |
Personal namespace of the user. |
namespaceCommitEmails
|
NamespaceCommitEmailConnection |
User's custom namespace commit emails. (see Connections) |
organization
|
String |
Who the user represents or works for. |
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. |
userPermissions
|
UserPermissions! |
Permissions for the current user on the resource. |
userPreferences
|
UserPreferences |
Preferences for the user. |
username
|
String! |
Username of the user. Unique within this instance of GitLab. |
webPath
|
String! |
Web path of the user. |
webUrl
|
String! |
Web URL of the user. |
Fields with arguments
AutocompletedUser.assignedMergeRequests
Merge requests assigned to the user.
Returns MergeRequestConnection
.
This field returns a connection. It accepts the
four standard pagination arguments:
before: String
, after: String
, first: Int
, and last: Int
.
Arguments
Name | Type | Description |
---|---|---|
approved
|
Boolean |
Limit results to approved merge requests. Available only when the feature flag mr_approved_filter is enabled. |
approvedBy
|
[String!] |
Usernames of the approvers. |
approver
|
[String!] |
Usernames of possible approvers. |
authorUsername
|
String |
Username of the author. |
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. |
iids
|
[String!] |
Array of IIDs of merge requests, for example [1, 2] . |
includeArchived
|
Boolean |
Merge requests from archived projects. |
labelName
|
[String] |
Labels applied to the merge request. |
labels {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. |
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 {warning-solid}
|
MergeRequestReviewState |
Introduced in GitLab 17.0. Status: Experiment. Reviewer state of the merge request. |
reviewStates {warning-solid}
|
[MergeRequestReviewState!] |
Introduced in GitLab 17.0. Status: Experiment. Reviewer states of the merge request. |
reviewerUsername
|
String |
Username of the reviewer. |
reviewerWildcardId
|
ReviewerWildcardId |
Filter by reviewer presence. Incompatible with reviewerUsername. |
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 {warning-solid}
|
SubscriptionStatus |
Introduced in GitLab 17.5. Status: Experiment. Merge requests the current user is subscribed to. Is ignored if filter_subscriptions feature flag is disabled. |
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. |
assigneeWildcardId
|
AssigneeWildcardId |
Filter by assignee presence. Incompatible with assigneeUsernames and assigneeUsername. |
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. |
iids
|
[String!] |
Array of IIDs of merge requests, for example [1, 2] . |
includeArchived
|
Boolean |
Merge requests from archived projects. |
labelName
|
[String] |
Labels applied to the merge request. |
labels {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. |
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 {warning-solid}
|
MergeRequestReviewState |
Introduced in GitLab 17.0. Status: Experiment. Reviewer state of the merge request. |
reviewStates {warning-solid}
|
[MergeRequestReviewState!] |
Introduced in GitLab 17.0. Status: Experiment. Reviewer states of the merge request. |
reviewerUsername
|
String |
Username of the reviewer. |
reviewerWildcardId
|
ReviewerWildcardId |
Filter by reviewer presence. Incompatible with reviewerUsername. |
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 {warning-solid}
|
SubscriptionStatus |
Introduced in GitLab 17.5. Status: Experiment. Merge requests the current user is subscribed to. Is ignored if filter_subscriptions feature flag is disabled. |
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. |
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.
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. |
assigneeWildcardId
|
AssigneeWildcardId |
Filter by assignee presence. Incompatible with assigneeUsernames and assigneeUsername. |
authorUsername
|
String |
Username of the author. |
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. |
iids
|
[String!] |
Array of IIDs of merge requests, for example [1, 2] . |
includeArchived
|
Boolean |
Merge requests from archived projects. |
labelName
|
[String] |
Labels applied to the merge request. |
labels {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. |
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 {warning-solid}
|
MergeRequestReviewState |
Introduced in GitLab 17.0. Status: Experiment. Reviewer state of the merge request. |
reviewStates {warning-solid}
|
[MergeRequestReviewState!] |
Introduced in GitLab 17.0. Status: Experiment. Reviewer states of the merge request. |
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 {warning-solid}
|
SubscriptionStatus |
Introduced in GitLab 17.5. Status: Experiment. Merge requests the current user is subscribed to. Is ignored if filter_subscriptions feature flag is disabled. |
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...