GraphQL API 입력 타입
GitLab v19.6요약
Input types are structured arguments passed to queries, mutations, and other fields. Deprecated items are planned to be removed in a future release.
Input types are structured arguments passed to queries, mutations, and other fields. For more information, see the GraphQL input types documentation.
Deprecated items are planned to be removed in a future release. For more information, see the GitLab deprecation process.
AgentPlatformMetricsNotInput#
AgentPlatformMetricsNotInput arguments#
| Name | Type | Description |
|---|---|---|
flowTypes |
[String!] |
List of flow types to exclude. |
AggregationOrder#
AggregationOrder arguments#
| Name | Type | Description |
|---|---|---|
direction |
SortDirectionEnum! |
Sorting direction. |
identifier |
String! |
Dimension or metric identifier. |
parameters |
JSON |
Parameters for parameterized dimensions. |
AggregationScopeInput#
AggregationScopeInput arguments#
| Name | Type | Description |
|---|---|---|
groupFullPaths |
[ID!] |
Full paths of groups to aggregate data for. Combined with projectFullPaths, at most 20 sources can be requested. |
projectFullPaths |
[ID!] |
Full paths of projects to aggregate data for. Combined with groupFullPaths, at most 20 sources can be requested. |
AiAdditionalContextInput#
AiAdditionalContextInput arguments#
| Name | Type | Description |
|---|---|---|
category |
AiAdditionalContextCategory! |
Category of the additional context. |
content |
String! |
Content of the additional context. |
id |
String! |
ID of the additional context. |
metadata |
JSON |
Metadata of the additional context. |
AiAgenticChatInput#
AiAgenticChatInput arguments#
| Name | Type | Description |
|---|---|---|
additionalContext |
[AiAdditionalContextInput!] |
Additional context to be passed for the chat. |
content |
String! |
Content of the message. |
currentFile |
AiCurrentFileInput |
Information about currently selected text which can be passed for additional context. |
namespaceId |
NamespaceID |
Global ID of the namespace the user is acting on. |
resourceId |
AiModelID! |
Global ID of the resource to mutate. |
AiCatalogTriggerConditionsGroupInput#
Group of rules for a set of trigger conditions.
AiCatalogTriggerConditionsGroupInput arguments#
| Name | Type | Description |
|---|---|---|
match |
AiCatalogTriggerConditionsMatch |
Strategy used to match the rules in the group. |
rules |
[AiCatalogTriggerConditionsRuleItemInput!]! |
Rules in the group. |
AiCatalogTriggerConditionsInput#
Conditions for AI Catalog triggers.
AiCatalogTriggerConditionsInput arguments#
| Name | Type | Description |
|---|---|---|
assign |
AiCatalogTriggerConditionsGroupInput |
Trigger condition rules for the assign event. |
assignReviewer |
AiCatalogTriggerConditionsGroupInput |
Trigger condition rules for the assign_reviewer event. |
commitToDefaultBranch |
AiCatalogTriggerConditionsGroupInput |
Trigger condition rules for the commit_to_default_branch event. |
mention |
AiCatalogTriggerConditionsGroupInput |
Trigger condition rules for the mention event. |
mergeRequest |
AiCatalogTriggerConditionsGroupInput |
Trigger condition rules for the merge_request event. |
mergeRequestCodeConflict |
AiCatalogTriggerConditionsGroupInput |
Trigger condition rules for the merge_request_code_conflict event. |
mergeRequestReady |
AiCatalogTriggerConditionsGroupInput |
Trigger condition rules for the merge_request_ready event. |
pipelineHooks |
AiCatalogTriggerConditionsGroupInput |
Trigger condition rules for the pipeline_hooks event. |
scheduled |
AiCatalogTriggerConditionsGroupInput |
Introduced as an experiment in GitLab 19.4. Trigger condition rules for the scheduled event. |
workItem |
AiCatalogTriggerConditionsGroupInput |
Trigger condition rules for the work_item event. |
AiCatalogTriggerConditionsRuleItemInput#
Item within a trigger conditions group. Provide either the rule fields (field, operator, value) or rules for a nested group, but not both. match can only be provided with rules.
AiCatalogTriggerConditionsRuleItemInput arguments#
| Name | Type | Description |
|---|---|---|
field |
String |
Field the rule applies to. |
match |
AiCatalogTriggerConditionsMatch |
Strategy used to match the rules in the nested group. |
operator |
AiCatalogTriggerConditionsOperator |
Operator used to compare the field to the value. |
rules |
[AiCatalogTriggerConditionsRuleItemInput!] |
Rules in the nested group. |
value |
JSON |
Value to compare the field against. |
AiChatInput#
AiChatInput arguments#
| Name | Type | Description |
|---|---|---|
additionalContext |
[AiAdditionalContextInput!] |
Additional context to be passed for the chat. |
content |
String! |
Content of the message. |
currentFile |
AiCurrentFileInput |
Information about currently selected text which can be passed for additional context. |
namespaceId |
NamespaceID |
Global ID of the namespace the user is acting on. |
resourceId |
AiModelID |
Global ID of the resource to mutate. |
AiCurrentFileInput#
AiCurrentFileInput arguments#
| Name | Type | Description |
|---|---|---|
contentAboveCursor |
String |
Content above cursor. |
contentBelowCursor |
String |
Content below cursor. |
fileName |
String! |
File name. |
selectedText |
String! |
Selected text. |
AiExplainVulnerabilityInput#
AiExplainVulnerabilityInput arguments#
| Name | Type | Description |
|---|---|---|
includeSourceCode |
Boolean |
Include vulnerability source code in the AI prompt. |
resourceId |
AiModelID! |
Global ID of the resource to mutate. |
AiGenerateCommitMessageInput#
AiGenerateCommitMessageInput arguments#
| Name | Type | Description |
|---|---|---|
resourceId |
AiModelID! |
Global ID of the resource to mutate. |
AiGenerateDescriptionInput#
AiGenerateDescriptionInput arguments#
| Name | Type | Description |
|---|---|---|
content |
String! |
Content of the message. |
descriptionTemplateName |
String |
Name of the description template to use to generate message off of. |
resourceId |
AiModelID! |
Global ID of the resource to mutate. |
AiGovernanceSessionNegatedFilterInput#
Negated filter arguments for AI governance sessions.
AiGovernanceSessionNegatedFilterInput arguments#
| Name | Type | Description |
|---|---|---|
flowType |
String |
Exclude sessions with the flow type. |
projectPath |
String |
Exclude sessions belonging to the project full path. |
triggeredByUserId |
UserID |
Exclude sessions triggered by the user with the given global ID. |
AiResolveVulnerabilityInput#
AiResolveVulnerabilityInput arguments#
| Name | Type | Description |
|---|---|---|
resourceId |
AiModelID! |
Global ID of the resource to mutate. |
vulnerableMergeRequestId |
MergeRequestID |
Global ID of the merge request which the merge request containing the vulnerability resolution will target. |
AiSummarizeNewMergeRequestInput#
Summarize a new merge request based on two branches. Returns null if the add_ai_summary_for_new_mr feature flag is disabled.
AiSummarizeNewMergeRequestInput arguments#
| Name | Type | Description |
|---|---|---|
resourceId |
AiModelID! |
Global ID of the resource to mutate. |
sourceBranch |
String! |
Source branch of the changes. |
sourceProjectId |
ID |
ID of the project where the changes are from. |
targetBranch |
String! |
Target branch of where the changes will be merged into. |
AiSummarizeReviewInput#
AiSummarizeReviewInput arguments#
| Name | Type | Description |
|---|---|---|
resourceId |
AiModelID! |
Global ID of the resource to mutate. |
AlertManagementPayloadAlertFieldInput#
Field that are available while modifying the custom mapping attributes for an HTTP integration.
AlertManagementPayloadAlertFieldInput arguments#
| Name | Type | Description |
|---|---|---|
fieldName |
AlertManagementPayloadAlertFieldName! |
GitLab alert field name. |
label |
String |
Human-readable label of the payload path. |
path |
[PayloadAlertFieldPathSegment!]! |
Path to value inside payload JSON. |
type |
AlertManagementPayloadAlertFieldType! |
Type of the parsed value. |
AnalyzerFilterInput#
Input type for filtering projects by analyzer type and status.
AnalyzerFilterInput arguments#
| Name | Type | Description |
|---|---|---|
analyzerType |
AnalyzerTypeEnum! |
Type of analyzer to filter by. |
status |
AnalyzerStatusEnum! |
Status of the analyzer to filter by. |
ArtifactRegistryRemoteCredentialsInput#
Upstream credentials for a remote Artifact Registry repository. Write-only: no field returns them.
ArtifactRegistryRemoteCredentialsInput arguments#
| Name | Type | Description |
|---|---|---|
authToken |
String |
Introduced as an experiment in GitLab 19.4. Bearer token for the upstream. npm only. |
password |
String |
Introduced as an experiment in GitLab 19.4. Password for the upstream. Maven and the container formats only; pair it with a username. |
username |
String |
Introduced as an experiment in GitLab 19.4. Username for the upstream. Maven and the container formats only; pair it with a password. |
ArtifactRegistryRemoteSettingsInput#
Writable upstream configuration of a remote Artifact Registry repository.
ArtifactRegistryRemoteSettingsInput arguments#
| Name | Type | Description |
|---|---|---|
cacheValidityHours |
Int |
Introduced as an experiment in GitLab 19.4. Revalidation window for cached artifacts, in hours. Between 0 and 32767, where 0 means cached artifacts never revalidate. |
credentials |
ArtifactRegistryRemoteCredentialsInput |
Introduced as an experiment in GitLab 19.4. Upstream credentials. Omit to leave the stored ones unchanged, supply an object to replace them, or, on an update, supply null to clear them. |
metadataCacheValidityHours |
Int |
Introduced as an experiment in GitLab 19.4. Revalidation window for cached metadata, in hours. Between 1 and 32767, so metadata always revalidates on a schedule. Maven and npm only; other formats reject it. |
snapshotMetadataAlwaysRevalidate |
Boolean |
Introduced as an experiment in GitLab 19.4. Whether snapshot metadata revalidates on every read instead of on the metadata window. Maven only; other formats reject it. |
url |
String |
Introduced as an experiment in GitLab 19.4. Base URL of the upstream registry, at most 1024 characters. Changing it resets the health fields, evicts the cached artifacts, and clears the stored credentials unless the same request supplies new ones. |
ArtifactRegistryRoleAssignmentInput#
Single Artifact Registry role assignment.
ArtifactRegistryRoleAssignmentInput arguments#
| Name | Type | Description |
|---|---|---|
assigneeId |
UserID! |
Global ID of the user to grant the role to. |
resourceId |
String! |
UUID of the Artifact Registry resource (repository or namespace) the role applies to. |
role |
ArtifactRegistryRole! |
Artifact Registry role to grant. |
ArtifactRegistryRoleRevocationInput#
Single Artifact Registry role revocation. Names no role: a user holds one role per resource, and revoking removes it.
ArtifactRegistryRoleRevocationInput arguments#
| Name | Type | Description |
|---|---|---|
assigneeId |
UserID! |
Global ID of the user to revoke the role from. |
resourceId |
String! |
UUID of the Artifact Registry resource (repository or namespace) the role is assigned on. |
AscpSecurityGuidelineInput#
Input type for creating a security guideline.
AscpSecurityGuidelineInput arguments#
| Name | Type | Description | Default |
|---|---|---|---|
businessContext |
String |
How to assess business impact if violated. | |
legitimateUse |
String |
When the operation is expected and acceptable. | |
name |
String! |
Policy name. | |
operation |
String! |
Security-sensitive operation. | |
securityBoundary |
String |
When the operation becomes a security risk. | |
severityIfViolated |
AscpSeverity |
Severity level if the guideline is violated. | MEDIUM |
AttributeFilterInput#
Input type for filtering projects by security attributes.
AttributeFilterInput arguments#
| Name | Type | Description |
|---|---|---|
attributes |
[SecurityAttributeID!]! |
Global IDs of the security attributes to filter by. Up to 20 values. |
operator |
AttributeFilterOperator! |
Operator to apply for the attribute filter. |
BaseGroupsResolverNegatedParams#
BaseGroupsResolverNegatedParams arguments#
| Name | Type | Description |
|---|---|---|
ids |
[GroupID!] |
Filters groups to exclude the group IDs provided in the given array. Up to 10 values. |
BoardIssueInput#
BoardIssueInput arguments#
| Name | Type | Description |
|---|---|---|
assigneeUsername |
[String] |
Filter by assignee username. |
assigneeWildcardId |
AssigneeWildcardId |
Filter by assignee wildcard. Incompatible with assigneeUsername and assigneeUsernames. |
authorUsername |
String |
Filter by author username. |
confidential |
Boolean |
Filter by confidentiality. |
customField |
[WorkItemWidgetCustomFieldFilterInputType!] |
Introduced as an experiment in GitLab 17.10. Filter by custom fields. |
epicId |
EpicID |
Deprecated in GitLab 17.5. This will be replaced by WorkItem hierarchyWidget. |
epicWildcardId |
EpicWildcardId |
Filter by epic ID wildcard. Incompatible with epicId. |
healthStatusFilter |
HealthStatusFilter |
Health status of the issue, "none" and "any" values are supported. |
iids |
[String!] |
List of IIDs of issues. For example ["1", "2"]. |
includeSubepics |
Boolean |
Whether to include subepics when filtering issues by epicId. |
iterationCadenceId |
[IterationsCadenceID!] |
Filter by a list of iteration cadence IDs. |
iterationId |
[IterationID!] |
Filter by a list of iteration IDs. Incompatible with iterationWildcardId. |
iterationTitle |
String |
Filter by iteration title. |
iterationWildcardId |
IterationWildcardId |
Filter by iteration ID wildcard. |
labelName |
[String] |
Filter by label name. |
milestoneTitle |
String |
Filter by milestone title. |
milestoneWildcardId |
MilestoneWildcardId |
Filter by milestone ID wildcard. |
myReactionEmoji |
String |
Filter by reaction emoji applied by the current user. Wildcard values "NONE" and "ANY" are supported. |
not |
NegatedBoardIssueInput |
List of negated arguments. |
or |
UnionedIssueFilterInput |
List of arguments with inclusive OR. |
releaseTag |
String |
Filter by release tag. |
search |
String |
Search query for issue title or description. |
status |
WorkItemWidgetStatusFilterInput |
Introduced as an experiment in GitLab 18.0. Filter by status. |
types |
[IssueType!] |
Filter by the given issue types. |
weight |
String |
Filter by weight. |
weightWildcardId |
WeightWildcardId |
Filter by weight ID wildcard. Incompatible with weight. |
workItemTypeIds |
[WorkItemsTypeID!] |
Filter by work item type global IDs. |
BranchProtectionInput#
BranchProtectionInput arguments#
| Name | Type | Description | Default |
|---|---|---|---|
allowForcePush |
Boolean |
Allows users with write access to the branch rule target to force push changes. | false |
codeOwnerApprovalRequired |
Boolean |
Enforce code owner approvals before allowing a merge. | true |
mergeAccessLevels |
[MergeAccessLevelInput!] |
Details about who can merge into the branch rule target. | [] |
pushAccessLevels |
[PushAccessLevelInput!] |
Details about who can push to the branch rule target. | [] |
BudgetCapUserOverrideInput#
Input for a per-user budget cap override.
BudgetCapUserOverrideInput arguments#
| Name | Type | Description |
|---|---|---|
cap |
Float! |
Budget cap amount for the user. |
enabled |
Boolean! |
Whether the budget cap is enabled for the user. |
userId |
UserID |
Global ID of the user. Exactly one of userId or username must be provided. |
username |
String |
Introduced as an experiment in GitLab 19.5. Username of the user. Exactly one of userId or username must be provided. |
BulkToolRuleInput#
Input for a single tool rule update within a bulk operation.
BulkToolRuleInput arguments#
| Name | Type | Description |
|---|---|---|
backgroundAccess |
AiBackgroundToolPermission |
Introduced as an experiment in GitLab 19.3. Permission mode for the background-flow surface. Omitting the field sets it to null, clearing any existing value. |
localAccess |
AiToolPermission |
Permission mode for local or IDE surface. Omitting the field sets it to null, clearing any existing value. |
toolId |
String! |
Tool name string identifying the tool to update. For example, "create_issue". |
webAccess |
AiToolPermission |
Permission mode for web surface. Omitting the field sets it to null, clearing any existing value. |
CdArtifactSourceInput#
Attributes for a continuous deployment artifact source.
CdArtifactSourceInput arguments#
| Name | Type | Description |
|---|---|---|
name |
String! |
Name of the artifact source. |
sourceConfig |
JSON |
Configuration of the artifact source, defined by the consuming driver. |
sourceRef |
String! |
Reference of the artifact source. |
CdEnvironmentDriverBindingInput#
Attributes for a continuous deployment environment driver binding.
CdEnvironmentDriverBindingInput arguments#
| Name | Type | Description |
|---|---|---|
driverConfig |
JSON! |
Configuration of the environment driver binding, defined by the driver's own schema. |
driverRef |
String! |
Reference of the driver. |
CdServiceInput#
Attributes for a continuous deployment service.
CdServiceInput arguments#
| Name | Type | Description |
|---|---|---|
artifactSources |
[CdArtifactSourceInput!] |
Artifact sources to create for the service, up to 1000. |
description |
String |
Description of the service. |
name |
String! |
Name of the service. |
CiInputsInput#
Attributes for defining an input.
CiInputsInput arguments#
| Name | Type | Description |
|---|---|---|
destroy |
Boolean |
Set to true to delete the input. |
name |
String! |
Name of the input. |
value |
CiInputsValue! |
Value of the input. |
CiVariableInput#
Attributes for defining a CI/CD variable.
CiVariableInput arguments#
| Name | Type | Description |
|---|---|---|
key |
String! |
Name of the variable. |
value |
String! |
Value of the variable. |
variableType |
CiVariableType |
Type of variable. |
CommitAction#
CommitAction arguments#
| Name | Type | Description |
|---|---|---|
action |
CommitActionMode! |
Action to perform: create, delete, move, update, or chmod. |
content |
String |
Content of the file. |
encoding |
CommitEncoding |
Encoding of the file. Default is text. |
executeFilemode |
Boolean |
Enables/disables the execute flag on the file. |
filePath |
String! |
Full path to the file. |
lastCommitId |
String |
Last known file commit ID. |
previousPath |
String |
Original full path to the file being moved. |
ComplianceFrameworkFilters#
ComplianceFrameworkFilters arguments#
| Name | Type | Description |
|---|---|---|
id |
ComplianceManagementFrameworkID |
ID of the compliance framework. |
ids |
[ComplianceManagementFrameworkID!] |
IDs of the compliance framework. |
not |
NegatedComplianceFrameworkFilters |
Negated compliance framework filter input. |
presenceFilter |
ComplianceFrameworkPresenceFilter |
Checks presence of compliance framework of the project, "none" and "any" values are supported. |
ComplianceFrameworkInput#
ComplianceFrameworkInput arguments#
| Name | Type | Description |
|---|---|---|
color |
String |
New color representation of the compliance framework in hex format. e.g. #FCA121. |
default |
Boolean |
Set the compliance framework as the default framework for the group. |
description |
String |
New description for the compliance framework. |
name |
String |
New name for the compliance framework. |
pipelineConfigurationFullPath |
String |
Deprecated in GitLab 17.4. Use pipeline execution policies instead. |
projects |
ComplianceFrameworkProjectInput |
Projects to add or remove from the compliance framework. |
ComplianceFrameworkProjectInput#
ComplianceFrameworkProjectInput arguments#
| Name | Type | Description |
|---|---|---|
addProjects |
[Int!]! |
IDs of the projects to add to the compliance framework. |
removeProjects |
[Int!]! |
IDs of the projects to remove from the compliance framework. |
ComplianceRequirementInput#
ComplianceRequirementInput arguments#
| Name | Type | Description |
|---|---|---|
complianceRequirementsControls |
[ComplianceRequirementsControlInput!] |
Compliance controls of the compliance requirement. |
description |
String |
New description for the compliance requirement. |
name |
String |
New name for the compliance requirement. |
ComplianceRequirementsControlInput#
ComplianceRequirementsControlInput arguments#
| Name | Type | Description |
|---|---|---|
controlType |
String |
Type of the compliance control. |
expression |
String |
Expression of the compliance control. Derived from the name of the control when omitted for an internal control. |
externalControlName |
String |
Name of the external control. |
externalUrl |
String |
URL of the external control. |
name |
String! |
New name for the compliance requirement control. |
pingEnabled |
Boolean |
Whether ping is enabled for external controls. |
secretToken |
String |
Secret token for an external control. |
ComplianceStandardsAdherenceInput#
ComplianceStandardsAdherenceInput arguments#
| Name | Type | Description |
|---|---|---|
checkName |
ComplianceStandardsAdherenceCheckName |
Name of the check for the compliance standard. |
projectIds |
[ProjectID!] |
Filter compliance standards adherence by project. |
standard |
ComplianceStandardsAdherenceStandard |
Name of the compliance standard. |
ComplianceStandardsProjectAdherenceInput#
ComplianceStandardsProjectAdherenceInput arguments#
| Name | Type | Description |
|---|---|---|
checkName |
ComplianceStandardsAdherenceCheckName |
Name of the check for the compliance standard. |
standard |
ComplianceStandardsAdherenceStandard |
Name of the compliance standard. |
ComplianceViolationInput#
ComplianceViolationInput arguments#
| Name | Type | Description |
|---|---|---|
mergedAfter |
Date |
Merge requests merged after the date (inclusive). |
mergedBefore |
Date |
Merge requests merged before the date (inclusive). |
projectIds |
[ProjectID!] |
Filter compliance violations by project. |
targetBranch |
String |
Filter compliance violations by target branch. |
ComplianceViolationProjectInput#
ComplianceViolationProjectInput arguments#
| Name | Type | Description |
|---|---|---|
mergedAfter |
Date |
Merge requests merged after the date (inclusive). |
mergedBefore |
Date |
Merge requests merged before the date (inclusive). |
targetBranch |
String |
Filter compliance violations by target branch. |
CreateValueStreamStageInput#
Attributes to create value stream stage.
CreateValueStreamStageInput arguments#
| Name | Type | Description | Default |
|---|---|---|---|
custom |
Boolean |
Whether the stage is customized. If false, it assigns a built-in default stage by name. | true |
endEventIdentifier |
ValueStreamStageEvent |
End event identifier. | |
endEventLabelId |
LabelID |
Label ID associated with the end event identifier. | |
hidden |
Boolean |
Whether the stage is hidden. | |
name |
String! |
Name of the stage. | |
startEventIdentifier |
ValueStreamStageEvent |
Start event identifier. | |
startEventLabelId |
LabelID |
Label ID associated with the start event identifier. |
CustomFieldSelectOptionInput#
Attributes for the custom field select option.
CustomFieldSelectOptionInput arguments#
| Name | Type | Description |
|---|---|---|
id |
IssuablesCustomFieldSelectOptionID |
Global ID of the custom field select option to update. Creates a new record if not provided. |
value |
String! |
Value of the custom field select option. |
DastProfileCadenceInput#
Represents DAST Profile Cadence.
DastProfileCadenceInput arguments#
| Name | Type | Description |
|---|---|---|
duration |
Int |
Duration of the DAST Profile Cadence. |
unit |
DastProfileCadenceUnit |
Unit for the duration of DAST Profile Cadence. |
DastProfileScheduleInput#
Input type for DAST Profile Schedules.
DastProfileScheduleInput arguments#
| Name | Type | Description |
|---|---|---|
active |
Boolean |
Status of a Dast Profile Schedule. |
cadence |
DastProfileCadenceInput |
Cadence of a Dast Profile Schedule. |
startsAt |
Time |
Start time of a Dast Profile Schedule. |
timezone |
String |
Time Zone for the Start time of a Dast Profile Schedule. |
DastSiteProfileAuthInput#
Input type for DastSiteProfile authentication.
DastSiteProfileAuthInput arguments#
| Name | Type | Description |
|---|---|---|
enabled |
Boolean |
Indicates whether authentication is enabled. |
password |
String |
Password to authenticate with on the target. |
passwordField |
String |
Name of password field at the sign-in HTML form. |
submitField |
String |
Name or ID of sign-in submit button at the sign-in HTML form. |
url |
String |
The URL of the page containing the sign-in HTML form on the target website. |
username |
String |
Username to authenticate with on the target. |
usernameField |
String |
Name of username field at the sign-in HTML form. |
DeploymentsOrderByInput#
Values for ordering deployments by a specific field.
DeploymentsOrderByInput arguments#
| Name | Type | Description |
|---|---|---|
createdAt |
SortDirectionEnum |
Order by Created time. |
finishedAt |
SortDirectionEnum |
Order by Finished time. |
DiffImagePositionInput#
DiffImagePositionInput arguments#
| Name | Type | Description |
|---|---|---|
baseSha |
String |
Merge base of the branch the comment was made on. |
headSha |
String! |
SHA of the HEAD at the time the comment was made. |
height |
Int! |
Total height of the image. |
paths |
DiffPathsInput! |
The paths of the file that was changed. Both of the properties of this input are optional, but at least one of them is required. |
startSha |
String! |
SHA of the branch being compared against. |
width |
Int! |
Total width of the image. |
x |
Int! |
X position of the note. |
y |
Int! |
Y position of the note. |
DiffPathsInput#
DiffPathsInput arguments#
| Name | Type | Description |
|---|---|---|
newPath |
String |
Path of the file on the HEAD SHA. |
oldPath |
String |
Path of the file on the start SHA. |
DiffPositionInput#
DiffPositionInput arguments#
| Name | Type | Description |
|---|---|---|
baseSha |
String |
Merge base of the branch the comment was made on. |
headSha |
String! |
SHA of the HEAD at the time the comment was made. |
newLine |
Int |
Line on HEAD SHA that was changed. Please see the REST API Documentation for more information on how to use this field. |
oldLine |
Int |
Line on start SHA that was changed. Please see the REST API Documentation for more information on how to use this field. |
paths |
DiffPathsInput! |
The paths of the file that was changed. Both of the properties of this input are optional, but at least one of them is required. |
startSha |
String! |
SHA of the branch being compared against. |
DoraProjectFilterInput#
Filter parameters for projects to be aggregated for DORA metrics.
DoraProjectFilterInput arguments#
| Name | Type | Description |
|---|---|---|
topic |
[String!] |
Filter projects by topic. |
DuoContextExclusionSettingsInput#
Input for Duo context exclusion settings.
DuoContextExclusionSettingsInput arguments#
| Name | Type | Description |
|---|---|---|
exclusionRules |
[String!]! |
List of rules for excluding files from Duo context. |
DuoWorkflowSessionArtifactNegatedFilterInput#
Negated filter arguments for Duo Agent Platform session artifacts.
DuoWorkflowSessionArtifactNegatedFilterInput arguments#
| Name | Type | Description |
|---|---|---|
projectPath |
String |
Exclude session artifacts belonging to the project full path. |
triggeredByUserId |
UserID |
Exclude session artifacts triggered by the user with the given global ID. |
workflowDefinition |
String |
Exclude session artifacts with the workflow definition. |
EpicFilters#
EpicFilters arguments#
| Name | Type | Description |
|---|---|---|
authorUsername |
String |
Filter by author username. |
confidential |
Boolean |
Filter by confidentiality. |
customField |
[WorkItemWidgetCustomFieldFilterInputType!] |
Introduced as an experiment in GitLab 17.10. Filter by custom fields. |
labelName |
[String] |
Filter by label name. |
myReactionEmoji |
String |
Filter by reaction emoji applied by the current user. Wildcard values "NONE" and "ANY" are supported. |
not |
NegatedEpicBoardIssueInput |
Negated epic arguments. |
or |
UnionedEpicFilterInput |
List of arguments with inclusive OR. |
search |
String |
Search query for epic title or description. |
EpicTreeNodeFieldsInputType#
A node of an epic tree.
EpicTreeNodeFieldsInputType arguments#
| Name | Type | Description |
|---|---|---|
adjacentReferenceId |
EpicTreeSortingID |
ID of the epic issue or issue the epic or issue is switched with. |
id |
EpicTreeSortingID! |
ID of the epic issue or epic that is being moved. |
newParentId |
EpicID |
ID of the new parent epic. |
relativePosition |
MoveType |
Type of switch. Valid values are after or before. |
EscalationRuleInput#
Represents an escalation rule.
EscalationRuleInput arguments#
| Name | Type | Description |
|---|---|---|
elapsedTimeSeconds |
Int! |
Time in seconds before the rule is activated. |
oncallScheduleIid |
ID |
On-call schedule to notify. |
status |
EscalationRuleStatus! |
Status required to prevent the rule from activating. |
username |
String |
Username of the user to notify. |
FindingDueDatesSetInput#
FindingDueDatesSetInput arguments#
| Name | Type | Description |
|---|---|---|
dueDate |
Date |
Due date for the finding. Pass null to remove. |
findingUuid |
String! |
UUID of the vulnerability finding. |
GoogleCloudNodePool#
Attributes for defining Node Pool in GKE.
GoogleCloudNodePool arguments#
| Name | Type | Description | Default |
|---|---|---|---|
imageType |
GoogleCloudImage! |
Image to use on the pool. | |
labels |
[GoogleCloudNodePoolLabel!] |
Labels for the node pool of the runner. | [] |
machineType |
GoogleCloudMachineType! |
Machine type to use. | |
name |
String! |
Name of the node pool. | |
nodeCount |
Int! |
Node count of the pool. |
GoogleCloudNodePoolLabel#
Labels for the Node Pool of a GKE cluster.
GoogleCloudNodePoolLabel arguments#
GranularScopeInput#
Attributes for a granular scope of an access token.
GranularScopeInput arguments#
| Name | Type | Description |
|---|---|---|
access |
AccessTokenGranularScopeAccess! |
Access to configure for the granular scope. |
permissions |
[String!]! |
List of permissions for the granular scope. |
resourceIds |
[GlobalID!] |
IDs of groups or projects to associate with each granular scope. |
GroupProjectRequirementComplianceStatusInput#
GroupProjectRequirementComplianceStatusInput arguments#
| Name | Type | Description |
|---|---|---|
frameworkId |
ComplianceManagementFrameworkID |
Filter compliance requirement statuses by compliance framework. |
projectId |
ProjectID |
Filter compliance requirement statuses by project. |
requirementId |
ComplianceManagementComplianceFrameworkComplianceRequirementID |
Filter compliance requirement statuses by compliance requirement. |
HierarchyFilterInput#
HierarchyFilterInput arguments#
| Name | Type | Description |
|---|---|---|
includeDescendantWorkItems |
Boolean |
Whether to include work items of descendant parents when filtering by parent_ids. |
parentIds |
[WorkItemID!] |
Filter work items by global IDs of their parent items (maximum is 100 items). |
parentWildcardId |
WorkItemParentWildcardId |
Introduced as an experiment in GitLab 18.3. Filter by parent ID wildcard. Incompatible with parentIds. |
ItemConsumerTargetInput#
ItemConsumerTargetInput arguments#
| Name | Type | Description |
|---|---|---|
groupId |
GroupID |
Group in which to configure the item. |
projectId |
ProjectID |
Project in which to configure the item. |
JiraUsersMappingInputType#
JiraUsersMappingInputType arguments#
| Name | Type | Description |
|---|---|---|
gitlabId |
Int |
ID of the GitLab user. |
jiraAccountId |
String! |
Jira account ID of the user. |
MergeAccessLevelInput#
Defines which user roles, users, or groups can merge into a protected branch.
MergeAccessLevelInput arguments#
| Name | Type | Description |
|---|---|---|
accessLevel |
Int |
Access level allowed to perform action. |
groupId |
GroupID |
Group associated with the access level. |
memberRoleId |
MemberRoleID |
Custom member role associated with the access level. |
userId |
UserID |
User associated with the access level. |
MergeRequestConflictFileResolutionInput#
Resolution of one file with conflicts: either a side for each conflict, or the resolved content.
MergeRequestConflictFileResolutionInput arguments#
| Name | Type | Description |
|---|---|---|
content |
String |
Full resolved content of the file. |
ourPath |
String! |
Path of the file on the source branch, as ourPath in MergeRequest.conflictFiles returns it. |
sections |
[MergeRequestConflictSectionResolutionInput!] |
Side to keep for every conflict in the file. Maximum is 1000 sections. |
theirPath |
String! |
Path of the file on the target branch, as theirPath in MergeRequest.conflictFiles returns it. |
MergeRequestConflictSectionResolutionInput#
Side to keep for one conflict in a file.
MergeRequestConflictSectionResolutionInput arguments#
| Name | Type | Description |
|---|---|---|
resolution |
MergeRequestConflictSide! |
Side of the conflict to keep. |
sectionId |
String! |
ID of the section, as sectionId in MergeRequest.conflictFiles returns it. |
MergeRequestSavedViewFilterInput#
Merge request filter values that can be stored in a saved view.
MergeRequestSavedViewFilterInput arguments#
| Name | Type | Description |
|---|---|---|
approvedBy |
[String!] |
Usernames of the approvers. |
assigneeUsernames |
[String!] |
Usernames of users assigned to the merge request. |
authorUsername |
String |
Username of the author. |
draft |
Boolean |
Limit results to draft merge requests. |
labelName |
[String!] |
Labels applied to the merge request. |
mergedAfter |
Time |
Merge requests merged after the timestamp. |
mergedBefore |
Time |
Merge requests merged before the timestamp. |
milestoneTitle |
String |
Title of the milestone. |
not |
MergeRequestSavedViewNegatedFilterInput |
Filter values to exclude. |
reviewerUsername |
String |
Username of the reviewer. |
sort |
MergeRequestSort |
Sort order for the merge requests. |
sourceBranches |
[String!] |
Source branch names. |
state |
MergeRequestState |
Merge request state. |
targetBranches |
[String!] |
Target branch names. |
MergeRequestSavedViewNegatedFilterInput#
Merge request filter values to exclude in a saved view.
MergeRequestSavedViewNegatedFilterInput arguments#
| Name | Type | Description |
|---|---|---|
approvedBy |
[String!] |
Usernames of approvers to exclude. |
assigneeUsernames |
[String!] |
Usernames of assignees to exclude. |
authorUsername |
String |
Username of the author to exclude. |
labelName |
[String!] |
Labels to exclude. |
milestoneTitle |
String |
Title of the milestone to exclude. |
reviewerUsername |
String |
Username of the reviewer to exclude. |
sourceBranches |
[String!] |
Source branch names to exclude. |
targetBranches |
[String!] |
Target branch names to exclude. |
MergeRequestsResolverNegatedParams#
MergeRequestsResolverNegatedParams arguments#
| Name | Type | Description |
|---|---|---|
approvedBy |
[String!] |
Filters merge requests to exclude any that are approved by usernames in the given array. |
assigneeUsernames |
[String!] |
Filters merge requests to exclude any that are assigned to the usernames in the given array. |
authorUsername |
String |
Filters merge requests to exclude any that are authored by the given user. |
labelName |
[String!] |
Filters merge requests to exclude any that have the labels provided in the given array. |
labels |
[String!] |
Deprecated in GitLab 17.7. Use labelName. |
milestoneTitle |
String |
Filters merge requests to those not in the given milestone. |
myReactionEmoji |
String |
Filters merge requests to those without the given reaction from the authenticated user. |
onlyReviewer |
Boolean |
Introduced as an experiment in GitLab 17.11. Filters out merge requests to those that do not have the reviewer as the only assigned reviewer. |
releaseTag |
String |
Filters merge requests to those without the given release tag. |
reviewStates |
[MergeRequestReviewState!] |
Introduced as an experiment in GitLab 17.9. Filters merge requests to those where a reviewer does not have the provided state. |
reviewerUsername |
String |
Filters merge requests to those not reviewed by the given user. |
sourceBranches |
[String!] |
Filters merge requests to exclude the source branch names provided in the given array. |
targetBranches |
[String!] |
Filters merge requests to exclude the target branch names provided in the given array. |
NegatedBoardIssueInput#
NegatedBoardIssueInput arguments#
| Name | Type | Description |
|---|---|---|
assigneeUsername |
[String] |
Filter by assignee username. |
authorUsername |
String |
Filter by author username. |
authorUsernames |
[String!] |
Filter by author usernames (maximum is 100 usernames). |
customField |
[WorkItemWidgetCustomFieldFilterInputType!] |
Introduced as an experiment in GitLab 18.4. Filter by negated custom fields. |
epicId |
EpicID |
Deprecated in GitLab 17.5. This will be replaced by WorkItem hierarchyWidget. |
healthStatusFilter |
HealthStatus |
Health status not applied to the issue. Includes issues where health status is not set. |
iids |
[String!] |
List of IIDs of issues. For example ["1", "2"]. |
iterationId |
[IterationID!] |
Filter by a list of iteration IDs. Incompatible with iterationWildcardId. |
iterationTitle |
String |
Filter by iteration title. |
iterationWildcardId |
NegatedIterationWildcardId |
Filter by iteration ID wildcard. |
labelName |
[String] |
Filter by label name. |
milestoneTitle |
String |
Filter by milestone title. |
milestoneWildcardId |
MilestoneWildcardId |
Filter by milestone ID wildcard. |
myReactionEmoji |
String |
Filter by reaction emoji applied by the current user. Wildcard values "NONE" and "ANY" are supported. |
releaseTag |
String |
Filter by release tag. |
types |
[IssueType!] |
Filter by the given issue types. |
weight |
String |
Filter by weight. |
workItemTypeIds |
[WorkItemsTypeID!] |
Filter by work item type global IDs. |
NegatedComplianceFrameworkFilters#
NegatedComplianceFrameworkFilters arguments#
| Name | Type | Description |
|---|---|---|
id |
ComplianceManagementFrameworkID |
ID of the compliance framework. |
ids |
[ComplianceManagementFrameworkID!] |
IDs of the compliance framework. |
NegatedEpicBoardIssueInput#
NegatedEpicBoardIssueInput arguments#
| Name | Type | Description |
|---|---|---|
authorUsername |
String |
Filter by author username. |
authorUsernames |
[String!] |
Filter by author usernames (maximum is 100 usernames). |
customField |
[WorkItemWidgetCustomFieldFilterInputType!] |
Introduced as an experiment in GitLab 18.4. Filter by negated custom fields. |
labelName |
[String] |
Filter by label name. |
myReactionEmoji |
String |
Filter by reaction emoji applied by the current user. Wildcard values "NONE" and "ANY" are supported. |
NegatedEpicFilterInput#
NegatedEpicFilterInput arguments#
| Name | Type | Description |
|---|---|---|
authorUsername |
String |
Filter by author username. |
customField |
[WorkItemWidgetCustomFieldFilterInputType!] |
Introduced as an experiment in GitLab 18.4. Filter by negated custom fields. |
labelName |
[String] |
Filter by label name. |
myReactionEmoji |
String |
Filter by reaction emoji applied by the current user. |
NegatedIssueFilterInput#
NegatedIssueFilterInput arguments#
| Name | Type | Description |
|---|---|---|
assigneeId |
String |
ID of a user not assigned to the issues. |
assigneeUsernames |
[String!] |
Usernames of users not assigned to the issue. |
authorUsername |
[String!] |
Username of a user who didn't author the issue. |
customField |
[WorkItemWidgetCustomFieldFilterInputType!] |
Introduced as an experiment in GitLab 18.4. Filter by negated custom fields. |
epicId |
String |
ID of an epic not associated with the issues. |
healthStatusFilter |
[HealthStatus!] |
Health status not applied to the issue. Includes issues where health status is not set. |
iids |
[String!] |
List of IIDs of issues to exclude. For example, [1, 2]. |
iterationId |
[ID!] |
List of iteration Global IDs not applied to the issue. |
iterationWildcardId |
IterationWildcardId |
Filter by negated iteration ID wildcard. |
labelName |
[String!] |
Labels not applied to the issue. |
milestoneTitle |
[String!] |
Milestone not applied to the issue. |
milestoneWildcardId |
NegatedMilestoneWildcardId |
Filter by negated milestone wildcard values. |
myReactionEmoji |
String |
Filter by reaction emoji applied by the current user. |
releaseTag |
[String!] |
Release tag not associated with the issue's milestone. Ignored when parent is a group. |
types |
[IssueType!] |
Filters out issues by the given issue types. |
weight |
String |
Weight not applied to the issue. |
NegatedValueStreamAnalyticsIssuableFilterInput#
NegatedValueStreamAnalyticsIssuableFilterInput arguments#
| Name | Type | Description |
|---|---|---|
assigneeUsernames |
[String!] |
Usernames of users not assigned to the issue or merge request. |
authorUsername |
String |
Username of a user who didn't author the issue or merge request. |
epicId |
ID |
ID of an epic not associated with the issues. Using the filter is not supported for stages based on merge requests. |
iterationId |
ID |
List of iteration Global IDs not applied to the issue. Using the filter is not supported for stages based on merge requests. |
labelNames |
[String!] |
Labels not applied to the issue or merge request. |
milestoneTitle |
String |
Milestone not applied to the issue or merge request. |
myReactionEmoji |
String |
Filter by reaction emoji applied by the current user. |
weight |
Int |
Weight not applied to the issue. Using the filter is not supported for stages based on merge requests. |
NegatedWorkItemFilterInput#
NegatedWorkItemFilterInput arguments#
| Name | Type | Description |
|---|---|---|
assigneeUsernames |
[String!] |
Usernames of users not assigned to the work item (maximum is 100 usernames). |
authorUsername |
[String!] |
Username of a user who didn't author the work item (maximum is 100 usernames). |
customField |
[WorkItemWidgetCustomFieldFilterInputType!] |
Introduced as an experiment in GitLab 18.4. Filter by negated custom fields. |
healthStatusFilter |
[HealthStatus!] |
Health status not applied to the work items. Includes work items where health status is not set. |
iterationId |
[ID!] |
List of iteration Global IDs not applied to the work items (maximum is 100 IDs). |
iterationWildcardId |
IterationWildcardId |
Filter by negated iteration ID wildcard. |
labelName |
[String!] |
Labels not applied to the work item (maximum is 100 labels). |
milestoneTitle |
[String!] |
Milestone not applied to the work item (maximum is 100 milestones). |
milestoneWildcardId |
NegatedMilestoneWildcardId |
Filter by negated milestone wildcard values. |
myReactionEmoji |
String |
Filter by reaction emoji not applied by the current user. |
parentIds |
[WorkItemID!] |
Introduced as an experiment in GitLab 18.3. Filter work items by global IDs who don't belong to parent items (maximum is 100 IDs). |
releaseTag |
[String!] |
Release tag not associated with the work items's milestone (maximum is 100 tags). Ignored when parent is a group . |
types |
[IssueType!] |
Filter out work items by the given types. |
weight |
String |
Weight not applied to the work items. |
workItemTypeIds |
[WorkItemsTypeID!] |
Filter out work items by work item type global IDs. |
OncallRotationActivePeriodInputType#
Active period time range for on-call rotation.
OncallRotationActivePeriodInputType arguments#
| Name | Type | Description |
|---|---|---|
endTime |
String! |
End of the rotation active period in 24 hour format. For example, "18:30". |
startTime |
String! |
Start of the rotation active period in 24 hour format. For example, "18:30". |
OncallRotationDateInputType#
Date input type for on-call rotation.
OncallRotationDateInputType arguments#
| Name | Type | Description |
|---|---|---|
date |
String! |
Date component of the date in YYYY-MM-DD format. |
time |
String! |
Time component of the date in 24hr HH:MM format. |
OncallRotationLengthInputType#
The rotation length of the on-call rotation.
OncallRotationLengthInputType arguments#
| Name | Type | Description |
|---|---|---|
length |
Int! |
Rotation length of the on-call rotation. |
unit |
OncallRotationUnitEnum! |
Unit of the rotation length of the on-call rotation. |
OncallUserInputType#
The rotation user and color palette.
OncallUserInputType arguments#
| Name | Type | Description |
|---|---|---|
colorPalette |
DataVisualizationColorEnum |
Value of DataVisualizationColorEnum. The color from the palette to assign to the on-call user. |
colorWeight |
DataVisualizationWeightEnum |
Color weight to assign to for the on-call user. To view on-call schedules in GitLab, do not provide a value below 500. A value between 500 and 950 ensures sufficient contrast. |
username |
String! |
Username of the user to participate in the on-call rotation. For example, "user_one". |
PipelineScheduleVariableInput#
Attributes for the pipeline schedule variable.
PipelineScheduleVariableInput arguments#
| Name | Type | Description |
|---|---|---|
destroy |
Boolean |
Boolean option to destroy the variable. |
id |
CiPipelineScheduleVariableID |
ID of the variable to mutate. |
key |
String! |
Name of the variable. |
value |
String! |
Value of the variable. |
variableType |
CiVariableType! |
Type of the variable. |
PrincipalInput#
Representation of who is provided access to. For eg: User/Role/MemberRole.
PrincipalInput arguments#
| Name | Type | Description |
|---|---|---|
id |
Int! |
ID of the principal. |
type |
PrincipalType! |
Type of the principal. |
ProjectComplianceControlStatusInput#
ProjectComplianceControlStatusInput arguments#
| Name | Type | Description |
|---|---|---|
complianceRequirementId |
ComplianceManagementComplianceFrameworkComplianceRequirementID |
Compliance requirement id of the statuses. |
ProjectComplianceViolationFilterInput#
Filters for project compliance violations.
ProjectComplianceViolationFilterInput arguments#
| Name | Type | Description |
|---|---|---|
controlId |
ComplianceManagementComplianceFrameworkComplianceRequirementsControlID |
Control ID for which to filter compliance violations. |
createdAfter |
Date |
Compliance violations created on or after the date (inclusive). |
createdBefore |
Date |
Compliance violations created on or before the date (inclusive). |
projectId |
ProjectID |
Project ID for which to filter compliance violations. |
status |
[ComplianceViolationStatus!] |
Status of the project compliance violation. |
ProjectRequirementComplianceStatusInput#
ProjectRequirementComplianceStatusInput arguments#
| Name | Type | Description |
|---|---|---|
frameworkId |
ComplianceManagementFrameworkID |
Filter compliance requirement statuses by compliance framework. |
requirementId |
ComplianceManagementComplianceFrameworkComplianceRequirementID |
Filter compliance requirement statuses by compliance requirement. |
ProjectTrackedContextInput#
Input for specifying a project tracked context.
ProjectTrackedContextInput arguments#
| Name | Type | Description |
|---|---|---|
name |
String! |
Name of the tracked context. |
type |
ProjectTrackedContext! |
Type of the tracked context. |
PushAccessLevelInput#
Defines which user roles, users, deploy keys, or groups can push to a protected branch.
PushAccessLevelInput arguments#
| Name | Type | Description |
|---|---|---|
accessLevel |
Int |
Access level allowed to perform action. |
deployKeyId |
DeployKeyID |
Deploy key assigned to the access level. |
groupId |
GroupID |
Group associated with the access level. |
memberRoleId |
MemberRoleID |
Custom member role associated with the access level. |
userId |
UserID |
User associated with the access level. |
ReleaseAssetLinkInput#
Fields that are available when modifying a release asset link.
ReleaseAssetLinkInput arguments#
| Name | Type | Description | Default |
|---|---|---|---|
directAssetPath |
String |
Relative path for a direct asset link. | |
linkType |
ReleaseAssetLinkType |
Type of the asset link. | OTHER |
name |
String! |
Name of the asset link. | |
url |
String! |
URL of the asset link. |
ReleaseAssetsInput#
Fields that are available when modifying release assets.
ReleaseAssetsInput arguments#
| Name | Type | Description |
|---|---|---|
links |
[ReleaseAssetLinkInput!] |
List of asset links to associate to the release. |
RequirementLegacyFilterInput#
RequirementLegacyFilterInput arguments#
| Name | Type | Description |
|---|---|---|
legacyIids |
[String!]! |
List of legacy requirement IIDs of work items. or example ["1", "2"]. |
SastCiConfigurationAnalyzersEntityInput#
Represents the analyzers entity in SAST CI configuration.
SastCiConfigurationAnalyzersEntityInput arguments#
| Name | Type | Description |
|---|---|---|
enabled |
Boolean! |
State of the analyzer. |
name |
String! |
Name of analyzer. |
variables |
[SastCiConfigurationEntityInput!] |
List of variables for the analyzer. |
SastCiConfigurationEntityInput#
Represents an entity in SAST CI configuration.
SastCiConfigurationEntityInput arguments#
| Name | Type | Description |
|---|---|---|
defaultValue |
String! |
Default value that is used if value is empty. |
field |
String! |
CI keyword of entity. |
value |
String! |
Current value of the entity. |
SastCiConfigurationInput#
Represents a CI configuration of SAST.
SastCiConfigurationInput arguments#
| Name | Type | Description |
|---|---|---|
analyzers |
[SastCiConfigurationAnalyzersEntityInput!] |
List of analyzers and related variables for the SAST configuration. |
global |
[SastCiConfigurationEntityInput!] |
List of global entities related to SAST configuration. |
pipeline |
[SastCiConfigurationEntityInput!] |
List of pipeline entities related to SAST configuration. |
SecurityAttributeInput#
Input type for security attribute.
SecurityAttributeInput arguments#
| Name | Type | Description |
|---|---|---|
color |
Color! |
Color of the security attribute. |
description |
String! |
Description of the security attribute. |
name |
String! |
Name of the security attribute. |
SecurityRefInput#
SecurityRefInput arguments#
| Name | Type | Description |
|---|---|---|
name |
String! |
Name of the ref. |
refType |
SecurityTrackedRefType! |
Type of ref (branch or tag). |
SecurityScanProfileAutoRemediationInput#
Auto-remediation configuration for a dependency scanning post-processing scan profile.
SecurityScanProfileAutoRemediationInput arguments#
| Name | Type | Description |
|---|---|---|
batchUpdates |
Boolean |
Introduced as an experiment in GitLab 19.7. Whether to batch updates into one merge request per lockfile. |
cooldown |
Int |
Introduced as an experiment in GitLab 19.3. Minimum number of days after a package is released before it can be used. |
enabled |
Boolean |
Introduced as an experiment in GitLab 19.3. Whether auto-remediation is enabled. |
maxUpdatesPerBatch |
Int |
Introduced as an experiment in GitLab 19.7. Maximum number of dependency updates in one batch merge request. Further updates wait for the next run. |
openMergeRequestsLimit |
Int |
Introduced as an experiment in GitLab 19.3. Maximum number of open auto-remediation merge requests at once. |
runnerTags |
[String!] |
Introduced as an experiment in GitLab 19.6. Runner tags applied to the auto-remediation job. |
severityLevel |
VulnerabilitySeverity |
Introduced as an experiment in GitLab 19.3. Minimum vulnerability severity that triggers an automated upgrade. Findings below this threshold are skipped. |
upgradePolicy |
SecurityScanProfileUpgradePolicy |
Introduced as an experiment in GitLab 19.3. Highest version bump allowed when remediating. |
SecurityScanProfileConfigurationInput#
Typed configuration for a scan profile trigger. Exactly one member may be set, and it must match the scan profile type.
SecurityScanProfileConfigurationInput arguments#
| Name | Type | Description |
|---|---|---|
dependencyScanning |
SecurityScanProfileDependencyScanningConfigurationInput |
Introduced as an experiment in GitLab 19.5. Configuration for a dependency scanning scan profile. |
dependencyScanningPostProcessing |
SecurityScanProfileDependencyScanningPostProcessingConfigurationInput |
Introduced as an experiment in GitLab 19.3. Configuration for a dependency scanning post-processing scan profile. |
sast |
SecurityScanProfileSastConfigurationInput |
Introduced as an experiment in GitLab 19.4. Configuration for a SAST scan profile. |
secretDetection |
SecurityScanProfileSecretDetectionConfigurationInput |
Introduced as an experiment in GitLab 19.3. Configuration for a secret detection scan profile. |
triageAndRemediation |
SecurityScanProfileTriageAndRemediationConfigurationInput |
Introduced as an experiment in GitLab 19.4. Configuration for a triage and remediation scan profile. |
SecurityScanProfileDependencyScanningConfigurationInput#
Configuration for a dependency scanning scan profile.
SecurityScanProfileDependencyScanningConfigurationInput arguments#
| Name | Type | Description |
|---|---|---|
additionalCaCertBundle |
String |
Introduced as an experiment in GitLab 19.5. CA certificate bundle to trust. The bundle is added to the system's certificates and used by other tools during the scan. |
analyzerImageVersion |
String |
Introduced as an experiment in GitLab 19.6. Version tag of the dependency scanning analyzer image. |
apiScanDownloadDelay |
Int |
Introduced as an experiment in GitLab 19.5. Vulnerability scanning API initial delay in seconds before downloading scan results, from 1 to 120. |
apiTimeout |
Int |
Introduced as an experiment in GitLab 19.5. Vulnerability scanning API request timeout in seconds, from 5 to 300. |
disabledResolutionJobs |
[SecurityScanProfileDependencyResolutionJob!] |
Introduced as an experiment in GitLab 19.5. Resolution jobs to disable. By default, all available resolution jobs are enabled. |
enableManifestFallback |
Boolean |
Introduced as an experiment in GitLab 19.5. Enable manifest fallback for dependency scanning. |
enableVulnerabilityScan |
Boolean |
Introduced as an experiment in GitLab 19.5. Enable the vulnerability analysis of generated SBOMs. |
excludedPaths |
[String!] |
Introduced as an experiment in GitLab 19.5. Glob paths excluded from the scan. |
gradleCliOpts |
String |
Introduced as an experiment in GitLab 19.5. Additional command-line options passed to Gradle during dependency resolution. |
gradleResolutionImage |
String |
Introduced as an experiment in GitLab 19.5. Image used by the Gradle dependency resolution job. |
includeDevDependencies |
Boolean |
Introduced as an experiment in GitLab 19.5. Include development and test dependencies when scanning a supported file. |
mavenArgs |
String |
Introduced as an experiment in GitLab 19.5. Additional arguments passed to Maven during dependency resolution. |
mavenDependencyPluginVersion |
String |
Introduced as an experiment in GitLab 19.5. Version of maven-dependency-plugin used during resolution. |
mavenResolutionImage |
String |
Introduced as an experiment in GitLab 19.5. Image used by the Maven dependency resolution job. |
maxDepth |
Int |
Introduced as an experiment in GitLab 19.5. Specifies the directory depth the analyzer should scan. A value of -1 scans all directories. |
pipDependencyPath |
String |
Introduced as an experiment in GitLab 19.5. Path to install Python packages for analysis. |
pipExtraIndexUrl |
[String!] |
Introduced as an experiment in GitLab 19.5. Additional URLs of Python package indexes to use in addition to pipIndexUrl. |
pipIndexUrl |
String |
Introduced as an experiment in GitLab 19.5. Base URL of the Python Package Index. |
pipManifestFileNamePattern |
String |
Introduced as an experiment in GitLab 19.5. Custom pip manifest file name pattern to use for dependency resolution and manifest scanning. The pattern matches file names only, not directory paths. |
pipcompileLockfileFileNamePattern |
String |
Introduced as an experiment in GitLab 19.5. Custom pipcompile lockfile file name pattern to use when analyzing. The pattern matches file names only, not directory paths. |
pythonResolutionImage |
String |
Introduced as an experiment in GitLab 19.5. Image used by the Python dependency resolution job. |
searchIgnoreHiddenDirs |
Boolean |
Introduced as an experiment in GitLab 19.5. Ignore hidden directories when searching for supported files. |
secureAnalyzersPrefix |
String |
Introduced as an experiment in GitLab 19.5. Prefix for the container registry from which the analyzer image is pulled. |
secureLogLevel |
SecurityScanProfileSecureLogLevel |
Introduced as an experiment in GitLab 19.5. Logging level used by the analyzer. |
staticReachabilityEnabled |
Boolean |
Introduced as an experiment in GitLab 19.5. Enable static reachability. |
SecurityScanProfileDependencyScanningPostProcessingConfigurationInput#
Configuration for a dependency scanning post-processing scan profile.
SecurityScanProfileDependencyScanningPostProcessingConfigurationInput arguments#
| Name | Type | Description |
|---|---|---|
autoRemediation |
SecurityScanProfileAutoRemediationInput |
Introduced as an experiment in GitLab 19.3. Auto-remediation configuration. |
SecurityScanProfileSastConfigurationInput#
Configuration for a SAST scan profile.
SecurityScanProfileSastConfigurationInput arguments#
| Name | Type | Description |
|---|---|---|
advancedSastPartialScan |
SecurityScanProfileAdvancedSastPartialScan |
Introduced as an experiment in GitLab 19.4. Controls GitLab Advanced SAST diff-based scanning. Use 'differential' to enable, 'false' to disable. |
analyzerImageTag |
String |
Introduced as an experiment in GitLab 19.4. Tag of the analyzer image to use. Warning: Setting this value overrides the pinned image tag for all SAST analyzers, which can cause analyzer failures if they require specific versions. |
excludedAnalyzers |
[String!] |
Introduced as an experiment in GitLab 19.4. Analyzers excluded from the scan. |
excludedPaths |
[String!] |
Introduced as an experiment in GitLab 19.4. Glob paths excluded from the scan. |
gitlabAdvSastIncrScan |
Boolean |
Introduced as an experiment in GitLab 19.4. Whether GitLab Advanced SAST incremental scanning is enabled. |
imageSuffix |
SecurityScanProfileImageSuffix |
Introduced as an experiment in GitLab 19.4. Suffix appended to the analyzer image name. |
secureAnalyzersPrefix |
String |
Introduced as an experiment in GitLab 19.4. Prefix for the container registry from which the analyzer image is pulled. |
SecurityScanProfileSastFalsePositiveInput#
Configuration for the SAST false positive detection trigger of a triage and remediation scan profile.
SecurityScanProfileSastFalsePositiveInput arguments#
| Name | Type | Description |
|---|---|---|
cweClasses |
[CweIdentifier!] |
Introduced as an experiment in GitLab 19.4. CWE identifiers to restrict false positive detection to. |
runMode |
SecurityScanProfileRunMode |
Introduced as an experiment in GitLab 19.4. Whether false positive detection runs automatically or only when triggered by a user. |
severityLevel |
VulnerabilitySeverity |
Introduced as an experiment in GitLab 19.4. Minimum vulnerability severity that triggers false positive detection. Findings below this threshold are skipped. |
SecurityScanProfileSastVulnerabilityResolutionInput#
Configuration for the SAST vulnerability resolution trigger of a triage and remediation scan profile.
SecurityScanProfileSastVulnerabilityResolutionInput arguments#
| Name | Type | Description |
|---|---|---|
cweClasses |
[CweIdentifier!] |
Introduced as an experiment in GitLab 19.4. CWE identifiers to restrict resolution to. |
falsePositiveConfidence |
SecurityScanProfileFalsePositiveConfidence |
Introduced as an experiment in GitLab 19.4. Restricts resolution to findings carrying the given false positive assessment. |
openMergeRequestsLimit |
Int |
Introduced as an experiment in GitLab 19.4. Maximum number of open merge requests resolution may have at once, from 0 to 100. Null means no limit. |
runMode |
SecurityScanProfileRunMode |
Introduced as an experiment in GitLab 19.4. Whether resolution runs automatically or only when triggered by a user. |
severityLevel |
VulnerabilitySeverity |
Introduced as an experiment in GitLab 19.4. Minimum vulnerability severity that triggers a resolution attempt. Findings below this threshold are skipped. |
SecurityScanProfileSecretDetectionConfigurationInput#
Configuration for a secret detection scan profile.
SecurityScanProfileSecretDetectionConfigurationInput arguments#
| Name | Type | Description |
|---|---|---|
excludedPaths |
[String!] |
Introduced as an experiment in GitLab 19.3. Glob paths excluded from the scan. |
historicScan |
Boolean |
Introduced as an experiment in GitLab 19.3. Whether to scan the full git history instead of only the current state. |
imageSuffix |
SecurityScanProfileImageSuffix |
Introduced as an experiment in GitLab 19.3. Suffix appended to the analyzer image name. |
logOptions |
String |
Introduced as an experiment in GitLab 19.3. Options passed to git log to control the commit range scanned. |
rulesetGitReference |
String |
Introduced as an experiment in GitLab 19.3. Git reference of the remote ruleset configuration to use. |
secureAnalyzersPrefix |
String |
Introduced as an experiment in GitLab 19.3. Prefix for the container registry from which the analyzer image is pulled. |
SecurityScanProfileSecretDetectionFalsePositiveInput#
Configuration for the secret detection false positive detection trigger of a triage and remediation scan profile.
SecurityScanProfileSecretDetectionFalsePositiveInput arguments#
| Name | Type | Description |
|---|---|---|
runMode |
SecurityScanProfileRunMode |
Introduced as an experiment in GitLab 19.4. Whether false positive detection runs automatically or only when triggered by a user. |
severityLevel |
VulnerabilitySeverity |
Introduced as an experiment in GitLab 19.4. Minimum vulnerability severity that triggers false positive detection. Findings below this threshold are skipped. |
SecurityScanProfileTriageAndRemediationConfigurationInput#
Configuration for a triage and remediation scan profile trigger. Exactly one member may be set, and it must match the trigger type it is attached to.
SecurityScanProfileTriageAndRemediationConfigurationInput arguments#
| Name | Type | Description |
|---|---|---|
sastFalsePositive |
SecurityScanProfileSastFalsePositiveInput |
Introduced as an experiment in GitLab 19.4. Configuration for the SAST false positive detection trigger. |
sastVulnerabilityResolution |
SecurityScanProfileSastVulnerabilityResolutionInput |
Introduced as an experiment in GitLab 19.4. Configuration for the SAST vulnerability resolution trigger. |
sbomIngested |
SecurityScanProfileDependencyScanningPostProcessingConfigurationInput |
Introduced as an experiment in GitLab 19.4. Configuration for the SBOM ingested trigger. |
secretDetectionFalsePositive |
SecurityScanProfileSecretDetectionFalsePositiveInput |
Introduced as an experiment in GitLab 19.4. Configuration for the secret detection false positive detection trigger. |
vulnerabilityEnrichment |
SecurityScanProfileVulnerabilityEnrichmentInput |
Introduced as an experiment in GitLab 19.4. Configuration for the vulnerability enrichment trigger. |
SecurityScanProfileTriggerInput#
A trigger, with optional configuration, for a scan profile.
SecurityScanProfileTriggerInput arguments#
| Name | Type | Description |
|---|---|---|
configuration |
SecurityScanProfileConfigurationInput |
Introduced as an experiment in GitLab 19.3. Configuration attached to the trigger. When set, exactly one member must be present and it must match the scan profile type. |
triggerType |
ScanProfileTriggerType! |
Type of the trigger. |
SecurityScanProfileVulnerabilityEnrichmentInput#
Configuration for the vulnerability enrichment trigger of a triage and remediation scan profile.
SecurityScanProfileVulnerabilityEnrichmentInput arguments#
| Name | Type | Description |
|---|---|---|
runMode |
SecurityScanProfileRunMode |
Introduced as an experiment in GitLab 19.4. Whether enrichment runs automatically or only when triggered by a user. |
severityLevel |
VulnerabilitySeverity |
Introduced as an experiment in GitLab 19.4. Minimum vulnerability severity that triggers enrichment. Findings below this threshold are skipped. |
SnippetBlobActionInputType#
Represents an action to perform over a snippet file.
SnippetBlobActionInputType arguments#
| Name | Type | Description |
|---|---|---|
action |
SnippetBlobActionEnum! |
Type of input action. |
content |
String |
Snippet file content. |
filePath |
String! |
Path of the snippet file. |
previousPath |
String |
Previous path of the snippet file. |
StatusMappingInput#
Input for mapping a removed status to a replacement status.
StatusMappingInput arguments#
| Name | Type | Description |
|---|---|---|
newStatusId |
WorkItemsStatusesStatusID! |
Global ID of the replacement status. |
oldStatusId |
WorkItemsStatusesStatusID! |
Global ID of the status being removed/replaced. |
TaskListToggleInput#
Toggles a single task list item checkbox instead of replacing the full Markdown source.
TaskListToggleInput arguments#
| Name | Type | Description |
|---|---|---|
checked |
Boolean! |
Indicates the state the task list item should be toggled to. |
lineSource |
String! |
Full Markdown source of the line containing the task list item; used to detect concurrent edits. |
lineSourcepos |
String! |
Source position of the task list item in the Markdown source; for example, 5:1-5:14. |
Timeframe#
A time-frame defined as a closed inclusive range of two dates.
Timeframe arguments#
TimestampRange#
A closed, inclusive range of two timestamps.
TimestampRange arguments#
TrackingEventInput#
Attributes for defining a tracking event.
TrackingEventInput arguments#
| Name | Type | Description |
|---|---|---|
action |
String! |
Event action. |
category |
String! |
Event category. |
extra |
JSON |
Extra metadata for the event. |
label |
String |
Event label. |
property |
String |
Event property. |
value |
String |
Event value. |
UnionedEpicFilterInput#
UnionedEpicFilterInput arguments#
| Name | Type | Description |
|---|---|---|
authorUsername |
[String!] |
Deprecated in GitLab 16.6. Use authorUsernames instead. |
authorUsernames |
[String!] |
Filters epics that are authored by one of the given users. |
customField |
[WorkItemWidgetCustomFieldFilterInputType!] |
Introduced as an experiment in GitLab 18.4. Filter custom fields by one of the given values. |
labelName |
[String!] |
Deprecated in GitLab 16.6. Use labelNames instead. |
labelNames |
[String!] |
Filters epics that have at least one of the given labels. |
UnionedIssueFilterInput#
UnionedIssueFilterInput arguments#
| Name | Type | Description |
|---|---|---|
assigneeUsernames |
[String!] |
Filters issues that are assigned to at least one of the given users. |
authorUsernames |
[String!] |
Filters issues that are authored by one of the given users. |
customField |
[WorkItemWidgetCustomFieldFilterInputType!] |
Introduced as an experiment in GitLab 18.4. Filter custom fields by one of the given values. |
labelNames |
[String!] |
Filters issues that have at least one of the given labels. |
UnionedMergeRequestFilterInput#
UnionedMergeRequestFilterInput arguments#
| Name | Type | Description |
|---|---|---|
assigneeUsernames |
[String!] |
Filters MRs that are assigned to at least one of the given users. |
onlyReviewerUsername |
String |
Introduced as an experiment in GitLab 17.11. Filters merge requests that have no reviewer OR only reviewer. Only compatible with reviewerWildcard. |
reviewStates |
[MergeRequestReviewState!] |
Introduced as an experiment in GitLab 18.0. Filters merge requests that have been reviewed. Only compatible with reviewerWildcard. |
reviewerWildcard |
ReviewerWildcardId |
Introduced as an experiment in GitLab 17.11. Filter by reviewer presence. |
UnionedWorkItemFilterInput#
UnionedWorkItemFilterInput arguments#
| Name | Type | Description |
|---|---|---|
assigneeUsernames |
[String!] |
Filters work items that are assigned to at least one of the given users (maximum is 100 usernames). |
authorUsernames |
[String!] |
Filters work items that are authored by one of the given users (maximum is 100 usernames). |
customField |
[WorkItemWidgetCustomFieldFilterInputType!] |
Introduced as an experiment in GitLab 18.4. Filter custom fields by one of the given values. |
labelNames |
[String!] |
Filters work items that have at least one of the given labels (maximum is 100 labels). |
UpdateDiffImagePositionInput#
UpdateDiffImagePositionInput arguments#
| Name | Type | Description |
|---|---|---|
height |
Int |
Total height of the image. |
width |
Int |
Total width of the image. |
x |
Int |
X position of the note. |
y |
Int |
Y position of the note. |
UpdateValueStreamStageInput#
Attributes to update value stream stage.
UpdateValueStreamStageInput arguments#
| Name | Type | Description | Default |
|---|---|---|---|
custom |
Boolean |
Whether the stage is customized. If false, it assigns a built-in default stage by name. | true |
endEventIdentifier |
ValueStreamStageEvent |
End event identifier. | |
endEventLabelId |
LabelID |
Label ID associated with the end event identifier. | |
hidden |
Boolean |
Whether the stage is hidden. | |
id |
AnalyticsCycleAnalyticsStageID |
ID of the stage to be updated. | |
name |
String |
Name of the stage. | |
startEventIdentifier |
ValueStreamStageEvent |
Start event identifier. | |
startEventLabelId |
LabelID |
Label ID associated with the start event identifier. |
ValueStreamSettingInput#
Attributes for value stream setting.
ValueStreamSettingInput arguments#
| Name | Type | Description |
|---|---|---|
projectIdsFilter |
[ProjectID!] |
Projects' global IDs used to filter value stream data. |
VerificationStatusFilterInput#
VerificationStatusFilterInput arguments#
| Name | Type | Description |
|---|---|---|
verificationStatus |
RequirementStatusFilter! |
Verification status of the work item. |
VerificationStatusInput#
VerificationStatusInput arguments#
| Name | Type | Description |
|---|---|---|
verificationStatus |
TestReportState! |
Verification status of the work item. |
VulnerabilityCountFilterInput#
Input type for filtering projects by vulnerability count and severity.
VulnerabilityCountFilterInput arguments#
| Name | Type | Description |
|---|---|---|
count |
Int! |
Number of vulnerabilities to filter by. |
operator |
ComparisonOperator! |
Comparison operator for the vulnerability count. |
severity |
VulnerabilitySeverity! |
Severity level of vulnerabilities to filter by. |
VulnerabilityIdentifierInput#
VulnerabilityIdentifierInput arguments#
| Name | Type | Description |
|---|---|---|
externalId |
String |
External ID of the vulnerability identifier. |
externalType |
String |
External type of the vulnerability identifier. |
name |
String! |
Name of the vulnerability identifier. |
url |
String! |
URL of the vulnerability identifier. |
VulnerabilityScannerInput#
VulnerabilityScannerInput arguments#
| Name | Type | Description |
|---|---|---|
id |
String! |
Unique ID that identifies the scanner. |
name |
String! |
Human readable value that identifies the analyzer, not required to be unique. |
url |
String! |
Link to more information about the analyzer. |
vendor |
VulnerabilityScannerVendorInput |
Information about vendor/maintainer of the scanner. |
version |
String! |
Version of the scanner. |
VulnerabilityScannerVendorInput#
VulnerabilityScannerVendorInput arguments#
| Name | Type | Description |
|---|---|---|
name |
String! |
Name of the vendor/maintainer. |
WorkItemConvertTaskInput#
WorkItemConvertTaskInput arguments#
| Name | Type | Description |
|---|---|---|
lineNumberEnd |
Int! |
Last line in the Markdown source that defines the list item task. |
lineNumberStart |
Int! |
First line in the Markdown source that defines the list item task. |
lockVersion |
Int! |
Current lock version of the work item containing the task in the description. |
title |
String! |
Full string of the task to be replaced. New title for the created work item. |
workItemTypeId |
WorkItemsTypeID! |
Global ID of the work item type used to create the new work item. |
WorkItemDecisionOptionInput#
Attributes for a candidate option of a work item decision.
WorkItemDecisionOptionInput arguments#
| Name | Type | Description |
|---|---|---|
content |
String! |
Content of the decision option. |
description |
String |
Reasoning behind the decision option. |
recommended |
Boolean |
Indicates the option is recommended by GitLab Duo. |
WorkItemDecisionOptionUpdateInput#
Attributes to update on an existing option of a work item decision.
WorkItemDecisionOptionUpdateInput arguments#
| Name | Type | Description |
|---|---|---|
content |
String |
Content of the decision option. |
description |
String |
Reasoning behind the decision option. |
id |
WorkItemsDecisionOptionID! |
Global ID of the decision option. |
selected |
Boolean |
Indicates the option is selected. Can only be updated on resolved decisions. |
WorkItemDecisionResolutionInput#
Attributes for recording a work item decision as resolved at creation.
WorkItemDecisionResolutionInput arguments#
| Name | Type | Description |
|---|---|---|
decision |
String! |
Decision that was made, recorded as the selected option of the work item decision. |
rationale |
String |
Reasoning behind the decision. |
resolvedById |
UserID |
Global ID of the user who resolved the decision. Defaults to the current user. |
WorkItemDescriptionTemplateContentInput#
WorkItemDescriptionTemplateContentInput arguments#
| Name | Type | Description |
|---|---|---|
fromNamespace |
String |
Full path of the group or project using the template. |
name |
String! |
Name of the description template. |
projectId |
BigInt! |
ID of the project the template belongs to. |
WorkItemRelativeDateFiltersInput#
Date filters relative to today. Each date resolves to the start of that day in the instance time zone.
WorkItemRelativeDateFiltersInput arguments#
| Name | Type | Description |
|---|---|---|
closedAfter |
WorkItemRelativeDateInput |
Work items closed on or after the date. |
closedBefore |
WorkItemRelativeDateInput |
Work items closed before the date. |
createdAfter |
WorkItemRelativeDateInput |
Work items created on or after the date. |
createdBefore |
WorkItemRelativeDateInput |
Work items created before the date. |
dueAfter |
WorkItemRelativeDateInput |
Work items due on or after the date. |
dueBefore |
WorkItemRelativeDateInput |
Work items due before the date. |
updatedAfter |
WorkItemRelativeDateInput |
Work items updated on or after the date. |
updatedBefore |
WorkItemRelativeDateInput |
Work items updated before the date. |
WorkItemRelativeDateInput#
Date relative to today, in the instance time zone.
WorkItemRelativeDateInput arguments#
| Name | Type | Description |
|---|---|---|
amount |
Int! |
Number of units, from -9999 to 9999. Negative values are in the past, positive values are in the future, and 0 is today. |
unit |
WorkItemRelativeDateUnit! |
Unit of amount. |
WorkItemResolveDiscussionsInput#
WorkItemResolveDiscussionsInput arguments#
| Name | Type | Description |
|---|---|---|
discussionId |
String |
ID of a discussion to resolve. |
noteableId |
NoteableID! |
Global ID of the noteable where discussions will be resolved when the work item is created. Only MergeRequestID is supported at the moment. |
WorkItemSavedViewFilterInput#
WorkItemSavedViewFilterInput arguments#
| Name | Type | Description |
|---|---|---|
assigneeUsernames |
[String!] |
Filter values for assignee usernames filter(maximum is 100 usernames). |
assigneeWildcardId |
AssigneeWildcardId |
Filter values for assignee wildcard id filter. Incompatible with assigneeUsernames. |
authorUsername |
String |
Filter value for author username filter. |
closedAfter |
Time |
Filter value for closed after filter. |
closedBefore |
Time |
Filter value for closed before filter. |
confidential |
Boolean |
Filter value for confidential filter. |
createdAfter |
Time |
Filter value for created after filter. |
createdBefore |
Time |
Filter value for created before filter. |
crmContactId |
String |
Filter value for crm contact id filter. |
crmOrganizationId |
String |
Filter value for crm organization id filter. |
customField |
[WorkItemWidgetCustomFieldFilterInputType!] |
Filter value for custom field filter. (maximum is 100 fields). |
dueAfter |
Time |
Filter value for due after filter. |
dueBefore |
Time |
Filter value for due before filter. |
excludeGroupWorkItems |
Boolean |
Filter value for exclude group work items filter. |
excludeProjects |
Boolean |
Filter value for exclude projects filter. |
fullPath |
ID |
Filter value for full path filter. |
healthStatusFilter |
HealthStatusFilter |
Filter value for health status filter. |
hierarchyFilters |
HierarchyFilterInput |
Filter value for hierarchy filter. |
iid |
String |
Filter value for IID filter. |
in |
[IssuableSearchableField!] |
"Filter value for in filter. |
includeDescendantWorkItems |
Boolean |
Filter value for include descendant work items filter. |
includeDescendants |
Boolean |
Filter value for include descendants filter. |
iterationCadenceId |
[IterationsCadenceID!] |
Filter value for iteration cadence id filter. (maximum is 100 IDs). |
iterationId |
[ID!] |
Filter value for iteration id filter. |
iterationWildcardId |
IterationWildcardId |
Filter value for iteration wildcard id filter. |
labelName |
[String!] |
Filter value for label name filter. (maximum is 100 labels). |
milestoneTitle |
[String!] |
Filter value for milestone title filter. (maximum is 100 milestones). |
milestoneWildcardId |
MilestoneWildcardId |
Filter value for milestone wildcard id filter. Incompatible with milestoneTitle. |
myReactionEmoji |
String |
Filter value for my reaction emoji filter. |
not |
WorkItemSavedViewNegatedFilterInput |
Filter value for not filter. |
or |
WorkItemSavedViewUnionedFilterInput |
Filter values for or filter. |
relativeDateFilters |
WorkItemRelativeDateFiltersInput |
Introduced as an experiment in GitLab 19.6. Filter values for date filters relative to today. The saved view stores them unchanged, so its dates move forward each day. Cannot be combined with the matching absolute filter, such as createdAfter. |
releaseTag |
[String!] |
Filter value for release tag filter (maximum is 100 tags). |
releaseTagWildcardId |
ReleaseTagWildcardId |
Filter value for release tag wildcard id filter. |
search |
String |
Filter value for search filter. |
state |
IssuableState |
Filter value for state filter. |
status |
WorkItemWidgetStatusFilterInput |
Filter value for status filter. |
subscribed |
SubscriptionStatus |
Filter value for subscribed filter. |
types |
[IssueType!] |
Filter value for types filter. |
updatedAfter |
Time |
Filter value for updated after filter. |
updatedBefore |
Time |
Filter value for updated before filter. |
weight |
String |
Filter value for weight filter. |
weightWildcardId |
WeightWildcardId |
Filter value for weight wildcard id filter. |
workItemTypeIds |
[WorkItemsTypeID!] |
Filter value for work item type global IDs. |
WorkItemSavedViewNegatedFilterInput#
WorkItemSavedViewNegatedFilterInput arguments#
| Name | Type | Description |
|---|---|---|
assigneeUsernames |
[String!] |
Filter value for not assignee username filter. (maximum is 100 usernames). |
authorUsername |
[String!] |
Filter value for not author username filter. (maximum is 100 usernames). |
customField |
[WorkItemWidgetCustomFieldFilterInputType!] |
Filter value for not custom field filter. |
healthStatusFilter |
[HealthStatus!] |
Filter values for not health status filter. |
iterationId |
[ID!] |
Filter values for not iteration id filter. (maximum is 100 IDs). |
iterationWildcardId |
IterationWildcardId |
Filter value for not iteration wildcard id filter. |
labelName |
[String!] |
Filter value for not label name filter. (maximum is 100 labels). |
milestoneTitle |
[String!] |
Filter value for not milestone title filter.(maximum is 100 milestones). |
milestoneWildcardId |
NegatedMilestoneWildcardId |
Filter value for not milestone wildcard id filter. |
myReactionEmoji |
String |
Filter value for not my reaction emoji filter. |
parentIds |
[WorkItemID!] |
Filter work items by global IDs who don't belong to parent items (maximum is 100 IDs). |
releaseTag |
[String!] |
File value for not release tag filter. (maximum is 100 tags). |
types |
[IssueType!] |
Filter value for not types filter. |
weight |
String |
Filter values for not weight filter. |
workItemTypeIds |
[WorkItemsTypeID!] |
Filter value for not work item type global IDs filter. |
WorkItemSavedViewUnionedFilterInput#
WorkItemSavedViewUnionedFilterInput arguments#
| Name | Type | Description |
|---|---|---|
assigneeUsernames |
[String!] |
Filter value for unioned assignee usernames filter. (maximum is 100 usernames). |
authorUsernames |
[String!] |
Filter value for unioned author usernames filter. (maximum is 100 usernames). |
customField |
[WorkItemWidgetCustomFieldFilterInputType!] |
Filter value for unioned custom field filter. |
labelNames |
[String!] |
Filter value for unioned label names filter.(maximum is 100 labels). |
WorkItemStatusInput#
WorkItemStatusInput arguments#
| Name | Type | Description |
|---|---|---|
category |
WorkItemStatusCategoryEnum |
Category of the status. |
color |
String |
Color of the status. |
description |
String |
Description of the status. |
id |
GlobalID |
ID of the status. If not provided, a new status will be created. |
name |
String |
Name of the status. |
WorkItemWidgetAgentPlanInput#
WorkItemWidgetAgentPlanInput arguments#
| Name | Type | Description |
|---|---|---|
content |
String |
Content of the agent plan. |
readinessScore |
Int |
Introduced as an experiment in GitLab 19.3. Readiness score of the agent plan (0-100). Null when the score is not yet available. Only available when the workplan feature flag is enabled. |
readinessScoreFeedback |
String |
Introduced as an experiment in GitLab 19.4. Markdown feedback explaining the readiness score. Only available when the workplan feature flag is enabled. |
WorkItemWidgetAssigneesInput#
WorkItemWidgetAssigneesInput arguments#
| Name | Type | Description |
|---|---|---|
assigneeIds |
[UserID!]! |
Global IDs of assignees. |
WorkItemWidgetAwardEmojiUpdateInput#
WorkItemWidgetAwardEmojiUpdateInput arguments#
| Name | Type | Description |
|---|---|---|
action |
WorkItemAwardEmojiUpdateAction! |
Action for the update. |
name |
String! |
Emoji name. |
WorkItemWidgetColorInput#
WorkItemWidgetColorInput arguments#
| Name | Type | Description |
|---|---|---|
color |
Color! |
Color of the work item. |
WorkItemWidgetCrmContactsCreateInput#
WorkItemWidgetCrmContactsCreateInput arguments#
| Name | Type | Description |
|---|---|---|
contactIds |
[CustomerRelationsContactID!]! |
CRM contact IDs to set. |
WorkItemWidgetCrmContactsUpdateInput#
WorkItemWidgetCrmContactsUpdateInput arguments#
| Name | Type | Description | Default |
|---|---|---|---|
contactIds |
[CustomerRelationsContactID!]! |
CRM contact IDs to set. Replaces existing contacts by default. | |
operationMode |
MutationOperationMode |
Set the operation mode. | REPLACE |
WorkItemWidgetCurrentUserTodosInput#
WorkItemWidgetCurrentUserTodosInput arguments#
| Name | Type | Description |
|---|---|---|
action |
WorkItemTodoUpdateAction! |
Action for the update. |
todoId |
TodoID |
Global ID of the to-do. If not present, all to-dos of the work item will be updated. |
WorkItemWidgetCustomFieldFilterInputType#
WorkItemWidgetCustomFieldFilterInputType arguments#
| Name | Type | Description |
|---|---|---|
customFieldId |
IssuablesCustomFieldID |
Global ID of the custom field. |
customFieldName |
String |
Name of the custom field. |
selectedOptionIds |
[IssuablesCustomFieldSelectOptionID!] |
Global IDs of the selected options for custom fields with select type (maximum is 100 IDs). |
selectedOptionValues |
[String!] |
Values of the selected options for custom fields with select type (maximum is 100 values). |
WorkItemWidgetCustomFieldValueInputType#
WorkItemWidgetCustomFieldValueInputType arguments#
| Name | Type | Description |
|---|---|---|
customFieldId |
IssuablesCustomFieldID! |
Global ID of the custom field. |
dateValue |
Date |
Value for custom fields with date type. |
numberValue |
Float |
Value for custom fields with number type. |
selectedOptionIds |
[IssuablesCustomFieldSelectOptionID!] |
Global IDs of the selected options for custom fields with select type. |
textValue |
String |
Value for custom fields with text type. |
WorkItemWidgetDescriptionInput#
WorkItemWidgetDescriptionInput arguments#
| Name | Type | Description |
|---|---|---|
description |
String |
Description of the work item. |
taskListToggle |
TaskListToggleInput |
Toggle a single task list item instead of replacing the full description. Only supported when updating a work item. |
WorkItemWidgetDevelopmentCreateInput#
WorkItemWidgetDevelopmentCreateInput arguments#
| Name | Type | Description |
|---|---|---|
linkType |
MergeRequestWorkItemLinkType |
Type of link. Defaults to RELATED. |
mergeRequestIds |
[MergeRequestID!]! |
Global IDs of the merge requests to link. Maximum number of IDs you can provide: 100. |
WorkItemWidgetHealthStatusInput#
WorkItemWidgetHealthStatusInput arguments#
| Name | Type | Description |
|---|---|---|
healthStatus |
HealthStatus |
Health status to be assigned to the work item. |
WorkItemWidgetHierarchyCreateInput#
WorkItemWidgetHierarchyCreateInput arguments#
| Name | Type | Description |
|---|---|---|
parentId |
WorkItemID |
Global ID of the parent work item. |
WorkItemWidgetHierarchyUpdateInput#
WorkItemWidgetHierarchyUpdateInput arguments#
| Name | Type | Description |
|---|---|---|
adjacentWorkItemId |
WorkItemID |
ID of the work item to be switched with. |
childrenIds |
[WorkItemID!] |
Global IDs of child work items (maximum is 1000). When the work_item_hierarchy_add_children_limits feature flag is enabled, a request can add at most 50 child items. |
parentId |
WorkItemID |
Global ID of the parent work item. Use null to remove the association. |
relativePosition |
RelativePositionType |
Type of switch. Valid values are BEFORE or AFTER. |
WorkItemWidgetIterationInput#
WorkItemWidgetIterationInput arguments#
| Name | Type | Description |
|---|---|---|
iterationId |
IterationID |
Iteration to assign to the work item. |
WorkItemWidgetLabelsCreateInput#
WorkItemWidgetLabelsCreateInput arguments#
| Name | Type | Description |
|---|---|---|
labelIds |
[LabelID!]! |
IDs of labels to be added to the work item. |
WorkItemWidgetLabelsUpdateInput#
WorkItemWidgetLabelsUpdateInput arguments#
| Name | Type | Description |
|---|---|---|
addLabelIds |
[LabelID!] |
Global IDs of labels to be added to the work item. |
removeLabelIds |
[LabelID!] |
Global IDs of labels to be removed from the work item. |
WorkItemWidgetLinkedItemsCreateInput#
WorkItemWidgetLinkedItemsCreateInput arguments#
| Name | Type | Description |
|---|---|---|
linkType |
WorkItemRelatedLinkType |
Type of link. Defaults to RELATED. |
workItemsIds |
[WorkItemID!]! |
Global IDs of the items to link. Maximum number of IDs you can provide: 10. |
WorkItemWidgetMilestoneInput#
WorkItemWidgetMilestoneInput arguments#
| Name | Type | Description |
|---|---|---|
milestoneId |
MilestoneID |
Milestone to assign to the work item. |
WorkItemWidgetNotesInput#
WorkItemWidgetNotesInput arguments#
| Name | Type | Description |
|---|---|---|
discussionLocked |
Boolean! |
Discussion lock attribute for notes widget of the work item. |
WorkItemWidgetNotificationsUpdateInput#
WorkItemWidgetNotificationsUpdateInput arguments#
| Name | Type | Description |
|---|---|---|
subscribed |
Boolean! |
Desired state of the subscription. |
WorkItemWidgetProgressInput#
WorkItemWidgetProgressInput arguments#
| Name | Type | Description |
|---|---|---|
currentValue |
Int! |
Current progress value of the work item. |
endValue |
Int |
End value of the work item. |
startValue |
Int |
Start value of the work item. |
WorkItemWidgetSeverityInput#
WorkItemWidgetSeverityInput arguments#
| Name | Type | Description |
|---|---|---|
severity |
IssuableSeverity! |
Severity of the work item. |
WorkItemWidgetStartAndDueDateUpdateInput#
WorkItemWidgetStartAndDueDateUpdateInput arguments#
| Name | Type | Description |
|---|---|---|
dueDate |
Date |
Due date for the work item. |
isFixed |
Boolean |
Indicates if the work item is using fixed dates. |
startDate |
Date |
Start date for the work item. |
WorkItemWidgetStatusFilterInput#
WorkItemWidgetStatusFilterInput arguments#
| Name | Type | Description |
|---|---|---|
id |
WorkItemsStatusesStatusID |
Global ID of the status. |
name |
String |
Name of the status. |
WorkItemWidgetStatusInput#
WorkItemWidgetStatusInput arguments#
| Name | Type | Description |
|---|---|---|
name |
String |
Name of the status. Resolved case-insensitively against the work item's status lifecycle. Mutually exclusive with status. |
status |
WorkItemsStatusesStatusID |
Global ID of the status. Mutually exclusive with name. |
WorkItemWidgetTimeTrackingInput#
WorkItemWidgetTimeTrackingInput arguments#
| Name | Type | Description |
|---|---|---|
timeEstimate |
String |
Time estimate for the work item in human readable format. For example: 1h 30m. |
timelog |
WorkItemWidgetTimeTrackingTimelogInput |
Timelog data for time spent on the work item. |
WorkItemWidgetTimeTrackingTimelogInput#
WorkItemWidgetTimeTrackingTimelogInput arguments#
| Name | Type | Description |
|---|---|---|
spentAt |
Time |
Timestamp of when the time tracked was spent at, if not provided would be set to current timestamp. |
summary |
String |
Summary of how the time was spent. |
timeSpent |
String! |
Amount of time spent in human readable format. For example: 1h 30m. |
WorkItemWidgetWeightInput#
WorkItemWidgetWeightInput arguments#
| Name | Type | Description |
|---|---|---|
weight |
Int |
Weight of the work item. |
WorkspaceVariableInput#
Attributes for defining a variable to be injected in a workspace.
WorkspaceVariableInput arguments#
| Name | Type | Description | Default |
|---|---|---|---|
key |
String! |
Name of the workspace variable. | |
type |
WorkspaceVariableInputType |
Deprecated in GitLab 17.9. Use variableType instead. |
ENVIRONMENT |
value |
String! |
Value of the variable. | |
variableType |
WorkspaceVariableType |
Type of the variable to be injected in a workspace. | ENVIRONMENT |