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 interactively using the GraphiQL IDE.
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.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.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. |
Query.ciMinutesUsage
CI/CD minutes 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
, last: Int
.
Arguments
Name |
Type |
Description |
namespaceId
|
NamespaceID |
Global ID of the Namespace for the monthly CI/CD minutes usage. |
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
, last: Int
.
Query.containerRepository
Find a container repository.
Returns ContainerRepositoryDetails
.
Arguments
Query.currentLicense
Fields related to the current license.
Returns CurrentLicense
.
Query.currentUser
Get information about current user.
Returns UserCore
.
Query.designManagement
Fields related to design management.
Returns DesignManagement!
.
Query.devopsAdoptionEnabledNamespaces
Get configured DevOps adoption namespaces. BETA This endpoint is subject to change without notice.
Returns DevopsAdoptionEnabledNamespaceConnection
.
This field returns a connection. It accepts the
four standard pagination arguments:
before: String
, after: String
, first: Int
, last: Int
.
Arguments
Name |
Type |
Description |
displayNamespaceId
|
NamespaceID |
Filter by display namespace. |
Query.echo
Testing endpoint to validate the API with.
Returns String!
.
Arguments
Name |
Type |
Description |
text
|
String! |
Text to echo back. |
Query.epicBoardList
Returns EpicList
.
Arguments
Name |
Type |
Description |
epicFilters
|
EpicFilters |
Filters applied when getting epic metadata in the epic board list. |
id
|
BoardsEpicListID! |
Global ID of the list. |
Query.geoNode
Find a Geo node.
Returns GeoNode
.
Arguments
Name |
Type |
Description |
name
|
String |
Name of the Geo node. Defaults to the current Geo node name. |
Query.gitpodEnabled
Whether Gitpod is enabled in application settings.
Returns Boolean
.
Query.group
Find a group.
Returns Group
.
Arguments
Name |
Type |
Description |
fullPath
|
ID! |
Full path of the project, group, or namespace. For example, gitlab-org/gitlab-foss . |
Query.instanceSecurityDashboard
Fields related to Instance Security Dashboard.
Returns InstanceSecurityDashboard
.
Query.issue
Find an issue.
Returns Issue
.
Arguments
Name |
Type |
Description |
id
|
IssueID! |
Global ID of the issue. |
Query.iteration
Find an iteration.
Returns Iteration
.
Arguments
Name |
Type |
Description |
id
|
IterationID! |
Find an iteration by its ID. |
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
, last: Int
.
Query.mergeRequest
Find a merge request.
Returns MergeRequest
.
Arguments
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.namespace
Find a namespace.
Returns Namespace
.
Arguments
Name |
Type |
Description |
fullPath
|
ID! |
Full path of the project, group, or namespace. For example, gitlab-org/gitlab-foss . |
Query.package
Find a package. This field can only be resolved for one query in any single request.
Returns PackageDetailsType
.
Arguments
Query.project
Find a project.
Returns Project
.
Arguments
Name |
Type |
Description |
fullPath
|
ID! |
Full path of the project, group, or namespace. For example, gitlab-org/gitlab-foss . |
Query.projects
Find projects visible to the current user.
Returns ProjectConnection
.
This field returns a connection. It accepts the
four standard pagination arguments:
before: String
, after: String
, first: Int
, last: Int
.
Arguments
Name |
Type |
Description |
ids
|
[ID!] |
Filter projects by IDs. |
membership
|
Boolean |
Return only projects that the current user is a member of. |
search
|
String |
Search query, which can be for the project name, a path, or a description. |
searchNamespaces
|
Boolean |
Include namespace in project search. |
sort
|
String |
Sort order of results. Format: '<field_name>_<sort_direction>', for example: 'id_desc' or 'name_asc'. |
topics
|
[String!] |
Filter projects by topics. |
Query.queryComplexity
Information about the complexity of the GraphQL query.
Returns QueryComplexity
.
Query.runner
Find a runner.
Returns CiRunner
.
Arguments
Query.runnerPlatforms
Supported runner platforms.
Returns RunnerPlatformConnection
.
This field returns a connection. It accepts the
four standard pagination arguments:
before: String
, after: String
, first: Int
, last: Int
.
Query.runnerSetup
Runner setup instructions.
Returns RunnerSetup
.
Arguments
Name |
Type |
Description |
architecture
|
String! |
Architecture to generate the instructions for. |
groupId {warning-solid}
|
GroupID |
Deprecated in 13.11. No longer used. |
platform
|
String! |
Platform to generate the instructions for. |
projectId {warning-solid}
|
ProjectID |
Deprecated in 13.11. No longer used. |
Query.runners
Find runners visible to the current user.
Returns CiRunnerConnection
.
This field returns a connection. It accepts the
four standard pagination arguments:
before: String
, after: String
, first: Int
, last: Int
.
Arguments
Name |
Type |
Description |
active {warning-solid}
|
Boolean |
Deprecated in 14.8. This was renamed. Use: paused . |
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. |
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
, last: Int
.
Arguments
Name |
Type |
Description |
authorId
|
UserID |
ID of an author. |
explore
|
Boolean |
Explore personal snippets. |
ids
|
[SnippetID!] |
Array of global snippet IDs. For example, gid://gitlab/ProjectSnippet/1 . |
projectId
|
ProjectID |
ID of a project. |
type
|
TypeEnum |
Type of snippet. |
visibility
|
VisibilityScopesEnum |
Visibility of the snippet. |
Query.subscriptionFutureEntries
Fields related to entries in future subscriptions.
Returns SubscriptionFutureEntryConnection
.
This field returns a connection. It accepts the
four standard pagination arguments:
before: String
, after: String
, first: Int
, last: Int
.
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
, 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. |
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
, 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
, last: Int
.
Arguments
Name |
Type |
Description |
identifier
|
MeasurementIdentifier! |
Type of measurement or statistics to retrieve. |
recordedAfter
|
Time |
Measurement recorded after this date. |
recordedBefore
|
Time |
Measurement recorded before this date. |
Query.user
Find a user.
Returns UserCore
.
Arguments
Name |
Type |
Description |
id
|
UserID |
ID of the User. |
username
|
String |
Username of the User. |
Query.users
Find users.
Returns UserCoreConnection
.
This field returns a connection. It accepts the
four standard pagination arguments:
before: String
, after: String
, first: Int
, last: Int
.
Arguments
Name |
Type |
Description |
admins
|
Boolean |
Return only admin users. |
ids
|
[ID!] |
List of user Global IDs. |
search
|
String |
Query to search users by name, username, or primary email. |
sort
|
Sort |
Sort users by this criteria. |
usernames
|
[String!] |
List of usernames. |
Query.vulnerabilities
Vulnerabilities reported on projects on the current user's instance security dashboard.
Returns VulnerabilityConnection
.
This field returns a connection. It accepts the
four standard pagination arguments:
before: String
, after: String
, first: Int
, 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. |
hasIssues
|
Boolean |
Returns only the vulnerabilities which have linked issues. |
hasResolution
|
Boolean |
Returns only the vulnerabilities which have been resolved on default branch. |
image
|
[String!] |
Filter vulnerabilities by location image. When this filter is present, the response only matches entries for a reportType that includes container_scanning , cluster_image_scanning . |
projectId
|
[ID!] |
Filter vulnerabilities by project. |
reportType
|
[VulnerabilityReportType!] |
Filter vulnerabilities by report type. |
scanner
|
[String!] |
Filter vulnerabilities by VulnerabilityScanner.externalId. |
scannerId
|
[VulnerabilitiesScannerID!] |
Filter vulnerabilities by scanner ID. |
severity
|
[VulnerabilitySeverity!] |
Filter vulnerabilities by severity. |
sort
|
VulnerabilitySort |
List vulnerabilities by sort order. |
state
|
[VulnerabilityState!] |
Filter vulnerabilities by state. |
Query.vulnerabilitiesCountByDay
The historical number of vulnerabilities per day for the projects on the current user's instance security dashboard.
Returns VulnerabilitiesCountByDayConnection
.
This field returns a connection. It accepts the
four standard pagination arguments:
before: String
, after: String
, first: Int
, 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
Query.workItem
Find a work item. Returns null
if work_items
feature flag is disabled.
WARNING:
Introduced in 15.1.
This feature is in Alpha. It can be changed or removed at any time.
Returns WorkItem
.
Arguments
Name |
Type |
Description |
id
|
WorkItemID! |
Global ID of the work item. |
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.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 |
artifactSize
|
String |
Delete jobs matching artifact_size 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. |
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. |
pipelineId
|
String |
Delete jobs matching pipeline_id in the context metadata. |
project
|
String |
Delete jobs matching project in the context metadata. |
queueName
|
String! |
Name of the queue to delete jobs from. |
relatedClass
|
String |
Delete jobs matching related_class in the context metadata. |
remoteIp
|
String |
Delete jobs matching remote_ip in the context metadata. |
rootCallerId
|
String |
Delete jobs matching root_caller_id in the context metadata. |
rootNamespace
|
String |
Delete jobs matching root_namespace in the context metadata. |
subscriptionPlan
|
String |
Delete jobs matching subscription_plan in the context metadata. |
user
|
String |
Delete jobs matching user in the context metadata. |
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.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.apiFuzzingCiConfigurationCreate
WARNING:
Deprecated in 15.1.
The configuration snippet is now generated client-side.
Input type: ApiFuzzingCiConfigurationCreateInput
Arguments
Name |
Type |
Description |
apiSpecificationFile
|
String! |
File path or URL to the file that defines the API surface for scanning. Must be in the format specified by the scanMode argument. |
authPassword
|
String |
CI variable containing the password for authenticating with the target API. |
authUsername
|
String |
CI variable containing the username for authenticating with the target API. |
clientMutationId
|
String |
A unique identifier for the client performing the mutation. |
projectPath
|
ID! |
Full path of the project. |
scanMode
|
ApiFuzzingScanMode! |
Mode for API fuzzing scans. |
scanProfile
|
String |
Name of a default profile to use for scanning. Ex: Quick-10. |
target
|
String! |
URL for the target of API fuzzing scans. |
Fields
Name |
Type |
Description |
clientMutationId
|
String |
A unique identifier for the client performing the mutation. |
configurationYaml {warning-solid}
|
String |
Deprecated: The configuration snippet is now generated client-side. Deprecated in 14.6. |
errors
|
[String!]! |
Errors encountered during execution of the mutation. |
gitlabCiYamlEditPath {warning-solid}
|
String |
Deprecated: The configuration snippet is now generated client-side. Deprecated in 14.6. |
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.auditEventsStreamingHeadersCreate
Input type: AuditEventsStreamingHeadersCreateInput
Arguments
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
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
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.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 |
Award emoji 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 |
Award emoji 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 |
Award emoji after mutation. |
clientMutationId
|
String |
A unique identifier for the client performing the mutation. |
errors
|
[String!]! |
Errors encountered during execution of the mutation. |
toggledOn
|
Boolean! |
Indicates the status of the emoji. True if the toggle awarded the emoji, and false if the toggle removed the emoji. |
Mutation.boardEpicCreate
Input type: BoardEpicCreateInput
Arguments
Name |
Type |
Description |
boardId
|
BoardsEpicBoardID! |
Global ID of the board that the epic is in. |
clientMutationId
|
String |
A unique identifier for the client performing the mutation. |
groupPath
|
ID! |
Group the epic to create is in. |
listId
|
BoardsEpicListID! |
Global ID of the epic board list in which epic will be created. |
title
|
String! |
Title of the epic. |
Fields
Name |
Type |
Description |
clientMutationId
|
String |
A unique identifier for the client performing the mutation. |
epic
|
Epic |
Epic after creation. |
errors
|
[String!]! |
Errors encountered during execution of the mutation. |
Mutation.boardListCreate
Input type: BoardListCreateInput
Arguments
Name |
Type |
Description |
assigneeId
|
UserID |
Global ID of an existing user. |
backlog
|
Boolean |
Create the backlog list. |
boardId
|
BoardID! |
Global ID of the issue board to mutate. |
clientMutationId
|
String |
A unique identifier for the client performing the mutation. |
iterationId
|
IterationID |
Global ID of an existing iteration. |
labelId
|
LabelID |
Global ID of an existing label. |
milestoneId
|
MilestoneID |
Global ID of an existing milestone. |
Fields
Name |
Type |
Description |
clientMutationId
|
String |
A unique identifier for the client performing the mutation. |
errors
|
[String!]! |
Errors encountered during execution of the mutation. |
list
|
BoardList |
Issue list in the issue board. |
Mutation.boardListUpdateLimitMetrics
Input type: BoardListUpdateLimitMetricsInput
Arguments
Name |
Type |
Description |
clientMutationId
|
String |
A unique identifier for the client performing the mutation. |
limitMetric
|
ListLimitMetric |
New limit metric type for the list. |
listId
|
ListID! |
Global ID of the list. |
maxIssueCount
|
Int |
New maximum issue count limit. |
maxIssueWeight
|
Int |
New maximum issue weight limit. |
Fields
Name |
Type |
Description |
clientMutationId
|
String |
A unique identifier for the client performing the mutation. |
errors
|
[String!]! |
Errors encountered during execution of the mutation. |
list
|
BoardList |
Updated list. |
Mutation.bulkEnableDevopsAdoptionNamespaces
BETA This endpoint is subject to change without notice.
Input type: BulkEnableDevopsAdoptionNamespacesInput
Arguments
Name |
Type |
Description |
clientMutationId
|
String |
A unique identifier for the client performing the mutation. |
displayNamespaceId
|
NamespaceID |
Display namespace ID. |
namespaceIds
|
[NamespaceID!]! |
List of Namespace IDs. |
Fields
Name |
Type |
Description |
clientMutationId
|
String |
A unique identifier for the client performing the mutation. |
enabledNamespaces
|
[DevopsAdoptionEnabledNamespace!] |
Enabled namespaces after mutation. |
errors
|
[String!]! |
Errors encountered during execution of the mutation. |
Mutation.bulkRunnerDelete
WARNING:
Introduced in 15.3.
This feature is in Alpha. It can be changed or removed at any time.
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.ciCdSettingsUpdate
WARNING:
Deprecated in 15.0.
This was renamed.
Use: ProjectCiCdSettingsUpdate
.
Input type: CiCdSettingsUpdateInput
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. |
jobTokenScopeEnabled
|
Boolean |
Indicates CI job tokens generated in this project have restricted access to resources. |
keepLatestArtifact
|
Boolean |
Indicates if the latest artifact should be kept for this project. |
mergePipelinesEnabled
|
Boolean |
Indicates if merge pipelines are enabled for the project. |
mergeTrainsEnabled
|
Boolean |
Indicates if merge trains are enabled for the project. |
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.ciJobTokenScopeAddProject
Input type: CiJobTokenScopeAddProjectInput
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. |
targetProjectPath
|
ID! |
Project to be added to the CI job token scope. |
Fields
Name |
Type |
Description |
ciJobTokenScope
|
CiJobTokenScopeType |
CI job token's scope of access. |
clientMutationId
|
String |
A unique identifier for the client performing the mutation. |
errors
|
[String!]! |
Errors encountered during execution of the mutation. |
Mutation.ciJobTokenScopeRemoveProject
Input type: CiJobTokenScopeRemoveProjectInput
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. |
targetProjectPath
|
ID! |
Project to be removed from the CI job token scope. |
Fields
Name |
Type |
Description |
ciJobTokenScope
|
CiJobTokenScopeType |
CI job token's scope of access. |
clientMutationId
|
String |
A unique identifier for the client performing the mutation. |
errors
|
[String!]! |
Errors encountered during execution of the mutation. |
Mutation.clusterAgentDelete
Input type: ClusterAgentDeleteInput
Arguments
Name |
Type |
Description |
clientMutationId
|
String |
A unique identifier for the client performing the mutation. |
id
|
ClustersAgentID! |
Global ID of the cluster agent that will be deleted. |
Fields
Name |
Type |
Description |
clientMutationId
|
String |
A unique identifier for the client performing the mutation. |
errors
|
[String!]! |
Errors encountered during execution of the mutation. |
Mutation.clusterAgentTokenCreate
Input type: ClusterAgentTokenCreateInput
Arguments
Name |
Type |
Description |
clientMutationId
|
String |
A unique identifier for the client performing the mutation. |
clusterAgentId
|
ClustersAgentID! |
Global ID of the cluster agent that will be associated with the new token. |
description
|
String |
Description of the token. |
name
|
String! |
Name of the token. |
Fields
Name |
Type |
Description |
clientMutationId
|
String |
A unique identifier for the client performing the mutation. |
errors
|
[String!]! |
Errors encountered during execution of the mutation. |
secret
|
String |
Token secret value. Make sure you save it - you won't be able to access it again. |
token
|
ClusterAgentToken |
Token created after mutation. |
Mutation.clusterAgentTokenRevoke
Input type: ClusterAgentTokenRevokeInput
Arguments
Name |
Type |
Description |
clientMutationId
|
String |
A unique identifier for the client performing the mutation. |
id
|
ClustersAgentTokenID! |
Global ID of the agent token that will be revoked. |
Fields
Name |
Type |
Description |
clientMutationId
|
String |
A unique identifier for the client performing the mutation. |
errors
|
[String!]! |
Errors encountered during execution of the mutation. |
Mutation.commitCreate
Input type: CommitCreateInput
Arguments
Name |
Type |
Description |
actions
|
[CommitAction!]! |
Array of action hashes to commit as a batch. |
branch
|
String! |
Name of the branch to commit into, it can be a new branch. |
clientMutationId
|
String |
A unique identifier for the client performing the mutation. |
message
|
String! |
Raw commit message. |
projectPath
|
ID! |
Project full path the branch is associated with. |
startBranch
|
String |
If on a new branch, name of the original branch. |
Fields
Name |
Type |
Description |
clientMutationId
|
String |
A unique identifier for the client performing the mutation. |
commit
|
Commit |
Commit after mutation. |
commitPipelinePath
|
String |
ETag path for the commit's pipeline. |
content
|
[String!] |
Contents of the commit. |
errors
|
[String!]! |
Errors encountered during execution of the mutation. |
Mutation.configureContainerScanning
Configure Container Scanning for a project by enabling Container Scanning in a new or modified
.gitlab-ci.yml
file in a new branch. The new branch and a URL to
create a merge request are part of the response.
Input type: ConfigureContainerScanningInput
Arguments
Name |
Type |
Description |
clientMutationId
|
String |
A unique identifier for the client performing the mutation. |
projectPath
|
ID! |
Full path of the project. |
Fields
Name |
Type |
Description |
branch
|
String |
Branch that has the new/modified .gitlab-ci.yml file. |
clientMutationId
|
String |
A unique identifier for the client performing the mutation. |
errors
|
[String!]! |
Errors encountered during execution of the mutation. |
successPath
|
String |
Redirect path to use when the response is successful. |
Mutation.configureDependencyScanning
Configure Dependency Scanning for a project by enabling Dependency Scanning in a new or modified
.gitlab-ci.yml
file in a new branch. The new branch and a URL to
create a Merge Request are a part of the response.
Input type: ConfigureDependencyScanningInput
Arguments
Name |
Type |
Description |
clientMutationId
|
String |
A unique identifier for the client performing the mutation. |
projectPath
|
ID! |
Full path of the project. |
Fields
Name |
Type |
Description |
branch
|
String |
Branch that has the new/modified .gitlab-ci.yml file. |
clientMutationId
|
String |
A unique identifier for the client performing the mutation. |
errors
|
[String!]! |
Errors encountered during execution of the mutation. |
successPath
|
String |
Redirect path to use when the response is successful. |
Mutation.configureSast
Configure SAST for a project by enabling SAST in a new or modified
.gitlab-ci.yml
file in a new branch. The new branch and a URL to
create a Merge Request are a part of the response.
Input type: ConfigureSastInput
Arguments
Name |
Type |
Description |
clientMutationId
|
String |
A unique identifier for the client performing the mutation. |
configuration
|
SastCiConfigurationInput! |
SAST CI configuration for the project. |
projectPath
|
ID! |
Full path of the project. |
Fields
Name |
Type |
Description |
branch
|
String |
Branch that has the new/modified .gitlab-ci.yml file. |
clientMutationId
|
String |
A unique identifier for the client performing the mutation. |
errors
|
[String!]! |
Errors encountered during execution of the mutation. |
successPath
|
String |
Redirect path to use when the response is successful. |
Mutation.configureSastIac
Enable SAST IaC for a project in a new or
modified .gitlab-ci.yml
file in a new branch. The new
branch and a URL to create a merge request are a part of the
response.
Input type: ConfigureSastIacInput
Arguments
Name |
Type |
Description |
clientMutationId
|
String |
A unique identifier for the client performing the mutation. |
projectPath
|
ID! |
Full path of the project. |
Fields
Name |
Type |
Description |
branch
|
String |
Branch that has the new/modified .gitlab-ci.yml file. |
clientMutationId
|
String |
A unique identifier for the client performing the mutation. |
errors
|
[String!]! |
Errors encountered during execution of the mutation. |
successPath
|
String |
Redirect path to use when the response is successful. |
Mutation.configureSecretDetection
Configure Secret Detection for a project by enabling Secret Detection
in a new or modified .gitlab-ci.yml
file in a new branch. The new
branch and a URL to create a Merge Request are a part of the
response.
Input type: ConfigureSecretDetectionInput
Arguments
Name |
Type |
Description |
clientMutationId
|
String |
A unique identifier for the client performing the mutation. |
projectPath
|
ID! |
Full path of the project. |
Fields
Name |
Type |
Description |
branch
|
String |
Branch that has the new/modified .gitlab-ci.yml file. |
clientMutationId
|
String |
A unique identifier for the client performing the mutation. |
errors
|
[String!]! |
Errors encountered during execution of the mutation. |
successPath
|
String |
Redirect path to use when the response is successful. |
Mutation.corpusCreate
Input type: CorpusCreateInput
Arguments
Name |
Type |
Description |
clientMutationId
|
String |
A unique identifier for the client performing the mutation. |
fullPath
|
ID! |
Project the corpus belongs to. |
packageId
|
PackagesPackageID! |
ID of the corpus package. |
Fields
Name |
Type |
Description |
clientMutationId
|
String |
A unique identifier for the client performing the mutation. |
errors
|
[String!]! |
Errors encountered during execution of the mutation. |
Mutation.createAlertIssue
Input type: CreateAlertIssueInput
Arguments
Name |
Type |
Description |
clientMutationId
|
String |
A unique identifier for the client performing the mutation. |
iid
|
String! |
IID of the alert to mutate. |
projectPath
|
ID! |
Project the alert to mutate is in. |
Fields
Name |
Type |
Description |
alert
|
AlertManagementAlert |
Alert after mutation. |
clientMutationId
|
String |
A unique identifier for the client performing the mutation. |
errors
|
[String!]! |
Errors encountered during execution of the mutation. |
issue
|
Issue |
Issue created after mutation. |
todo
|
Todo |
To-do item after mutation. |
Mutation.createAnnotation
Input type: CreateAnnotationInput
Arguments
Name |
Type |
Description |
clientMutationId
|
String |
A unique identifier for the client performing the mutation. |
clusterId
|
ClustersClusterID |
Global ID of the cluster to add an annotation to. |
dashboardPath
|
String! |
Path to a file defining the dashboard on which the annotation should be added. |
description
|
String! |
Description of the annotation. |
endingAt
|
Time |
Timestamp indicating ending moment to which the annotation relates. |
environmentId
|
EnvironmentID |
Global ID of the environment to add an annotation to. |
startingAt
|
Time! |
Timestamp indicating starting moment to which the annotation relates. |
Fields
Name |
Type |
Description |
annotation
|
MetricsDashboardAnnotation |
Created annotation. |
clientMutationId
|
String |
A unique identifier for the client performing the mutation. |
errors
|
[String!]! |
Errors encountered during execution of the mutation. |
Mutation.createBoard
Input type: CreateBoardInput
Arguments
Name |
Type |
Description |
assigneeId
|
UserID |
ID of user to be assigned to the board. |
clientMutationId
|
String |
A unique identifier for the client performing the mutation. |
groupPath
|
ID |
Full path of the group with which the resource is associated. |
hideBacklogList
|
Boolean |
Whether or not backlog list is hidden. |
hideClosedList
|
Boolean |
Whether or not closed list is hidden. |
iterationCadenceId
|
IterationsCadenceID |
ID of iteration cadence to be assigned to the board. |
iterationId
|
IterationID |
ID of iteration to be assigned to the board. |
labelIds
|
[LabelID!] |
IDs of labels to be added to the board. |
labels
|
[String!] |
Labels of the issue. |
milestoneId
|
MilestoneID |
ID of milestone to be assigned to the board. |
name
|
String |
Board name. |
projectPath
|
ID |
Full path of the project with which the resource is associated. |
weight
|
Int |
Weight value to be assigned to the board. |
Fields
Name |
Type |
Description |
board
|
Board |
Board after mutation. |
clientMutationId
|
String |
A unique identifier for the client performing the mutation. |
errors
|
[String!]! |
Errors encountered during execution of the mutation. |
Mutation.createBranch
Input type: CreateBranchInput
Arguments
Name |
Type |
Description |
clientMutationId
|
String |
A unique identifier for the client performing the mutation. |
name
|
String! |
Name of the branch. |
projectPath
|
ID! |
Project full path the branch is associated with. |
ref
|
String! |
Branch name or commit SHA to create branch from. |
Fields
Name |
Type |
Description |
branch
|
Branch |
Branch after mutation. |
clientMutationId
|
String |
A unique identifier for the client performing the mutation. |
errors
|
[String!]! |
Errors encountered during execution of the mutation. |
Mutation.createClusterAgent
Input type: CreateClusterAgentInput
Arguments
Name |
Type |
Description |
clientMutationId
|
String |
A unique identifier for the client performing the mutation. |
name
|
String! |
Name of the cluster agent. |
projectPath
|
ID! |
Full path of the associated project for this 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.createCustomEmoji
WARNING:
Introduced in 13.6.
This feature is in Alpha. It can be changed or removed at any time.
Input type: CreateCustomEmojiInput
Arguments
Name |
Type |
Description |
clientMutationId
|
String |
A unique identifier for the client performing the mutation. |
groupPath
|
ID! |
Namespace full path the emoji is associated with. |
name
|
String! |
Name of the emoji. |
url
|
String! |
Location of the emoji file. |
Fields
Name |
Type |
Description |
clientMutationId
|
String |
A unique identifier for the client performing the mutation. |
customEmoji
|
CustomEmoji |
New custom emoji. |
errors
|
[String!]! |
Errors encountered during execution of the mutation. |
Mutation.createDiffNote
Input type: CreateDiffNoteInput
Arguments
Name |
Type |
Description |
body
|
String! |
Content of the note. |
clientMutationId
|
String |
A unique identifier for the client performing the mutation. |
confidential {warning-solid}
|
Boolean |
Deprecated: This was renamed. Please use internal . Deprecated in 15.3. |
internal
|
Boolean |
Internal flag for a note. Default is false. |
noteableId
|
NoteableID! |
Global ID of the resource to add a note to. |
position
|
DiffPositionInput! |
Position of this note on a diff. |
Fields
Name |
Type |
Description |
clientMutationId
|
String |
A unique identifier for the client performing the mutation. |
errors
|
[String!]! |
Errors encountered during execution of the mutation. |
note
|
Note |
Note after mutation. |
Mutation.createEpic
Input type: CreateEpicInput
Arguments
Name |
Type |
Description |
addLabelIds
|
[ID!] |
IDs of labels to be added to the epic. |
addLabels
|
[String!] |
Array of labels to be added to the epic. |
clientMutationId
|
String |
A unique identifier for the client performing the mutation. |
color
|
Color |
Color of the epic. Available only when feature flag epic_color_highlight is enabled. This flag is disabled by default, because the feature is experimental and is subject to change without notice. |
confidential
|
Boolean |
Indicates if the epic is confidential. |
description
|
String |
Description of the epic. |
dueDateFixed
|
String |
End date of the epic. |
dueDateIsFixed
|
Boolean |
Indicates end date should be sourced from due_date_fixed field not the issue milestones. |
groupPath
|
ID! |
Group the epic to mutate is in. |
removeLabelIds
|
[ID!] |
IDs of labels to be removed from the epic. |
startDateFixed
|
String |
Start date of the epic. |
startDateIsFixed
|
Boolean |
Indicates start date should be sourced from start_date_fixed field not the issue milestones. |
title
|
String |
Title of the epic. |
Fields
Name |
Type |
Description |
clientMutationId
|
String |
A unique identifier for the client performing the mutation. |
epic
|
Epic |
Created epic. |
errors
|
[String!]! |
Errors encountered during execution of the mutation. |
Mutation.createImageDiffNote
Input type: CreateImageDiffNoteInput
Arguments
Name |
Type |
Description |
body
|
String! |
Content of the note. |
clientMutationId
|
String |
A unique identifier for the client performing the mutation. |
confidential {warning-solid}
|
Boolean |
Deprecated: This was renamed. Please use internal . Deprecated in 15.3. |
internal
|
Boolean |
Internal flag for a note. Default is false. |
noteableId
|
NoteableID! |
Global ID of the resource to add a note to. |
position
|
DiffImagePositionInput! |
Position of this note on a diff. |
Fields
Name |
Type |
Description |
clientMutationId
|
String |
A unique identifier for the client performing the mutation. |
errors
|
[String!]! |
Errors encountered during execution of the mutation. |
note
|
Note |
Note after mutation. |
Mutation.createIssue
Input type: CreateIssueInput
Arguments
Name |
Type |
Description |
assigneeIds
|
[UserID!] |
Array of user IDs to assign to the issue. |
clientMutationId
|
String |
A unique identifier for the client performing the mutation. |
confidential
|
Boolean |
Indicates the issue is confidential. |
createdAt
|
Time |
Timestamp when the issue was created. Available only for admins and project owners. |
description
|
String |
Description of the issue. |
discussionToResolve
|
String |
ID of a discussion to resolve. Also pass merge_request_to_resolve_discussions_of . |
dueDate
|
ISO8601Date |
Due date of the issue. |
epicId
|
EpicID |
ID of an epic to associate the issue with. |
healthStatus
|
HealthStatus |
Desired health status. |
iid
|
Int |
IID (internal ID) of a project issue. Only admins and project owners can modify. |
iterationCadenceId
|
IterationsCadenceID |
Global iteration cadence ID. Required when iterationWildcardId is provided. |
iterationId
|
IterationID |
Global iteration ID. Mutually exlusive argument with iterationWildcardId . |
iterationWildcardId
|
IssueCreationIterationWildcardId |
Iteration wildcard ID. Supported values are: CURRENT . Mutually exclusive argument with iterationId . iterationCadenceId also required when this argument is provided. |
labelIds
|
[LabelID!] |
IDs of labels to be added to the issue. |
labels
|
[String!] |
Labels of the issue. |
locked
|
Boolean |
Indicates discussion is locked on the issue. |
mergeRequestToResolveDiscussionsOf
|
MergeRequestID |
IID of a merge request for which to resolve discussions. |
milestoneId
|
MilestoneID |
ID of the milestone to assign to the issue. On update milestone will be removed if set to null. |
moveAfterId
|
IssueID |
Global ID of issue that should be placed after the current issue. |
moveBeforeId
|
IssueID |
Global ID of issue that should be placed before the current issue. |
projectPath
|
ID! |
Project full path the issue is associated with. |
title
|
String! |
Title of the issue. |
type
|
IssueType |
Type of the issue. |
weight
|
Int |
Weight of the issue. |
Fields
Name |
Type |
Description |
clientMutationId
|
String |
A unique identifier for the client performing the mutation. |
errors
|
[String!]! |
Errors encountered during execution of the mutation. |
issue
|
Issue |
Issue after mutation. |
Mutation.createIteration
WARNING:
Deprecated in 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. |
confidential {warning-solid}
|
Boolean |
Deprecated: This was renamed. Please use internal . Deprecated in 15.3. |
discussionId
|
DiscussionID |
Global ID of the discussion this note is in reply to. |
internal
|
Boolean |
Internal flag for a note. Default is false. |
mergeRequestDiffHeadSha
|
String |
SHA of the head commit which is used to ensure that the merge request has not been updated since the request was sent. |
noteableId
|
NoteableID! |
Global ID of the resource to add a note to. |
Fields
Name |
Type |
Description |
clientMutationId
|
String |
A unique identifier for the client performing the mutation. |
errors
|
[String!]! |
Errors encountered during execution of the mutation. |
note
|
Note |
Note after mutation. |
Mutation.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. |
description
|
String |
Test case description. |
labelIds
|
[ID!] |
IDs of labels to be added to the test case. |
projectPath
|
ID! |
Project full path to create the test case in. |
title
|
String! |
Test case title. |
Fields
Name |
Type |
Description |
clientMutationId
|
String |
A unique identifier for the client performing the mutation. |
errors
|
[String!]! |
Errors encountered during execution of the mutation. |
testCase
|
Issue |
Test case created. |
Mutation.customerRelationsContactCreate
Input type: CustomerRelationsContactCreateInput
Arguments
Name |
Type |
Description |
clientMutationId
|
String |
A unique identifier for the client performing the mutation. |
description
|
String |
Description of or notes for the contact. |
email
|
String |
Email address of the contact. |
firstName
|
String! |
First name of the contact. |
groupId
|
GroupID! |
Group for the contact. |
lastName
|
String! |
Last name of the contact. |
organizationId
|
CustomerRelationsOrganizationID |
Organization for the contact. |
phone
|
String |
Phone number of the contact. |
Fields
Name |
Type |
Description |
clientMutationId
|
String |
A unique identifier for the client performing the mutation. |
contact
|
CustomerRelationsContact |
Contact after the mutation. |
errors
|
[String!]! |
Errors encountered during execution of the mutation. |
Mutation.customerRelationsContactUpdate
Input type: CustomerRelationsContactUpdateInput
Arguments
Name |
Type |
Description |
active
|
Boolean |
State of the contact. |
clientMutationId
|
String |
A unique identifier for the client performing the mutation. |
description
|
String |
Description of or notes for the contact. |
email
|
String |
Email address of the contact. |
firstName
|
String |
First name of the contact. |
id
|
CustomerRelationsContactID! |
Global ID of the contact. |
lastName
|
String |
Last name of the contact. |
organizationId
|
CustomerRelationsOrganizationID |
Organization of the contact. |
phone
|
String |
Phone number of the contact. |
Fields
Name |
Type |
Description |
clientMutationId
|
String |
A unique identifier for the client performing the mutation. |
contact
|
CustomerRelationsContact |
Contact after the mutation. |
errors
|
[String!]! |
Errors encountered during execution of the mutation. |
Mutation.customerRelationsOrganizationCreate
Input type: CustomerRelationsOrganizationCreateInput
Arguments
Name |
Type |
Description |
clientMutationId
|
String |
A unique identifier for the client performing the mutation. |
defaultRate
|
Float |
Standard billing rate for the organization. |
description
|
String |
Description of or notes for the organization. |
groupId
|
GroupID! |
Group for the organization. |
name
|
String! |
Name of the organization. |
Fields
Name |
Type |
Description |
clientMutationId
|
String |
A unique identifier for the client performing the mutation. |
errors
|
[String!]! |
Errors encountered during execution of the mutation. |
organization
|
CustomerRelationsOrganization |
Organization after the mutation. |
Mutation.customerRelationsOrganizationUpdate
Input type: CustomerRelationsOrganizationUpdateInput
Arguments
Name |
Type |
Description |
active
|
Boolean |
State of the organization. |
clientMutationId
|
String |
A unique identifier for the client performing the mutation. |
defaultRate
|
Float |
Standard billing rate for the organization. |
description
|
String |
Description of or notes for the organization. |
id
|
CustomerRelationsOrganizationID! |
Global ID of the organization. |
name
|
String |
Name of the organization. |
Fields
Name |
Type |
Description |
clientMutationId
|
String |
A unique identifier for the client performing the mutation. |
errors
|
[String!]! |
Errors encountered during execution of the mutation. |
organization
|
CustomerRelationsOrganization! |
Organization after the mutation. |
Mutation.dastOnDemandScanCreate
Input type: DastOnDemandScanCreateInput
Arguments
Name |
Type |
Description |
clientMutationId
|
String |
A unique identifier for the client performing the mutation. |
dastScannerProfileId
|
DastScannerProfileID |
ID of the scanner profile to be used for the scan. |
dastSiteProfileId
|
DastSiteProfileID! |
ID of the site profile to be used for the scan. |
fullPath
|
ID! |
Project the site profile belongs to. |
Fields
Name |
Type |
Description |
clientMutationId
|
String |
A unique identifier for the client performing the mutation. |
errors
|
[String!]! |
Errors encountered during execution of the mutation. |
pipelineUrl
|
String |
URL of the pipeline that was created. |
Mutation.dastProfileCreate
Input type: DastProfileCreateInput
Arguments
Name |
Type |
Description |
branchName
|
String |
Associated branch. |
clientMutationId
|
String |
A unique identifier for the client performing the mutation. |
dastProfileSchedule
|
DastProfileScheduleInput |
Represents a DAST Profile Schedule. |
dastScannerProfileId
|
DastScannerProfileID! |
ID of the scanner profile to be associated. |
dastSiteProfileId
|
DastSiteProfileID! |
ID of the site profile to be associated. |
description
|
String |
Description of the profile. Defaults to an empty string. |
fullPath
|
ID! |
Project the profile belongs to. |
name
|
String! |
Name of the profile. |
runAfterCreate
|
Boolean |
Run scan using profile after creation. Defaults to false. |
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 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 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. |
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. |
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 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 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 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. |
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 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. |
scanMethod
|
DastScanMethodType |
Scan method by the scanner. Is not saved or updated if dast_api_scanner feature flag is disabled. |
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 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 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 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. |
scanMethod
|
DastScanMethodType |
Scan method by the scanner. Is not saved or updated if dast_api_scanner feature flag is disabled. |
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 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
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
Mutation.dastSiteValidationRevoke
Input type: DastSiteValidationRevokeInput
Arguments
Name |
Type |
Description |
clientMutationId
|
String |
A unique identifier for the client performing the mutation. |
fullPath
|
ID! |
Project the site validation belongs to. |
normalizedTargetUrl
|
String! |
Normalized URL of the target to be revoked. |
Fields
Name |
Type |
Description |
clientMutationId
|
String |
A unique identifier for the client performing the mutation. |
errors
|
[String!]! |
Errors encountered during execution of the mutation. |
Mutation.deleteAnnotation
Input type: DeleteAnnotationInput
Arguments
Name |
Type |
Description |
clientMutationId
|
String |
A unique identifier for the client performing the mutation. |
id
|
MetricsDashboardAnnotationID! |
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.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
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.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
WARNING:
Introduced in 13.6.
This feature is in Alpha. It can be changed or removed at any time.
Input type: DestroyCustomEmojiInput
Arguments
Name |
Type |
Description |
clientMutationId
|
String |
A unique identifier for the client performing the mutation. |
id
|
CustomEmojiID! |
Global ID of the custom emoji to destroy. |
Fields
Name |
Type |
Description |
clientMutationId
|
String |
A unique identifier for the client performing the mutation. |
customEmoji
|
CustomEmoji |
Deleted custom emoji. |
errors
|
[String!]! |
Errors encountered during execution of the mutation. |
Mutation.destroyEpicBoard
Input type: DestroyEpicBoardInput
Arguments
Name |
Type |
Description |
clientMutationId
|
String |
A unique identifier for the client performing the mutation. |
id
|
BoardsEpicBoardID! |
Global ID of the board to destroy. |
Fields
Name |
Type |
Description |
clientMutationId
|
String |
A unique identifier for the client performing the mutation. |
epicBoard
|
EpicBoard |
Epic board after mutation. |
errors
|
[String!]! |
Errors encountered during execution of the mutation. |
Mutation.destroyNote
Input type: DestroyNoteInput
Arguments
Name |
Type |
Description |
clientMutationId
|
String |
A unique identifier for the client performing the mutation. |
id
|
NoteID! |
Global ID of the note to destroy. |
Fields
Name |
Type |
Description |
clientMutationId
|
String |
A unique identifier for the client performing the mutation. |
errors
|
[String!]! |
Errors encountered during execution of the mutation. |
note
|
Note |
Note after mutation. |
Mutation.destroyPackage
Input type: DestroyPackageInput
Arguments
Name |
Type |
Description |
clientMutationId
|
String |
A unique identifier for the client performing the mutation. |
id
|
PackagesPackageID! |
ID of the Package. |
Fields
Name |
Type |
Description |
clientMutationId
|
String |
A unique identifier for the client performing the mutation. |
errors
|
[String!]! |
Errors encountered during execution of the mutation. |
Mutation.destroyPackageFile
Input type: DestroyPackageFileInput
Arguments
Name |
Type |
Description |
clientMutationId
|
String |
A unique identifier for the client performing the mutation. |
id
|
PackagesPackageFileID! |
ID of the Package file. |
Fields
Name |
Type |
Description |
clientMutationId
|
String |
A unique identifier for the client performing the mutation. |
errors
|
[String!]! |
Errors encountered during execution of the mutation. |
Mutation.destroyPackageFiles
Input type: DestroyPackageFilesInput
Arguments
Name |
Type |
Description |
clientMutationId
|
String |
A unique identifier for the client performing the mutation. |
ids
|
[PackagesPackageFileID!]! |
IDs of the Package file. |
projectPath
|
ID! |
Project path where the packages cleanup policy is located. |
Fields
Name |
Type |
Description |
clientMutationId
|
String |
A unique identifier for the client performing the mutation. |
errors
|
[String!]! |
Errors encountered during execution of the mutation. |
Mutation.destroySnippet
Input type: DestroySnippetInput
Arguments
Name |
Type |
Description |
clientMutationId
|
String |
A unique identifier for the client performing the mutation. |
id
|
SnippetID! |
Global ID of the snippet to destroy. |
Fields
Name |
Type |
Description |
clientMutationId
|
String |
A unique identifier for the client performing the mutation. |
errors
|
[String!]! |
Errors encountered during execution of the mutation. |
snippet
|
Snippet |
Snippet after mutation. |
Mutation.disableDevopsAdoptionNamespace
BETA This endpoint is subject to change without notice.
Input type: DisableDevopsAdoptionNamespaceInput
Arguments
Fields
Name |
Type |
Description |
clientMutationId
|
String |
A unique identifier for the client performing the mutation. |
errors
|
[String!]! |
Errors encountered during execution of the mutation. |
Mutation.discussionToggleResolve
Toggles the resolved state of a discussion.
Input type: DiscussionToggleResolveInput
Arguments
Name |
Type |
Description |
clientMutationId
|
String |
A unique identifier for the client performing the mutation. |
id
|
DiscussionID! |
Global ID of the discussion. |
resolve
|
Boolean! |
Will resolve the discussion when true, and unresolve the discussion when false. |
Fields
Name |
Type |
Description |
clientMutationId
|
String |
A unique identifier for the client performing the mutation. |
discussion
|
Discussion |
Discussion after mutation. |
errors
|
[String!]! |
Errors encountered during execution of the mutation. |
Mutation.echoCreate
A mutation that does not perform any changes.
This is expected to be used for testing of endpoints, to verify
that a user has mutation access.
Input type: EchoCreateInput
Arguments
Name |
Type |
Description |
clientMutationId
|
String |
A unique identifier for the client performing the mutation. |
errors
|
[String!] |
Errors to return to the user. |
messages
|
[String!] |
Messages to return to the user. |
Fields
Name |
Type |
Description |
clientMutationId
|
String |
A unique identifier for the client performing the mutation. |
echoes
|
[String!] |
Messages returned to the user. |
errors
|
[String!]! |
Errors encountered during execution of the mutation. |
Mutation.enableDevopsAdoptionNamespace
BETA This endpoint is subject to change without notice.
Input type: EnableDevopsAdoptionNamespaceInput
Arguments
Name |
Type |
Description |
clientMutationId
|
String |
A unique identifier for the client performing the mutation. |
displayNamespaceId
|
NamespaceID |
Display namespace ID. |
namespaceId
|
NamespaceID! |
Namespace ID. |
Fields
Name |
Type |
Description |
clientMutationId
|
String |
A unique identifier for the client performing the mutation. |
enabledNamespace
|
DevopsAdoptionEnabledNamespace |
Enabled namespace after mutation. |
errors
|
[String!]! |
Errors encountered during execution of the mutation. |
Mutation.environmentsCanaryIngressUpdate
Deprecated This endpoint is planned to be removed along with certificate-based clusters. See this epic for more information.
Input type: EnvironmentsCanaryIngressUpdateInput
Arguments
Name |
Type |
Description |
clientMutationId
|
String |
A unique identifier for the client performing the mutation. |
id
|
EnvironmentID! |
Global ID of the environment to update. |
weight
|
Int! |
Weight of the Canary Ingress. |
Fields
Name |
Type |
Description |
clientMutationId
|
String |
A unique identifier for the client performing the mutation. |
errors
|
[String!]! |
Errors encountered during execution of the mutation. |
Mutation.epicAddIssue
Input type: EpicAddIssueInput
Arguments
Name |
Type |
Description |
clientMutationId
|
String |
A unique identifier for the client performing the mutation. |
groupPath
|
ID! |
Group the epic to mutate belongs to. |
iid
|
ID! |
IID of the epic to mutate. |
issueIid
|
String! |
IID of the issue to be added. |
projectPath
|
ID! |
Full path of the project the issue belongs to. |
Fields
Name |
Type |
Description |
clientMutationId
|
String |
A unique identifier for the client performing the mutation. |
epic
|
Epic |
Epic after mutation. |
epicIssue
|
EpicIssue |
Epic-issue relationship. |
errors
|
[String!]! |
Errors encountered during execution of the mutation. |
Mutation.epicBoardCreate
Input type: EpicBoardCreateInput
Arguments
Name |
Type |
Description |
clientMutationId
|
String |
A unique identifier for the client performing the mutation. |
groupPath
|
ID |
Full path of the group with which the resource is associated. |
hideBacklogList
|
Boolean |
Whether or not backlog list is hidden. |
hideClosedList
|
Boolean |
Whether or not closed list is hidden. |
labelIds
|
[LabelID!] |
IDs of labels to be added to the board. |
labels
|
[String!] |
Labels of the issue. |
name
|
String |
Board name. |
Fields
Name |
Type |
Description |
clientMutationId
|
String |
A unique identifier for the client performing the mutation. |
epicBoard
|
EpicBoard |
Created epic board. |
errors
|
[String!]! |
Errors encountered during execution of the mutation. |
Mutation.epicBoardListCreate
Input type: EpicBoardListCreateInput
Arguments
Name |
Type |
Description |
backlog
|
Boolean |
Create the backlog list. |
boardId
|
BoardsEpicBoardID! |
Global ID of the issue board to mutate. |
clientMutationId
|
String |
A unique identifier for the client performing the mutation. |
labelId
|
LabelID |
Global ID of an existing label. |
Fields
Name |
Type |
Description |
clientMutationId
|
String |
A unique identifier for the client performing the mutation. |
errors
|
[String!]! |
Errors encountered during execution of the mutation. |
list
|
EpicList |
Epic list in the epic board. |
Mutation.epicBoardListDestroy
Destroys an epic board list.
Input type: EpicBoardListDestroyInput
Arguments
Name |
Type |
Description |
clientMutationId
|
String |
A unique identifier for the client performing the mutation. |
listId
|
BoardsEpicListID! |
Global ID of the epic board list to destroy. |
Fields
Name |
Type |
Description |
clientMutationId
|
String |
A unique identifier for the client performing the mutation. |
errors
|
[String!]! |
Errors encountered during execution of the mutation. |
list
|
EpicList |
Epic board list. null if the board was destroyed successfully. |
Mutation.epicBoardUpdate
Input type: EpicBoardUpdateInput
Arguments
Name |
Type |
Description |
clientMutationId
|
String |
A unique identifier for the client performing the mutation. |
hideBacklogList
|
Boolean |
Whether or not backlog list is hidden. |
hideClosedList
|
Boolean |
Whether or not closed list is hidden. |
id
|
BoardsEpicBoardID! |
Epic board global ID. |
labelIds
|
[LabelID!] |
IDs of labels to be added to the board. |
labels
|
[String!] |
Labels of the issue. |
name
|
String |
Board name. |
Fields
Name |
Type |
Description |
clientMutationId
|
String |
A unique identifier for the client performing the mutation. |
epicBoard
|
EpicBoard |
Updated epic board. |
errors
|
[String!]! |
Errors encountered during execution of the mutation. |
Mutation.epicMoveList
Input type: EpicMoveListInput
Arguments
Name |
Type |
Description |
boardId
|
BoardsEpicBoardID! |
Global ID of the board that the epic is in. |
clientMutationId
|
String |
A unique identifier for the client performing the mutation. |
epicId
|
EpicID! |
ID of the epic to mutate. |
fromListId
|
BoardsEpicListID |
ID of the board list that the epic will be moved from. Required if moving between lists. |
moveAfterId
|
EpicID |
ID of epic that should be placed after the current epic. |
moveBeforeId
|
EpicID |
ID of epic that should be placed before the current epic. |
toListId
|
BoardsEpicListID! |
ID of the list the epic will be in after mutation. |
Fields
Name |
Type |
Description |
clientMutationId
|
String |
A unique identifier for the client performing the mutation. |
epic
|
Epic |
Epic after mutation. |
errors
|
[String!]! |
Errors encountered during execution of the mutation. |
Mutation.epicSetSubscription
Input type: EpicSetSubscriptionInput
Arguments
Name |
Type |
Description |
clientMutationId
|
String |
A unique identifier for the client performing the mutation. |
groupPath
|
ID! |
Group the epic to mutate belongs to. |
iid
|
ID! |
IID of the epic to mutate. |
subscribedState
|
Boolean! |
Desired state of the subscription. |
Fields
Name |
Type |
Description |
clientMutationId
|
String |
A unique identifier for the client performing the mutation. |
epic
|
Epic |
Epic after mutation. |
errors
|
[String!]! |
Errors encountered during execution of the mutation. |
Mutation.epicTreeReorder
Input type: EpicTreeReorderInput
Arguments
Name |
Type |
Description |
baseEpicId
|
EpicID! |
ID of the base epic of the tree. |
clientMutationId
|
String |
A unique identifier for the client performing the mutation. |
moved
|
EpicTreeNodeFieldsInputType! |
Parameters for updating the tree positions. |
Fields
Name |
Type |
Description |
clientMutationId
|
String |
A unique identifier for the client performing the mutation. |
errors
|
[String!]! |
Errors encountered during execution of the mutation. |
Mutation.escalationPolicyCreate
Input type: EscalationPolicyCreateInput
Arguments
Name |
Type |
Description |
clientMutationId
|
String |
A unique identifier for the client performing the mutation. |
description
|
String |
Description of the escalation policy. |
name
|
String! |
Name of the escalation policy. |
projectPath
|
ID! |
Project to create the escalation policy for. |
rules
|
[EscalationRuleInput!]! |
Steps of the escalation policy. |
Fields
Name |
Type |
Description |
clientMutationId
|
String |
A unique identifier for the client performing the mutation. |
errors
|
[String!]! |
Errors encountered during execution of the mutation. |
escalationPolicy
|
EscalationPolicyType |
Escalation policy. |
Mutation.escalationPolicyDestroy
Input type: EscalationPolicyDestroyInput
Arguments
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
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. |
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
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
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.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. |
license
|
CurrentLicense |
Current license. |
Mutation.groupUpdate
Input type: GroupUpdateInput
Arguments
Name |
Type |
Description |
clientMutationId
|
String |
A unique identifier for the client performing the mutation. |
fullPath
|
ID! |
Full path of the group that will be updated. |
sharedRunnersSetting
|
SharedRunnersSetting! |
Shared runners availability for the namespace and its descendants. |
Fields
Name |
Type |
Description |
clientMutationId
|
String |
A unique identifier for the client performing the mutation. |
errors
|
[String!]! |
Errors encountered during execution of the mutation. |
group
|
Group |
Group after update. |
Mutation.httpIntegrationCreate
Input type: HttpIntegrationCreateInput
Arguments
Name |
Type |
Description |
active
|
Boolean! |
Whether the integration is receiving alerts. |
clientMutationId
|
String |
A unique identifier for the client performing the mutation. |
name
|
String! |
Name of the integration. |
payloadAttributeMappings
|
[AlertManagementPayloadAlertFieldInput!] |
Custom mapping of GitLab alert attributes to fields from the payload example. |
payloadExample
|
JsonString |
Example of an alert payload. |
projectPath
|
ID! |
Project to create the integration in. |
Fields
Name |
Type |
Description |
clientMutationId
|
String |
A unique identifier for the client performing the mutation. |
errors
|
[String!]! |
Errors encountered during execution of the mutation. |
integration
|
AlertManagementHttpIntegration |
HTTP integration. |
Mutation.httpIntegrationDestroy
Input type: HttpIntegrationDestroyInput
Arguments
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
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
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.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
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.issueMove
Input type: IssueMoveInput
Arguments
Name |
Type |
Description |
clientMutationId
|
String |
A unique identifier for the client performing the mutation. |
iid
|
String! |
IID of the issue to mutate. |
projectPath
|
ID! |
Project the issue to mutate is in. |
targetProjectPath
|
ID! |
Project to move the issue to. |
Fields
Name |
Type |
Description |
clientMutationId
|
String |
A unique identifier for the client performing the mutation. |
errors
|
[String!]! |
Errors encountered during execution of the mutation. |
issue
|
Issue |
Issue after mutation. |
Mutation.issueMoveList
Input type: IssueMoveListInput
Arguments
Name |
Type |
Description |
boardId
|
BoardID! |
Global ID of the board that the issue is in. |
clientMutationId
|
String |
A unique identifier for the client performing the mutation. |
epicId
|
EpicID |
ID of the parent epic. NULL when removing the association. |
fromListId
|
ID |
ID of the board list that the issue will be moved from. |
iid
|
String! |
IID of the issue to mutate. |
moveAfterId
|
ID |
ID of issue that should be placed after the current issue. |
moveBeforeId
|
ID |
ID of issue that should be placed before the current issue. |
positionInList
|
Int |
Position of issue within the board list. Positions start at 0. Use -1 to move to the end of the list. |
projectPath
|
ID! |
Project the issue to mutate is in. |
toListId
|
ID |
ID of the board list that the issue will be moved to. |
Fields
Name |
Type |
Description |
clientMutationId
|
String |
A unique identifier for the client performing the mutation. |
errors
|
[String!]! |
Errors encountered during execution of the mutation. |
issue
|
Issue |
Issue after mutation. |
Mutation.issueSetAssignees
Input type: IssueSetAssigneesInput
Arguments
Name |
Type |
Description |
assigneeUsernames
|
[String!]! |
Usernames to assign to the resource. Replaces existing assignees by default. |
clientMutationId
|
String |
A unique identifier for the client performing the mutation. |
iid
|
String! |
IID of the issue to mutate. |
operationMode
|
MutationOperationMode |
Operation to perform. Defaults to REPLACE. |
projectPath
|
ID! |
Project the issue to mutate is in. |
Fields
Name |
Type |
Description |
clientMutationId
|
String |
A unique identifier for the client performing the mutation. |
errors
|
[String!]! |
Errors encountered during execution of the mutation. |
issue
|
Issue |
Issue after mutation. |
Mutation.issueSetConfidential
Input type: IssueSetConfidentialInput
Arguments
Name |
Type |
Description |
clientMutationId
|
String |
A unique identifier for the client performing the mutation. |
confidential
|
Boolean! |
Whether or not to set the issue as a confidential. |
iid
|
String! |
IID of the issue to mutate. |
projectPath
|
ID! |
Project the issue to mutate is in. |
Fields
Name |
Type |
Description |
clientMutationId
|
String |
A unique identifier for the client performing the mutation. |
errors
|
[String!]! |
Errors encountered during execution of the mutation. |
issue
|
Issue |
Issue after mutation. |
Mutation.issueSetCrmContacts
Input type: IssueSetCrmContactsInput
Arguments
Name |
Type |
Description |
clientMutationId
|
String |
A unique identifier for the client performing the mutation. |
contactIds
|
[CustomerRelationsContactID!]! |
Customer relations contact IDs to set. Replaces existing contacts by default. |
iid
|
String! |
IID of the issue to mutate. |
operationMode
|
MutationOperationMode |
Changes the operation mode. Defaults to REPLACE. |
projectPath
|
ID! |
Project the issue to mutate is in. |
Fields
Name |
Type |
Description |
clientMutationId
|
String |
A unique identifier for the client performing the mutation. |
errors
|
[String!]! |
Errors encountered during execution of the mutation. |
issue
|
Issue |
Issue after mutation. |
Mutation.issueSetDueDate
Input type: IssueSetDueDateInput
Arguments
Name |
Type |
Description |
clientMutationId
|
String |
A unique identifier for the client performing the mutation. |
dueDate
|
Time |
Desired due date for the issue. Due date is removed if null. |
iid
|
String! |
IID of the issue to mutate. |
projectPath
|
ID! |
Project the issue to mutate is in. |
Fields
Name |
Type |
Description |
clientMutationId
|
String |
A unique identifier for the client performing the mutation. |
errors
|
[String!]! |
Errors encountered during execution of the mutation. |
issue
|
Issue |
Issue after mutation. |
Mutation.issueSetEpic
Input type: IssueSetEpicInput
Arguments
Name |
Type |
Description |
clientMutationId
|
String |
A unique identifier for the client performing the mutation. |
epicId
|
EpicID |
Global ID of the epic to be assigned to the issue, epic will be removed if absent or set to null. |
iid
|
String! |
IID of the issue to mutate. |
projectPath
|
ID! |
Project the issue to mutate is in. |
Fields
Name |
Type |
Description |
clientMutationId
|
String |
A unique identifier for the client performing the mutation. |
errors
|
[String!]! |
Errors encountered during execution of the mutation. |
issue
|
Issue |
Issue after mutation. |
Mutation.issueSetEscalationPolicy
Input type: IssueSetEscalationPolicyInput
Arguments
Name |
Type |
Description |
clientMutationId
|
String |
A unique identifier for the client performing the mutation. |
escalationPolicyId
|
IncidentManagementEscalationPolicyID |
Global ID of the escalation policy to assign to the issue. Policy will be removed if absent or set to null. |
iid
|
String! |
IID of the issue to mutate. |
projectPath
|
ID! |
Project the issue to mutate is in. |
Fields
Name |
Type |
Description |
clientMutationId
|
String |
A unique identifier for the client performing the mutation. |
errors
|
[String!]! |
Errors encountered during execution of the mutation. |
issue
|
Issue |
Issue after mutation. |
Mutation.issueSetEscalationStatus
Input type: IssueSetEscalationStatusInput
Arguments
Name |
Type |
Description |
clientMutationId
|
String |
A unique identifier for the client performing the mutation. |
iid
|
String! |
IID of the issue to mutate. |
projectPath
|
ID! |
Project the issue to mutate is in. |
status
|
IssueEscalationStatus! |
Set the escalation status. |
Fields
Name |
Type |
Description |
clientMutationId
|
String |
A unique identifier for the client performing the mutation. |
errors
|
[String!]! |
Errors encountered during execution of the mutation. |
issue
|
Issue |
Issue after mutation. |
Mutation.issueSetIteration
Input type: IssueSetIterationInput
Arguments
Name |
Type |
Description |
clientMutationId
|
String |
A unique identifier for the client performing the mutation. |
iid
|
String! |
IID of the issue to mutate. |
iterationId
|
IterationID |
Iteration to assign to the issue. |
projectPath
|
ID! |
Project the issue to mutate is in. |
Fields
Name |
Type |
Description |
clientMutationId
|
String |
A unique identifier for the client performing the mutation. |
errors
|
[String!]! |
Errors encountered during execution of the mutation. |
issue
|
Issue |
Issue after mutation. |
Mutation.issueSetLocked
Input type: IssueSetLockedInput
Arguments
Name |
Type |
Description |
clientMutationId
|
String |
A unique identifier for the client performing the mutation. |
iid
|
String! |
IID of the issue to mutate. |
locked
|
Boolean! |
Whether or not to lock discussion on the issue. |
projectPath
|
ID! |
Project the issue to mutate is in. |
Fields
Name |
Type |
Description |
clientMutationId
|
String |
A unique identifier for the client performing the mutation. |
errors
|
[String!]! |
Errors encountered during execution of the mutation. |
issue
|
Issue |
Issue after mutation. |
Mutation.issueSetSeverity
Input type: IssueSetSeverityInput
Arguments
Name |
Type |
Description |
clientMutationId
|
String |
A unique identifier for the client performing the mutation. |
iid
|
String! |
IID of the issue to mutate. |
projectPath
|
ID! |
Project the issue to mutate is in. |
severity
|
IssuableSeverity! |
Set the incident severity level. |
Fields
Name |
Type |
Description |
clientMutationId
|
String |
A unique identifier for the client performing the mutation. |
errors
|
[String!]! |
Errors encountered during execution of the mutation. |
issue
|
Issue |
Issue after mutation. |
Mutation.issueSetSubscription
Input type: IssueSetSubscriptionInput
Arguments
Name |
Type |
Description |
clientMutationId
|
String |
A unique identifier for the client performing the mutation. |
iid
|
String! |
IID of the issue to mutate. |
projectPath
|
ID! |
Project the issue to mutate is in. |
subscribedState
|
Boolean! |
Desired state of the subscription. |
Fields
Name |
Type |
Description |
clientMutationId
|
String |
A unique identifier for the client performing the mutation. |
errors
|
[String!]! |
Errors encountered during execution of the mutation. |
issue
|
Issue |
Issue after mutation. |
Mutation.issueSetWeight
Input type: IssueSetWeightInput
Arguments
Name |
Type |
Description |
clientMutationId
|
String |
A unique identifier for the client performing the mutation. |
iid
|
String! |
IID of the issue to mutate. |
projectPath
|
ID! |
Project the issue to mutate is in. |
weight
|
Int |
The desired weight for the issue. If set to null, weight is removed. |
Fields
Name |
Type |
Description |
clientMutationId
|
String |
A unique identifier for the client performing the mutation. |
errors
|
[String!]! |
Errors encountered during execution of the mutation. |
issue
|
Issue |
Issue after mutation. |
Mutation.iterationCadenceCreate
Input type: IterationCadenceCreateInput
Arguments
Name |
Type |
Description |
active
|
Boolean! |
Whether the iteration cadence is active. |
automatic
|
Boolean! |
Whether the iteration cadence should automatically generate upcoming iterations. |
clientMutationId
|
String |
A unique identifier for the client performing the mutation. |
description
|
String |
Description of the iteration cadence. Maximum length is 5000 characters. |
durationInWeeks
|
Int |
Duration in weeks of the iterations within this cadence. |
groupPath
|
ID! |
Group where the iteration cadence is created. |
iterationsInAdvance
|
Int |
Upcoming iterations to be created when iteration cadence is set to automatic. |
rollOver
|
Boolean |
Whether the iteration cadence should roll over issues to the next iteration or not. |
startDate
|
Time |
Timestamp of the automation start date. |
title
|
String |
Title of the iteration cadence. |
Fields
Name |
Type |
Description |
clientMutationId
|
String |
A unique identifier for the client performing the mutation. |
errors
|
[String!]! |
Errors encountered during execution of the mutation. |
iterationCadence
|
IterationCadence |
Created iteration cadence. |
Mutation.iterationCadenceDestroy
Input type: IterationCadenceDestroyInput
Arguments
Name |
Type |
Description |
clientMutationId
|
String |
A unique identifier for the client performing the mutation. |
id
|
IterationsCadenceID! |
Global ID of the iteration cadence. |
Fields
Name |
Type |
Description |
clientMutationId
|
String |
A unique identifier for the client performing the mutation. |
errors
|
[String!]! |
Errors encountered during execution of the mutation. |
group
|
Group! |
Group the iteration cadence belongs to. |
Mutation.iterationCadenceUpdate
Input type: IterationCadenceUpdateInput
Arguments
Name |
Type |
Description |
active
|
Boolean |
Whether the iteration cadence is active. |
automatic
|
Boolean |
Whether the iteration cadence should automatically generate upcoming iterations. |
clientMutationId
|
String |
A unique identifier for the client performing the mutation. |
description
|
String |
Description of the iteration cadence. Maximum length is 5000 characters. |
durationInWeeks
|
Int |
Duration in weeks of the iterations within this cadence. |
id
|
IterationsCadenceID! |
Global ID of the iteration cadence. |
iterationsInAdvance
|
Int |
Upcoming iterations to be created when iteration cadence is set to automatic. |
rollOver
|
Boolean |
Whether the iteration cadence should roll over issues to the next iteration or not. |
startDate
|
Time |
Timestamp of the automation start date. |
title
|
String |
Title of the iteration cadence. |
Fields
Name |
Type |
Description |
clientMutationId
|
String |
A unique identifier for the client performing the mutation. |
errors
|
[String!]! |
Errors encountered during execution of the mutation. |
iterationCadence
|
IterationCadence |
Updated iteration cadence. |
Mutation.iterationCreate
Input type: iterationCreateInput
Arguments
Name |
Type |
Description |
clientMutationId
|
String |
A unique identifier for the client performing the mutation. |
description
|
String |
Description of the iteration. |
dueDate
|
String |
End date of the iteration. |
groupPath
|
ID |
Full path of the group with which the resource is associated. |
iterationsCadenceId
|
IterationsCadenceID |
Global ID of the iteration cadence to be assigned to the new iteration. |
projectPath
|
ID |
Full path of the project with which the resource is associated. |
startDate
|
String |
Start date of the iteration. |
title
|
String |
Title of the iteration. |
Fields
Name |
Type |
Description |
clientMutationId
|
String |
A unique identifier for the client performing the mutation. |
errors
|
[String!]! |
Errors encountered during execution of the mutation. |
iteration
|
Iteration |
Created iteration. |
Mutation.iterationDelete
Input type: IterationDeleteInput
Arguments
Name |
Type |
Description |
clientMutationId
|
String |
A unique identifier for the client performing the mutation. |
id
|
IterationID! |
ID of the iteration. |
Fields
Name |
Type |
Description |
clientMutationId
|
String |
A unique identifier for the client performing the mutation. |
errors
|
[String!]! |
Errors encountered during execution of the mutation. |
group
|
Group! |
Group the iteration belongs to. |
Mutation.jiraImportStart
Input type: JiraImportStartInput
Arguments
Name |
Type |
Description |
clientMutationId
|
String |
A unique identifier for the client performing the mutation. |
jiraProjectKey
|
String! |
Project key of the importer Jira project. |
jiraProjectName
|
String |
Project name of the importer Jira project. |
projectPath
|
ID! |
Project to import the Jira project into. |
usersMapping
|
[JiraUsersMappingInputType!] |
Mapping of Jira to GitLab users. |
Fields
Name |
Type |
Description |
clientMutationId
|
String |
A unique identifier for the client performing the mutation. |
errors
|
[String!]! |
Errors encountered during execution of the mutation. |
jiraImport
|
JiraImport |
Jira import data after mutation. |
Mutation.jiraImportUsers
Input type: JiraImportUsersInput
Arguments
Name |
Type |
Description |
clientMutationId
|
String |
A unique identifier for the client performing the mutation. |
projectPath
|
ID! |
Project to import the Jira users into. |
startAt
|
Int |
Index of the record the import should started at, default 0 (50 records returned). |
Fields
Name |
Type |
Description |
clientMutationId
|
String |
A unique identifier for the client performing the mutation. |
errors
|
[String!]! |
Errors encountered during execution of the mutation. |
jiraUsers
|
[JiraUser!] |
Users returned from Jira, matched by email and name if possible. |
Mutation.jobArtifactsDestroy
Input type: JobArtifactsDestroyInput
Arguments
Name |
Type |
Description |
clientMutationId
|
String |
A unique identifier for the client performing the mutation. |
id
|
CiBuildID! |
ID of the job to mutate. |
Fields
Name |
Type |
Description |
clientMutationId
|
String |
A unique identifier for the client performing the mutation. |
destroyedArtifactsCount
|
Int! |
Number of artifacts deleted. |
errors
|
[String!]! |
Errors encountered during execution of the mutation. |
job
|
CiJob |
Job with artifacts to be deleted. |
Mutation.jobCancel
Input type: JobCancelInput
Arguments
Name |
Type |
Description |
clientMutationId
|
String |
A unique identifier for the client performing the mutation. |
id
|
CiBuildID! |
ID of the job to mutate. |
Fields
Name |
Type |
Description |
clientMutationId
|
String |
A unique identifier for the client performing the mutation. |
errors
|
[String!]! |
Errors encountered during execution of the mutation. |
job
|
CiJob |
Job after the mutation. |
Mutation.jobPlay
Input type: JobPlayInput
Arguments
Name |
Type |
Description |
clientMutationId
|
String |
A unique identifier for the client performing the mutation. |
id
|
CiBuildID! |
ID of the job to mutate. |
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
|
CiBuildID! |
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.mergeRequestAccept
Accepts a merge request.
When accepted, the source branch will be merged into the target branch, either
immediately if possible, or using one of the automatic merge strategies.
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 this 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 this merge request. |
Fields
Name |
Type |
Description |
clientMutationId
|
String |
A unique identifier for the client performing the mutation. |
errors
|
[String!]! |
Errors encountered during execution of the mutation. |
mergeRequest
|
MergeRequest |
Merge request after mutation. |
Mutation.mergeRequestCreate
Input type: MergeRequestCreateInput
Arguments
Name |
Type |
Description |
clientMutationId
|
String |
A unique identifier for the client performing the mutation. |
description
|
String |
Description of the merge request (Markdown rendered as HTML for caching). |
labels
|
[String!] |
Labels of the merge request. |
projectPath
|
ID! |
Project full path the merge request is associated with. |
sourceBranch
|
String! |
Source branch of the merge request. |
targetBranch
|
String! |
Target branch of the merge request. |
title
|
String! |
Title of the merge request. |
Fields
Name |
Type |
Description |
clientMutationId
|
String |
A unique identifier for the client performing the mutation. |
errors
|
[String!]! |
Errors encountered during execution of the mutation. |
mergeRequest
|
MergeRequest |
Merge request after mutation. |
Mutation.mergeRequestReviewerRereview
Input type: MergeRequestReviewerRereviewInput
Arguments
Name |
Type |
Description |
clientMutationId
|
String |
A unique identifier for the client performing the mutation. |
iid
|
String! |
IID of the merge request to mutate. |
projectPath
|
ID! |
Project the merge request to mutate is in. |
userId
|
UserID! |
User ID for the user that has been requested for a new review. |
Fields
Name |
Type |
Description |
clientMutationId
|
String |
A unique identifier for the client performing the mutation. |
errors
|
[String!]! |
Errors encountered during execution of the mutation. |
mergeRequest
|
MergeRequest |
Merge request after mutation. |
Mutation.mergeRequestSetAssignees
Input type: MergeRequestSetAssigneesInput
Arguments
Name |
Type |
Description |
assigneeUsernames
|
[String!]! |
Usernames to assign to the resource. Replaces existing assignees by default. |
clientMutationId
|
String |
A unique identifier for the client performing the mutation. |
iid
|
String! |
IID of the merge request to mutate. |
operationMode
|
MutationOperationMode |
Operation to perform. Defaults to REPLACE. |
projectPath
|
ID! |
Project the merge request to mutate is in. |
Fields
Name |
Type |
Description |
clientMutationId
|
String |
A unique identifier for the client performing the mutation. |
errors
|
[String!]! |
Errors encountered during execution of the mutation. |
mergeRequest
|
MergeRequest |
Merge request after mutation. |
Mutation.mergeRequestSetDraft
Input type: MergeRequestSetDraftInput
Arguments
Name |
Type |
Description |
clientMutationId
|
String |
A unique identifier for the client performing the mutation. |
draft
|
Boolean! |
Whether or not to set the merge request as a draft. |
iid
|
String! |
IID of the merge request to mutate. |
projectPath
|
ID! |
Project the merge request to mutate is in. |
Fields
Name |
Type |
Description |
clientMutationId
|
String |
A unique identifier for the client performing the mutation. |
errors
|
[String!]! |
Errors encountered during execution of the mutation. |
mergeRequest
|
MergeRequest |
Merge request after mutation. |
Mutation.mergeRequestSetLabels
Input type: MergeRequestSetLabelsInput
Arguments
Name |
Type |
Description |
clientMutationId
|
String |
A unique identifier for the client performing the mutation. |
iid
|
String! |
IID of the merge request to mutate. |
labelIds
|
[LabelID!]! |
Label IDs to set. Replaces existing labels by default. |
operationMode
|
MutationOperationMode |
Changes the operation mode. Defaults to REPLACE. |
projectPath
|
ID! |
Project the merge request to mutate is in. |
Fields
Name |
Type |
Description |
clientMutationId
|
String |
A unique identifier for the client performing the mutation. |
errors
|
[String!]! |
Errors encountered during execution of the mutation. |
mergeRequest
|
MergeRequest |
Merge request after mutation. |
Mutation.mergeRequestSetLocked
Input type: MergeRequestSetLockedInput
Arguments
Name |
Type |
Description |
clientMutationId
|
String |
A unique identifier for the client performing the mutation. |
iid
|
String! |
IID of the merge request to mutate. |
locked
|
Boolean! |
Whether or not to lock the merge request. |
projectPath
|
ID! |
Project the merge request to mutate is in. |
Fields
Name |
Type |
Description |
clientMutationId
|
String |
A unique identifier for the client performing the mutation. |
errors
|
[String!]! |
Errors encountered during execution of the mutation. |
mergeRequest
|
MergeRequest |
Merge request after mutation. |
Mutation.mergeRequestSetMilestone
Input type: MergeRequestSetMilestoneInput
Arguments
Name |
Type |
Description |
clientMutationId
|
String |
A unique identifier for the client performing the mutation. |
iid
|
String! |
IID of the merge request to mutate. |
milestoneId
|
MilestoneID |
Milestone to assign to the merge request. |
projectPath
|
ID! |
Project the merge request to mutate is in. |
Fields
Name |
Type |
Description |
clientMutationId
|
String |
A unique identifier for the client performing the mutation. |
errors
|
[String!]! |
Errors encountered during execution of the mutation. |
mergeRequest
|
MergeRequest |
Merge request after mutation. |
Mutation.mergeRequestSetReviewers
Input type: MergeRequestSetReviewersInput
Arguments
Name |
Type |
Description |
clientMutationId
|
String |
A unique identifier for the client performing the mutation. |
iid
|
String! |
IID of the merge request to mutate. |
operationMode
|
MutationOperationMode |
Operation to perform. Defaults to REPLACE. |
projectPath
|
ID! |
Project the merge request to mutate is in. |
reviewerUsernames
|
[String!]! |
Usernames of reviewers to assign. Replaces existing reviewers by default. |
Fields
Name |
Type |
Description |
clientMutationId
|
String |
A unique identifier for the client performing the mutation. |
errors
|
[String!]! |
Errors encountered during execution of the mutation. |
mergeRequest
|
MergeRequest |
Merge request after mutation. |
Mutation.mergeRequestSetSubscription
Input type: MergeRequestSetSubscriptionInput
Arguments
Name |
Type |
Description |
clientMutationId
|
String |
A unique identifier for the client performing the mutation. |
iid
|
String! |
IID of the merge request to mutate. |
projectPath
|
ID! |
Project the merge request to mutate is in. |
subscribedState
|
Boolean! |
Desired state of the subscription. |
Fields
Name |
Type |
Description |
clientMutationId
|
String |
A unique identifier for the client performing the mutation. |
errors
|
[String!]! |
Errors encountered during execution of the mutation. |
mergeRequest
|
MergeRequest |
Merge request after mutation. |
Mutation.mergeRequestUpdate
Update attributes of a merge request.
Input type: MergeRequestUpdateInput
Arguments
Name |
Type |
Description |
clientMutationId
|
String |
A unique identifier for the client performing the mutation. |
description
|
String |
Description of the merge request (Markdown rendered as HTML for caching). |
iid
|
String! |
IID of the merge request to mutate. |
projectPath
|
ID! |
Project the merge request to mutate is in. |
state
|
MergeRequestNewState |
Action to perform to change the state. |
targetBranch
|
String |
Target branch of the merge request. |
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.namespaceBanDestroy
Input type: NamespaceBanDestroyInput
Arguments
Name |
Type |
Description |
clientMutationId
|
String |
A unique identifier for the client performing the mutation. |
id
|
NamespacesNamespaceBanID! |
Global ID of the namespace ban to remove. |
Fields
Name |
Type |
Description |
clientMutationId
|
String |
A unique identifier for the client performing the mutation. |
errors
|
[String!]! |
Errors encountered during execution of the mutation. |
namespaceBan
|
NamespaceBan |
Namespace Ban. |
Mutation.namespaceCiCdSettingsUpdate
Input type: NamespaceCiCdSettingsUpdateInput
Arguments
Name |
Type |
Description |
allowStaleRunnerPruning
|
Boolean |
Indicates if stale runners directly belonging to this namespace should be periodically pruned. |
clientMutationId
|
String |
A unique identifier for the client performing the mutation. |
fullPath
|
ID! |
Full path of the namespace the settings belong to. |
Fields
Name |
Type |
Description |
ciCdSettings
|
NamespaceCiCdSetting! |
CI/CD settings after mutation. |
clientMutationId
|
String |
A unique identifier for the client performing the mutation. |
errors
|
[String!]! |
Errors encountered during execution of the mutation. |
Mutation.namespaceIncreaseStorageTemporarily
Input type: NamespaceIncreaseStorageTemporarilyInput
Arguments
Name |
Type |
Description |
clientMutationId
|
String |
A unique identifier for the client performing the mutation. |
id
|
NamespaceID! |
Global ID of the namespace to mutate. |
Fields
Name |
Type |
Description |
clientMutationId
|
String |
A unique identifier for the client performing the mutation. |
errors
|
[String!]! |
Errors encountered during execution of the mutation. |
namespace
|
Namespace |
Namespace after mutation. |
Mutation.oncallRotationCreate
Input type: OncallRotationCreateInput
Arguments
Name |
Type |
Description |
activePeriod
|
OncallRotationActivePeriodInputType |
Active period of time that the on-call rotation should take place. |
clientMutationId
|
String |
A unique identifier for the client performing the mutation. |
endsAt
|
OncallRotationDateInputType |
End date and time of the on-call rotation, in the timezone of the on-call schedule. |
name
|
String! |
Name of the on-call rotation. |
participants
|
[OncallUserInputType!]! |
Usernames of users participating in the on-call rotation. A maximum limit of 100 participants applies. |
projectPath
|
ID! |
Project to create the on-call schedule in. |
rotationLength
|
OncallRotationLengthInputType! |
Rotation length of the on-call rotation. |
scheduleIid
|
String! |
IID of the on-call schedule to create the on-call rotation in. |
startsAt
|
OncallRotationDateInputType! |
Start date and time of the on-call rotation, in the timezone of the on-call schedule. |
Fields
Name |
Type |
Description |
clientMutationId
|
String |
A unique identifier for the client performing the mutation. |
errors
|
[String!]! |
Errors encountered during execution of the mutation. |
oncallRotation
|
IncidentManagementOncallRotation |
On-call rotation. |
Mutation.oncallRotationDestroy
Input type: OncallRotationDestroyInput
Arguments
Name |
Type |
Description |
clientMutationId
|
String |
A unique identifier for the client performing the mutation. |
id
|
IncidentManagementOncallRotationID! |
ID of the on-call rotation to remove. |
projectPath
|
ID! |
Project to remove the on-call schedule from. |
scheduleIid
|
String! |
IID of the on-call schedule to the on-call rotation belongs to. |
Fields
Name |
Type |
Description |
clientMutationId
|
String |
A unique identifier for the client performing the mutation. |
errors
|
[String!]! |
Errors encountered during execution of the mutation. |
oncallRotation
|
IncidentManagementOncallRotation |
On-call rotation. |
Mutation.oncallRotationUpdate
Input type: OncallRotationUpdateInput
Arguments
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.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.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. |
jobTokenScopeEnabled
|
Boolean |
Indicates CI job tokens generated in this project have restricted access to resources. |
keepLatestArtifact
|
Boolean |
Indicates if the latest artifact should be kept for this project. |
mergePipelinesEnabled
|
Boolean |
Indicates if merge pipelines are enabled for the project. |
mergeTrainsEnabled
|
Boolean |
Indicates if merge trains are enabled for the project. |
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.projectSetComplianceFramework
Assign (or unset) a compliance framework to a project.
Input type: ProjectSetComplianceFrameworkInput
Arguments
Name |
Type |
Description |
clientMutationId
|
String |
A unique identifier for the client performing the mutation. |
complianceFrameworkId
|
ComplianceManagementFrameworkID |
ID of the compliance framework to assign to the project. Set to null to unset. |
projectId
|
ProjectID! |
ID of the project to change the compliance framework of. |
Fields
Name |
Type |
Description |
clientMutationId
|
String |
A unique identifier for the client performing the mutation. |
errors
|
[String!]! |
Errors encountered during execution of the mutation. |
project
|
Project |
Project after mutation. |
Mutation.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.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
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
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
Mutation.promoteToEpic
Input type: PromoteToEpicInput
Arguments
Name |
Type |
Description |
clientMutationId
|
String |
A unique identifier for the client performing the mutation. |
groupPath
|
ID |
Group the promoted epic will belong to. |
iid
|
String! |
IID of the issue to mutate. |
projectPath
|
ID! |
Project the issue to mutate is in. |
Fields
Name |
Type |
Description |
clientMutationId
|
String |
A unique identifier for the client performing the mutation. |
epic
|
Epic |
Epic after issue promotion. |
errors
|
[String!]! |
Errors encountered during execution of the mutation. |
issue
|
Issue |
Issue after mutation. |
Mutation.releaseAssetLinkCreate
Input type: ReleaseAssetLinkCreateInput
Arguments
Name |
Type |
Description |
clientMutationId
|
String |
A unique identifier for the client performing the mutation. |
directAssetPath
|
String |
Relative path for a direct asset link. |
linkType
|
ReleaseAssetLinkType |
Type of the asset link. |
name
|
String! |
Name of the asset link. |
projectPath
|
ID! |
Full path of the project the asset link is associated with. |
tagName
|
String! |
Name of the associated release's tag. |
url
|
String! |
URL of the asset link. |
Fields
Name |
Type |
Description |
clientMutationId
|
String |
A unique identifier for the client performing the mutation. |
errors
|
[String!]! |
Errors encountered during execution of the mutation. |
link
|
ReleaseAssetLink |
Asset link after mutation. |
Mutation.releaseAssetLinkDelete
Input type: ReleaseAssetLinkDeleteInput
Arguments
Name |
Type |
Description |
clientMutationId
|
String |
A unique identifier for the client performing the mutation. |
id
|
ReleasesLinkID! |
ID of the release asset link to delete. |
Fields
Name |
Type |
Description |
clientMutationId
|
String |
A unique identifier for the client performing the mutation. |
errors
|
[String!]! |
Errors encountered during execution of the mutation. |
link
|
ReleaseAssetLink |
Deleted release asset link. |
Mutation.releaseAssetLinkUpdate
Input type: ReleaseAssetLinkUpdateInput
Arguments
Name |
Type |
Description |
clientMutationId
|
String |
A unique identifier for the client performing the mutation. |
directAssetPath
|
String |
Relative path for a direct asset link. |
id
|
ReleasesLinkID! |
ID of the release asset link to update. |
linkType
|
ReleaseAssetLinkType |
Type of the asset link. |
name
|
String |
Name of the asset link. |
url
|
String |
URL of the asset link. |
Fields
Name |
Type |
Description |
clientMutationId
|
String |
A unique identifier for the client performing the mutation. |
errors
|
[String!]! |
Errors encountered during execution of the mutation. |
link
|
ReleaseAssetLink |
Asset link after mutation. |
Mutation.releaseCreate
Input type: ReleaseCreateInput
Arguments
Name |
Type |
Description |
assets
|
ReleaseAssetsInput |
Assets associated to the release. |
clientMutationId
|
String |
A unique identifier for the client performing the mutation. |
description
|
String |
Description (also known as "release notes") of the release. |
milestones
|
[String!] |
Title of each milestone the release is associated with. GitLab Premium customers can specify group milestones. |
name
|
String |
Name of the release. |
projectPath
|
ID! |
Full path of the project the release is associated with. |
ref
|
String |
Commit SHA or branch name to use if creating a new tag. |
releasedAt
|
Time |
Date and time for the release. Defaults to the current time. Expected in ISO 8601 format (2019-03-15T08:00:00Z ). Only provide this field if creating an upcoming or historical release. |
tagMessage
|
String |
Message to use if creating a new annotated tag. |
tagName
|
String! |
Name of the tag to associate with the release. |
Fields
Name |
Type |
Description |
clientMutationId
|
String |
A unique identifier for the client performing the mutation. |
errors
|
[String!]! |
Errors encountered during execution of the mutation. |
release
|
Release |
Release after mutation. |
Mutation.releaseDelete
Input type: ReleaseDeleteInput
Arguments
Name |
Type |
Description |
clientMutationId
|
String |
A unique identifier for the client performing the mutation. |
projectPath
|
ID! |
Full path of the project the release is associated with. |
tagName
|
String! |
Name of the tag associated with the release to delete. |
Fields
Name |
Type |
Description |
clientMutationId
|
String |
A unique identifier for the client performing the mutation. |
errors
|
[String!]! |
Errors encountered during execution of the mutation. |
release
|
Release |
Deleted release. |
Mutation.releaseUpdate
Input type: ReleaseUpdateInput
Arguments
Name |
Type |
Description |
clientMutationId
|
String |
A unique identifier for the client performing the mutation. |
description
|
String |
Description (release notes) of the release. |
milestones
|
[String!] |
Title of each milestone the release is associated with. GitLab Premium customers can specify group milestones. |
name
|
String |
Name of the release. |
projectPath
|
ID! |
Full path of the project the release is associated with. |
releasedAt
|
Time |
Release date. |
tagName
|
String! |
Name of the tag associated with the release. |
Fields
Name |
Type |
Description |
clientMutationId
|
String |
A unique identifier for the client performing the mutation. |
errors
|
[String!]! |
Errors encountered during execution of the mutation. |
release
|
Release |
Release after mutation. |
Mutation.removeProjectFromSecurityDashboard
Input type: RemoveProjectFromSecurityDashboardInput
Arguments
Name |
Type |
Description |
clientMutationId
|
String |
A unique identifier for the client performing the mutation. |
id
|
ProjectID! |
ID of the project to remove from the Instance Security Dashboard. |
Fields
Name |
Type |
Description |
clientMutationId
|
String |
A unique identifier for the client performing the mutation. |
errors
|
[String!]! |
Errors encountered during execution of the mutation. |
Mutation.repositionImageDiffNote
Repositions a DiffNote on an image (a Note
where the position.positionType
is "image"
).
Input type: RepositionImageDiffNoteInput
Arguments
Fields
Name |
Type |
Description |
clientMutationId
|
String |
A unique identifier for the client performing the mutation. |
errors
|
[String!]! |
Errors encountered during execution of the mutation. |
note
|
Note |
Note after mutation. |
Mutation.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 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' "minutes cost factor" associated with the runner (GitLab.com only). |
publicProjectsMinutesCostFactor
|
Float |
Public projects' "minutes 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.runnersRegistrationTokenReset
Input type: RunnersRegistrationTokenResetInput
Arguments
Name |
Type |
Description |
clientMutationId
|
String |
A unique identifier for the client performing the mutation. |
id
|
ID |
ID of the project or group to reset the token for. Omit if resetting instance runner token. |
type
|
CiRunnerType! |
Scope of the object to reset the token for. |
Fields
Name |
Type |
Description |
clientMutationId
|
String |
A unique identifier for the client performing the mutation. |
errors
|
[String!]! |
Errors encountered during execution of the mutation. |
token
|
String |
Runner token after mutation. |
Mutation.savedReplyCreate
Input type: SavedReplyCreateInput
Arguments
Name |
Type |
Description |
clientMutationId
|
String |
A unique identifier for the client performing the mutation. |
content
|
String! |
Content of the saved reply. |
name
|
String! |
Name of the saved reply. |
Fields
Name |
Type |
Description |
clientMutationId
|
String |
A unique identifier for the client performing the mutation. |
errors
|
[String!]! |
Errors encountered during execution of the mutation. |
savedReply
|
SavedReply |
Saved reply after mutation. |
Mutation.savedReplyDestroy
Input type: SavedReplyDestroyInput
Arguments
Name |
Type |
Description |
clientMutationId
|
String |
A unique identifier for the client performing the mutation. |
id
|
UsersSavedReplyID! |
Global ID of the saved reply. |
Fields
Name |
Type |
Description |
clientMutationId
|
String |
A unique identifier for the client performing the mutation. |
errors
|
[String!]! |
Errors encountered during execution of the mutation. |
savedReply
|
SavedReply |
Saved reply after mutation. |
Mutation.savedReplyUpdate
Input type: SavedReplyUpdateInput
Arguments
Name |
Type |
Description |
clientMutationId
|
String |
A unique identifier for the client performing the mutation. |
content
|
String! |
Content of the saved reply. |
id
|
UsersSavedReplyID! |
Global ID of the saved reply. |
name
|
String! |
Name of the saved reply. |
Fields
Name |
Type |
Description |
clientMutationId
|
String |
A unique identifier for the client performing the mutation. |
errors
|
[String!]! |
Errors encountered during execution of the mutation. |
savedReply
|
SavedReply |
Saved reply after mutation. |
Mutation.scanExecutionPolicyCommit
Commits the policy_yaml
content to the assigned security policy project for the given project (full_path
).
Input type: ScanExecutionPolicyCommitInput
Arguments
Name |
Type |
Description |
clientMutationId
|
String |
A unique identifier for the client performing the mutation. |
fullPath
|
String |
Full path of the project. |
name
|
String |
Name of the policy. If the name is null, the name field from policy_yaml is used. |
operationMode
|
MutationOperationMode! |
Changes the operation mode. |
policyYaml
|
String! |
YAML snippet of the policy. |
projectPath {warning-solid}
|
ID |
Deprecated: Use fullPath . Deprecated in 14.10. |
Fields
Name |
Type |
Description |
branch
|
String |
Name of the branch to which the policy changes are committed. |
clientMutationId
|
String |
A unique identifier for the client performing the mutation. |
errors
|
[String!]! |
Errors encountered during execution of the mutation. |
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.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. |
uuid
|
String |
UUID of dismissed finding. |
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 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 (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 14.10. |
Fields
Name |
Type |
Description |
clientMutationId
|
String |
A unique identifier for the client performing the mutation. |
errors
|
[String!]! |
Errors encountered during execution of the mutation. |
project
|
Project |
Security Policy Project that was created. |
Mutation.securityPolicyProjectUnassign
Unassigns the security policy project for the given project (full_path
).
Input type: SecurityPolicyProjectUnassignInput
Arguments
Name |
Type |
Description |
clientMutationId
|
String |
A unique identifier for the client performing the mutation. |
fullPath
|
String |
Full path of the project or group. |
projectPath {warning-solid}
|
ID |
Deprecated: Use fullPath . Deprecated in 14.10. |
Fields
Name |
Type |
Description |
clientMutationId
|
String |
A unique identifier for the client performing the mutation. |
errors
|
[String!]! |
Errors encountered during execution of the mutation. |
Mutation.securityTrainingUpdate
Input type: SecurityTrainingUpdateInput
Arguments
Name |
Type |
Description |
clientMutationId
|
String |
A unique identifier for the client performing the mutation. |
isEnabled
|
Boolean! |
Sets the training provider as enabled for the project. |
isPrimary
|
Boolean |
Sets the training provider as primary for the project. |
projectPath
|
ID! |
Full path of the project. |
providerId
|
SecurityTrainingProviderID! |
ID of the provider. |
Fields
Name |
Type |
Description |
clientMutationId
|
String |
A unique identifier for the client performing the mutation. |
errors
|
[String!]! |
Errors encountered during execution of the mutation. |
training
|
ProjectSecurityTraining |
Represents the training entity subject to mutation. |
Mutation.terraformStateDelete
Input type: TerraformStateDeleteInput
Arguments
Name |
Type |
Description |
clientMutationId
|
String |
A unique identifier for the client performing the mutation. |
id
|
TerraformStateID! |
Global ID of the Terraform state. |
Fields
Name |
Type |
Description |
clientMutationId
|
String |
A unique identifier for the client performing the mutation. |
errors
|
[String!]! |
Errors encountered during execution of the mutation. |
Mutation.terraformStateLock
Input type: TerraformStateLockInput
Arguments
Name |
Type |
Description |
clientMutationId
|
String |
A unique identifier for the client performing the mutation. |
id
|
TerraformStateID! |
Global ID of the Terraform state. |
Fields
Name |
Type |
Description |
clientMutationId
|
String |
A unique identifier for the client performing the mutation. |
errors
|
[String!]! |
Errors encountered during execution of the mutation. |
Mutation.terraformStateUnlock
Input type: TerraformStateUnlockInput
Arguments
Name |
Type |
Description |
clientMutationId
|
String |
A unique identifier for the client performing the mutation. |
id
|
TerraformStateID! |
Global ID of the Terraform state. |
Fields
Name |
Type |
Description |
clientMutationId
|
String |
A unique identifier for the client performing the mutation. |
errors
|
[String!]! |
Errors encountered during execution of the mutation. |
Mutation.timelineEventCreate
Input type: TimelineEventCreateInput
Arguments
Name |
Type |
Description |
clientMutationId
|
String |
A unique identifier for the client performing the mutation. |
incidentId
|
IssueID! |
Incident ID of the timeline event. |
note
|
String! |
Text note of the timeline event. |
occurredAt
|
Time! |
Timestamp of when the event occurred. |
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
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.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. |
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
|
Date! |
When the time was spent. |
summary
|
String! |
Summary of time spent. |
timeSpent
|
String! |
Amount of time spent. |
Fields
Name |
Type |
Description |
clientMutationId
|
String |
A unique identifier for the client performing the mutation. |
errors
|
[String!]! |
Errors encountered during execution of the mutation. |
timelog
|
Timelog |
Timelog. |
Mutation.timelogDelete
Input type: TimelogDeleteInput
Arguments
Name |
Type |
Description |
clientMutationId
|
String |
A unique identifier for the client performing the mutation. |
id
|
TimelogID! |
Global ID of the timelog. |
Fields
Name |
Type |
Description |
clientMutationId
|
String |
A unique identifier for the client performing the mutation. |
errors
|
[String!]! |
Errors encountered during execution of the mutation. |
timelog
|
Timelog |
Timelog. |
Mutation.todoCreate
Input type: TodoCreateInput
Arguments
Name |
Type |
Description |
clientMutationId
|
String |
A unique identifier for the client performing the mutation. |
targetId
|
TodoableID! |
Global ID of the to-do item's parent. Issues, merge requests, designs, and epics are supported. |
Fields
Name |
Type |
Description |
clientMutationId
|
String |
A unique identifier for the client performing the mutation. |
errors
|
[String!]! |
Errors encountered during execution of the mutation. |
todo
|
Todo |
To-do item created. |
Mutation.todoMarkDone
Input type: TodoMarkDoneInput
Arguments
Name |
Type |
Description |
clientMutationId
|
String |
A unique identifier for the client performing the mutation. |
id
|
TodoID! |
Global ID of the to-do item to mark as done. |
Fields
Name |
Type |
Description |
clientMutationId
|
String |
A unique identifier for the client performing the mutation. |
errors
|
[String!]! |
Errors encountered during execution of the mutation. |
todo
|
Todo! |
Requested to-do item. |
Mutation.todoRestore
Input type: TodoRestoreInput
Arguments
Name |
Type |
Description |
clientMutationId
|
String |
A unique identifier for the client performing the mutation. |
id
|
TodoID! |
Global ID of the to-do item to restore. |
Fields
Name |
Type |
Description |
clientMutationId
|
String |
A unique identifier for the client performing the mutation. |
errors
|
[String!]! |
Errors encountered during execution of the mutation. |
todo
|
Todo! |
Requested to-do item. |
Mutation.todoRestoreMany
Input type: TodoRestoreManyInput
Arguments
Name |
Type |
Description |
clientMutationId
|
String |
A unique identifier for the client performing the mutation. |
ids
|
[TodoID!]! |
Global IDs of the to-do items to restore (a maximum of 50 is supported at once). |
Fields
Name |
Type |
Description |
clientMutationId
|
String |
A unique identifier for the client performing the mutation. |
errors
|
[String!]! |
Errors encountered during execution of the mutation. |
todos
|
[Todo!]! |
Updated to-do items. |
Mutation.todosMarkAllDone
Input type: TodosMarkAllDoneInput
Arguments
Name |
Type |
Description |
clientMutationId
|
String |
A unique identifier for the client performing the mutation. |
targetId
|
TodoableID |
Global ID of the to-do item's parent. Issues, merge requests, designs, and epics are supported. If argument is omitted, all pending to-do items of the current user are marked as done. |
Fields
Name |
Type |
Description |
clientMutationId
|
String |
A unique identifier for the client performing the mutation. |
errors
|
[String!]! |
Errors encountered during execution of the mutation. |
todos
|
[Todo!]! |
Updated to-do items. |
Mutation.updateAlertStatus
Input type: UpdateAlertStatusInput
Arguments
Name |
Type |
Description |
clientMutationId
|
String |
A unique identifier for the client performing the mutation. |
iid
|
String! |
IID of the alert to mutate. |
projectPath
|
ID! |
Project the alert to mutate is in. |
status
|
AlertManagementStatus! |
Status to set the alert. |
Fields
Name |
Type |
Description |
alert
|
AlertManagementAlert |
Alert after mutation. |
clientMutationId
|
String |
A unique identifier for the client performing the mutation. |
errors
|
[String!]! |
Errors encountered during execution of the mutation. |
issue
|
Issue |
Issue created after mutation. |
todo
|
Todo |
To-do item after mutation. |
Mutation.updateBoard
Input type: UpdateBoardInput
Arguments
Name |
Type |
Description |
assigneeId
|
UserID |
ID of user to be assigned to the board. |
clientMutationId
|
String |
A unique identifier for the client performing the mutation. |
hideBacklogList
|
Boolean |
Whether or not backlog list is hidden. |
hideClosedList
|
Boolean |
Whether or not closed list is hidden. |
id
|
BoardID! |
Board global ID. |
iterationCadenceId
|
IterationsCadenceID |
ID of iteration cadence to be assigned to the board. |
iterationId
|
IterationID |
ID of iteration to be assigned to the board. |
labelIds
|
[LabelID!] |
IDs of labels to be added to the board. |
labels
|
[String!] |
Labels of the issue. |
milestoneId
|
MilestoneID |
ID of milestone to be assigned to the board. |
name
|
String |
Board name. |
weight
|
Int |
Weight value to be assigned to the board. |
Fields
Name |
Type |
Description |
board
|
Board |
Board after mutation. |
clientMutationId
|
String |
A unique identifier for the client performing the mutation. |
errors
|
[String!]! |
Errors encountered during execution of the mutation. |
Mutation.updateBoardEpicUserPreferences
Input type: UpdateBoardEpicUserPreferencesInput
Arguments
Name |
Type |
Description |
boardId
|
BoardID! |
Board global ID. |
clientMutationId
|
String |
A unique identifier for the client performing the mutation. |
collapsed
|
Boolean! |
Whether the epic should be collapsed in the board. |
epicId
|
EpicID! |
ID of an epic to set preferences for. |
Fields
Name |
Type |
Description |
clientMutationId
|
String |
A unique identifier for the client performing the mutation. |
epicUserPreferences
|
BoardEpicUserPreferences |
User preferences for the epic in the board after mutation. |
errors
|
[String!]! |
Errors encountered during execution of the mutation. |
Mutation.updateBoardList
Input type: UpdateBoardListInput
Arguments
Name |
Type |
Description |
clientMutationId
|
String |
A unique identifier for the client performing the mutation. |
collapsed
|
Boolean |
Indicates if the list is collapsed for this 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
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
Fields
Name |
Type |
Description |
clientMutationId
|
String |
A unique identifier for the client performing the mutation. |
containerExpirationPolicy
|
ContainerExpirationPolicy |
Container expiration policy after mutation. |
errors
|
[String!]! |
Errors encountered during execution of the mutation. |
Mutation.updateDependencyProxyImageTtlGroupPolicy
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.updateDependencyProxySettings
These settings can be adjusted by the group Owner or Maintainer. However, in GitLab 16.0, we will be limiting this to the Owner role. GitLab-#364441 proposes making this change to match the permissions level in the user interface.
Input type: UpdateDependencyProxySettingsInput
Arguments
Name |
Type |
Description |
clientMutationId
|
String |
A unique identifier for the client performing the mutation. |
enabled
|
Boolean |
Indicates whether the policy is enabled or disabled. |
groupPath
|
ID! |
Group path for the group dependency proxy. |
Fields
Name |
Type |
Description |
clientMutationId
|
String |
A unique identifier for the client performing the mutation. |
dependencyProxySetting
|
DependencyProxySetting |
Group dependency proxy settings after mutation. |
errors
|
[String!]! |
Errors encountered during execution of the mutation. |
Mutation.updateEpic
Input type: UpdateEpicInput
Arguments
Name |
Type |
Description |
addLabelIds
|
[ID!] |
IDs of labels to be added to the epic. |
addLabels
|
[String!] |
Array of labels to be added to the epic. |
clientMutationId
|
String |
A unique identifier for the client performing the mutation. |
color
|
Color |
Color of the epic. Available only when feature flag epic_color_highlight is enabled. This flag is disabled by default, because the feature is experimental and is subject to change without notice. |
confidential
|
Boolean |
Indicates if the epic is confidential. |
description
|
String |
Description of the epic. |
dueDateFixed
|
String |
End date of the epic. |
dueDateIsFixed
|
Boolean |
Indicates end date should be sourced from due_date_fixed field not the issue milestones. |
groupPath
|
ID! |
Group the epic to mutate is in. |
iid
|
ID! |
IID of the epic to mutate. |
removeLabelIds
|
[ID!] |
IDs of labels to be removed from the epic. |
removeLabels
|
[String!] |
Array of labels to be removed from the epic. |
startDateFixed
|
String |
Start date of the epic. |
startDateIsFixed
|
Boolean |
Indicates start date should be sourced from start_date_fixed field not the issue milestones. |
stateEvent
|
EpicStateEvent |
State event for the epic. |
title
|
String |
Title of the epic. |
Fields
Name |
Type |
Description |
clientMutationId
|
String |
A unique identifier for the client performing the mutation. |
epic
|
Epic |
Epic after mutation. |
errors
|
[String!]! |
Errors encountered during execution of the mutation. |
Mutation.updateEpicBoardList
Input type: UpdateEpicBoardListInput
Arguments
Name |
Type |
Description |
clientMutationId
|
String |
A unique identifier for the client performing the mutation. |
collapsed
|
Boolean |
Indicates if the list is collapsed for this user. |
listId
|
BoardsEpicListID! |
Global ID of the epic list. |
position
|
Int |
Position of list within the board. |
Fields
Name |
Type |
Description |
clientMutationId
|
String |
A unique identifier for the client performing the mutation. |
errors
|
[String!]! |
Errors encountered during execution of the mutation. |
list
|
EpicList |
Mutated epic list. |
Mutation.updateImageDiffNote
Updates a DiffNote on an image (a Note
where the position.positionType
is "image"
).
If the body of the Note contains only quick actions,
the Note will be destroyed during an update, and no Note will be
returned.
Input type: UpdateImageDiffNoteInput
Arguments
Name |
Type |
Description |
body
|
String |
Content of the note. |
clientMutationId
|
String |
A unique identifier for the client performing the mutation. |
id
|
NoteID! |
Global ID of the note to update. |
position
|
UpdateDiffImagePositionInput |
Position of this note on a diff. |
Fields
Name |
Type |
Description |
clientMutationId
|
String |
A unique identifier for the client performing the mutation. |
errors
|
[String!]! |
Errors encountered during execution of the mutation. |
note
|
Note |
Note after mutation. |
Mutation.updateIssue
Input type: UpdateIssueInput
Arguments
Name |
Type |
Description |
addLabelIds
|
[ID!] |
IDs of labels to be added to the issue. |
clientMutationId
|
String |
A unique identifier for the client performing the mutation. |
confidential
|
Boolean |
Indicates the issue is confidential. |
description
|
String |
Description of the issue. |
dueDate
|
ISO8601Date |
Due date of the issue. |
epicId
|
EpicID |
ID of the parent epic. NULL when removing the association. |
healthStatus
|
HealthStatus |
Desired health status. |
iid
|
String! |
IID of the issue to mutate. |
labelIds
|
[ID!] |
IDs of labels to be set. Replaces existing issue labels. |
locked
|
Boolean |
Indicates discussion is locked on the issue. |
milestoneId
|
ID |
ID of the milestone to assign to the issue. On update milestone will be removed if set to null. |
projectPath
|
ID! |
Project the issue to mutate is in. |
removeLabelIds
|
[ID!] |
IDs of labels to be removed from the issue. |
stateEvent
|
IssueStateEvent |
Close or reopen an issue. |
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
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. |
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. |
namespacePath
|
ID! |
Namespace path where the namespace package setting 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. |
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 14.10. |
id
|
NoteID! |
Global ID of the note to update. |
Fields
Name |
Type |
Description |
clientMutationId
|
String |
A unique identifier for the client performing the mutation. |
errors
|
[String!]! |
Errors encountered during execution of the mutation. |
note
|
Note |
Note after mutation. |
Mutation.updatePackagesCleanupPolicy
Input type: UpdatePackagesCleanupPolicyInput
Arguments
Name |
Type |
Description |
clientMutationId
|
String |
A unique identifier for the client performing the mutation. |
keepNDuplicatedPackageFiles
|
PackagesCleanupKeepDuplicatedPackageFilesEnum |
Number of duplicated package files to retain. |
projectPath
|
ID! |
Project path where the packages cleanup policy is located. |
Fields
Name |
Type |
Description |
clientMutationId
|
String |
A unique identifier for the client performing the mutation. |
errors
|
[String!]! |
Errors encountered during execution of the mutation. |
packagesCleanupPolicy
|
PackagesCleanupPolicy |
Packages cleanup policy after mutation. |
Mutation.updateRequirement
Input type: UpdateRequirementInput
Arguments
Name |
Type |
Description |
clientMutationId
|
String |
A unique identifier for the client performing the mutation. |
description
|
String |
Description of the requirement. |
iid
|
String! |
IID of the requirement to update. |
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. |
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.userCalloutCreate
Input type: UserCalloutCreateInput
Arguments
Name |
Type |
Description |
clientMutationId
|
String |
A unique identifier for the client performing the mutation. |
featureName
|
String! |
Feature name you want to dismiss the callout for. |
Fields
Name |
Type |
Description |
clientMutationId
|
String |
A unique identifier for the client performing the mutation. |
errors
|
[String!]! |
Errors encountered during execution of the mutation. |
userCallout
|
UserCallout! |
User callout dismissed. |
Mutation.userPreferencesUpdate
Input type: UserPreferencesUpdateInput
Arguments
Name |
Type |
Description |
clientMutationId
|
String |
A unique identifier for the client performing the mutation. |
issuesSort
|
IssueSort |
Sort order for issue lists. |
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.vulnerabilityConfirm
Input type: VulnerabilityConfirmInput
Arguments
Name |
Type |
Description |
clientMutationId
|
String |
A unique identifier for the client performing the mutation. |
id
|
VulnerabilityID! |
ID of the vulnerability to be confirmed. |
Fields
Name |
Type |
Description |
clientMutationId
|
String |
A unique identifier for the client performing the mutation. |
errors
|
[String!]! |
Errors encountered during execution of the mutation. |
vulnerability
|
Vulnerability |
Vulnerability after state change. |
Mutation.vulnerabilityCreate
Input type: VulnerabilityCreateInput
Arguments
Name |
Type |
Description |
clientMutationId
|
String |
A unique identifier for the client performing the mutation. |
confidence {warning-solid}
|
VulnerabilityConfidence |
Deprecated: This field will be removed from the Vulnerability domain model. Deprecated in 15.4. |
confirmedAt
|
Time |
Timestamp of when the vulnerability state changed to confirmed (defaults to creation time if status is confirmed ). |
description
|
String! |
Long text section that describes the vulnerability in more detail. |
detectedAt
|
Time |
Timestamp of when the vulnerability was first detected (defaults to creation time). |
dismissedAt
|
Time |
Timestamp of when the vulnerability state changed to dismissed (defaults to creation time if status is dismissed ). |
identifiers
|
[VulnerabilityIdentifierInput!]! |
Array of CVE or CWE identifiers for the vulnerability. |
message
|
String |
Short text section that describes the vulnerability. This may include the finding's specific information. |
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 should be dismissed. |
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 dismissal. |
Mutation.vulnerabilityExternalIssueLinkCreate
Input type: VulnerabilityExternalIssueLinkCreateInput
Arguments
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
|
|