GraphQL API resources

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

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

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

Query type

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

Query.abuseReport

Find an abuse report.

Returns AbuseReport.

Arguments

Query.abuseReportLabels

Abuse report labels.

Returns AbuseReportLabelConnection.

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

Arguments

Query.addOnPurchase

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

Returns AddOnPurchase.

Arguments

Query.addOnPurchases

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

Returns [AddOnPurchase!].

Arguments

Query.adminMemberRole

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

Returns AdminMemberRole.

Arguments

Query.adminMemberRolePermissions

List of all admin customizable permissions.

Returns CustomizableAdminPermissionConnection.

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

Query.adminMemberRoles

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

Returns AdminMemberRoleConnection.

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

Arguments

Query.aiConversationThreads

List conversation threads of AI features.

Returns AiConversationsThreadConnection!.

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

Arguments

Query.aiFeatureSettings

List of configurable AI features.

Returns AiFeatureSettingConnection.

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

Arguments

Query.aiMessages

Find GitLab Duo Chat messages.

Returns AiMessageConnection!.

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

Arguments

Query.aiSelfHostedModels

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

Returns AiSelfHostedModelConnection.

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

Arguments

Query.aiSlashCommands

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

Returns [SlashCommand!].

Arguments

Query.auditEventDefinitions

Definitions for all audit events available on the instance.

Returns AuditEventDefinitionConnection!.

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

Query.auditEventsInstanceAmazonS3Configurations

Instance-level Amazon S3 configurations for audit events.

Returns InstanceAmazonS3ConfigurationTypeConnection.

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

Query.auditEventsInstanceStreamingDestinations

Instance-level external audit event streaming destinations.

Returns InstanceAuditEventStreamingDestinationConnection.

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

Query.blobSearch

Find code visible to the current user.

Returns BlobSearch.

Arguments

Query.boardList

Find an issue board list.

Returns BoardList.

Arguments

Query.ciApplicationSettings

CI related settings that apply to the entire instance.

Returns CiApplicationSettings.

Query.ciCatalogResource

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

Returns CiCatalogResource.

Arguments

Query.ciCatalogResources

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

Returns CiCatalogResourceConnection.

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

Arguments

Query.ciConfig

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

Returns CiConfig.

Arguments

Query.ciDedicatedHostedRunnerUsage

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

Returns CiDedicatedHostedRunnerUsageConnection.

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

Arguments

Query.ciMinutesUsage

Compute usage data for a namespace.

Returns CiMinutesNamespaceMonthlyUsageConnection.

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

Arguments

Query.ciPipelineStage

Stage belonging to a CI pipeline.

Returns CiStage.

Arguments

Query.ciQueueingHistory

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

Returns QueueingDelayHistory.

Arguments

Query.ciVariables

List of the instance’s CI/CD variables.

Returns CiInstanceVariableConnection.

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

Arguments

Query.cloudConnectorStatus

Run a series of status checks for Cloud Connector features.

Returns CloudConnectorStatus.

Query.complianceRequirementControls

Get the list of all the compliance requirement controls.

Returns ComplianceRequirementControl.

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 CurrentUser.

Query.designManagement

Fields related to design management.

Returns DesignManagement!.

Query.devopsAdoptionEnabledNamespaces

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

Returns DevopsAdoptionEnabledNamespaceConnection.

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

Arguments

Query.duoSettings

Get GitLab Duo settings.

Returns DuoSettings.

Query.duoWorkflowEvents

List the events for a Duo Workflow.

Returns DuoWorkflowEventConnection!.

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

Arguments

Query.duoWorkflowWorkflows

List the workflows owned by the current user.

Returns DuoWorkflowConnection!.

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

Arguments

Query.echo

Testing endpoint to validate the API with.

Returns String!.

Arguments

Query.epicBoardList

Returns EpicList.

Arguments

Query.featureFlagEnabled

Check if a feature flag is enabled.

Returns Boolean!.

Arguments

Query.frecentGroups

A user’s frecently visited groups.

Returns [Group!].

Query.frecentProjects

A user’s frecently visited projects.

Returns [Project!].

Query.geoNode

Find a Geo node.

Returns GeoNode.

Arguments

Query.gitpodEnabled

Whether Gitpod is enabled in application settings.

Returns Boolean.

Query.googleCloudArtifactRegistryRepositoryArtifact

Details about an artifact in the Google Artifact Registry.

Returns GoogleCloudArtifactRegistryArtifactDetails.

Arguments

Query.group

Find a group.

Returns Group.

Arguments

Query.groups

Find groups.

Returns GroupConnection.

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

Arguments

Query.instanceExternalAuditEventDestinations

Instance level external audit event destinations.

Returns InstanceExternalAuditEventDestinationConnection.

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

Query.instanceGoogleCloudLoggingConfigurations

Instance level google cloud logging configurations.

Returns InstanceGoogleCloudLoggingConfigurationTypeConnection.

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

Query.instanceSecurityDashboard

Fields related to Instance Security Dashboard.

Returns InstanceSecurityDashboard.

Query.integrationExclusions

Returns IntegrationExclusionConnection.

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

Arguments

Query.issue

Find an issue.

Returns Issue.

Arguments

Query.issues

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

Returns IssueConnection.

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

Arguments

Query.iteration

Find an iteration.

Returns Iteration.

Arguments

Query.jobs

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

Returns CiJobConnection.

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

Arguments

Query.licenseHistoryEntries

Fields related to entries in the license history.

Returns LicenseHistoryEntryConnection.

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

Query.memberRole

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

Returns MemberRole.

Arguments

Query.memberRolePermissions

List of all standard customizable permissions.

Returns CustomizableStandardPermissionConnection.

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

Query.memberRoles

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

Returns MemberRoleConnection.

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

Arguments

Query.mergeRequest

Find a merge request.

Returns MergeRequest.

Arguments

Query.metadata

Metadata about GitLab.

Returns Metadata.

Query.milestone

Find a milestone.

Returns Milestone.

Arguments

Query.mlExperiment

Find a machine learning experiment.

Returns MlExperiment.

Arguments

Query.mlModel

Find machine learning models.

Returns MlModel.

Arguments

Query.namespace

Find a namespace.

Returns Namespace.

Arguments

Query.note

Find a note.

Returns Note.

Arguments

Query.organization

Find an organization.

Returns Organization.

Arguments

Query.organizations

List organizations.

Returns OrganizationConnection.

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

Query.package

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

Returns PackageDetailsType.

Arguments

Query.project

Find a project.

Returns Project.

Arguments

Query.projectSecret

View a specific project secret.

Returns ProjectSecret.

Arguments

Query.projectSecrets

List project secrets.

Returns ProjectSecretConnection.

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

Arguments

Query.projectSecretsManager

Find a project secrets manager.

Returns ProjectSecretsManager.

Arguments

Query.projects

Find projects visible to the current user.

Returns ProjectConnection.

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

Arguments

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, and last: Int.

Query.runnerSetup

Runner setup instructions.

Returns RunnerSetup.

Arguments

Query.runnerUsage

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

Returns [CiRunnerUsage!].

Arguments

Query.runnerUsageByProject

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

Returns [CiRunnerUsageByProject!].

Arguments

Query.runners

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

Returns CiRunnerConnection.

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

Arguments

Query.selfManagedAddOnEligibleUsers

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

Returns AddOnUserConnection.

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

Arguments

Query.selfManagedUsersQueuedForRolePromotion

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

Returns UsersQueuedForRolePromotionConnection.

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

Query.snippets

Find Snippets visible to the current user.

Returns SnippetConnection.

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

Arguments

Query.standardRole

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

Returns StandardRole.

Arguments

Query.standardRoles

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

Returns StandardRoleConnection.

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

Arguments

Query.subscriptionFutureEntries

Fields related to entries in future subscriptions.

Returns SubscriptionFutureEntryConnection.

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

Query.syntheticNote

Find a synthetic note.

Returns Note.

Arguments

Query.timelogs

Find timelogs visible to the current user.

Returns TimelogConnection.

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

Arguments

Query.todo

Retrieve a single to-do item.

Returns Todo.

Arguments

Query.topics

Find project topics.

Returns TopicConnection.

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

Arguments

Query.usageTrendsMeasurements

Get statistics on the instance.

Returns UsageTrendsMeasurementConnection.

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

Arguments

Query.user

Find a user.

Returns UserCore.

Arguments

Query.users

Find users.

Returns UserCoreConnection.

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

Arguments

Query.vulnerabilities

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

Returns VulnerabilityConnection.

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

Arguments

Query.vulnerabilitiesCountByDay

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

Returns VulnerabilitiesCountByDayConnection.

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

Arguments

Query.vulnerability

Find a vulnerability.

Returns Vulnerability.

Arguments

Query.wikiPage

Find a wiki page.

Returns WikiPage.

Arguments

Query.workItem

Find a work item.

Returns WorkItem.

Arguments

Query.workItemDescriptionTemplateContent

Find a work item description template.

Returns WorkItemDescriptionTemplate.

Arguments

Query.workItemsByReference

Find work items by their reference.

Returns WorkItemConnection.

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

Arguments

Query.workspace

Find a workspace.

Returns Workspace.

Arguments

Query.workspaces

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

Returns WorkspaceConnection.

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

Arguments

Mutation type

The Mutation type contains all the mutations you can execute.

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

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

For example:

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

Mutation.abuseReportLabelCreate

Input type: AbuseReportLabelCreateInput

Arguments

Fields

Mutation.achievementsAward

Input type: AchievementsAwardInput

Arguments

Fields

Mutation.achievementsCreate

Input type: AchievementsCreateInput

Arguments

Fields

Mutation.achievementsDelete

Input type: AchievementsDeleteInput

Arguments

Fields

Mutation.achievementsRevoke

Input type: AchievementsRevokeInput

Arguments

Fields

Mutation.achievementsUpdate

Input type: AchievementsUpdateInput

Arguments

Fields

Mutation.addProjectToSecurityDashboard

Input type: AddProjectToSecurityDashboardInput

Arguments

Fields

Mutation.adminSidekiqQueuesDeleteJobs

Input type: AdminSidekiqQueuesDeleteJobsInput

Arguments

Fields

Mutation.aiAction

Input type: AiActionInput

Arguments

Fields

Mutation.aiAgentCreate

Input type: AiAgentCreateInput

Arguments

Fields

Mutation.aiAgentDestroy

Input type: AiAgentDestroyInput

Arguments

Fields

Mutation.aiAgentUpdate

Input type: AiAgentUpdateInput

Arguments

Fields

Mutation.aiFeatureSettingUpdate

Updates or create setting for the AI feature.

Input type: AiFeatureSettingUpdateInput

Arguments

Fields

Mutation.aiSelfHostedModelConnectionCheck

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

Input type: AiSelfHostedModelConnectionCheckInput

Arguments

Fields

Mutation.aiSelfHostedModelCreate

Input type: AiSelfHostedModelCreateInput

Arguments

Fields

Mutation.aiSelfHostedModelDelete

Deletes a self-hosted model.

Input type: AiSelfHostedModelDeleteInput

Arguments

Fields

Mutation.aiSelfHostedModelUpdate

Updates a self-hosted model.

Input type: AiSelfHostedModelUpdateInput

Arguments

Fields

Mutation.alertSetAssignees

Input type: AlertSetAssigneesInput

Arguments

Fields

Mutation.alertTodoCreate

Input type: AlertTodoCreateInput

Arguments

Fields

Mutation.approvalProjectRuleDelete

Input type: approvalProjectRuleDeleteInput

Arguments

Fields

Mutation.approvalProjectRuleUpdate

Input type: approvalProjectRuleUpdateInput

Arguments

Fields

Mutation.approveDeployment

Input type: ApproveDeploymentInput

Arguments

Fields

Mutation.artifactDestroy

Input type: ArtifactDestroyInput

Arguments

Fields

Mutation.auditEventsAmazonS3ConfigurationCreate

Input type: AuditEventsAmazonS3ConfigurationCreateInput

Arguments

Fields

Mutation.auditEventsAmazonS3ConfigurationDelete

Input type: AuditEventsAmazonS3ConfigurationDeleteInput

Arguments

Fields

Mutation.auditEventsAmazonS3ConfigurationUpdate

Input type: AuditEventsAmazonS3ConfigurationUpdateInput

Arguments

Fields

Mutation.auditEventsGroupDestinationEventsAdd

Input type: AuditEventsGroupDestinationEventsAddInput

Arguments

Fields

Mutation.auditEventsGroupDestinationEventsDelete

Input type: AuditEventsGroupDestinationEventsDeleteInput

Arguments

Fields

Mutation.auditEventsGroupDestinationNamespaceFilterCreate

Input type: AuditEventsGroupDestinationNamespaceFilterCreateInput

Arguments

Fields

Mutation.auditEventsGroupDestinationNamespaceFilterDelete

Input type: AuditEventsGroupDestinationNamespaceFilterDeleteInput

Arguments

Fields

Mutation.auditEventsInstanceAmazonS3ConfigurationCreate

Input type: AuditEventsInstanceAmazonS3ConfigurationCreateInput

Arguments

Fields

Mutation.auditEventsInstanceAmazonS3ConfigurationDelete

Input type: AuditEventsInstanceAmazonS3ConfigurationDeleteInput

Arguments

Fields

Mutation.auditEventsInstanceAmazonS3ConfigurationUpdate

Input type: AuditEventsInstanceAmazonS3ConfigurationUpdateInput

Arguments

Fields

Mutation.auditEventsInstanceDestinationEventsAdd

Input type: AuditEventsInstanceDestinationEventsAddInput

Arguments

Fields

Mutation.auditEventsInstanceDestinationEventsDelete

Input type: AuditEventsInstanceDestinationEventsDeleteInput

Arguments

Fields

Mutation.auditEventsInstanceDestinationNamespaceFilterCreate

Input type: AuditEventsInstanceDestinationNamespaceFilterCreateInput

Arguments

Fields

Mutation.auditEventsInstanceDestinationNamespaceFilterDelete

Input type: AuditEventsInstanceDestinationNamespaceFilterDeleteInput

Arguments

Fields

Mutation.auditEventsStreamingDestinationEventsAdd

Input type: AuditEventsStreamingDestinationEventsAddInput

Arguments

Fields

Mutation.auditEventsStreamingDestinationEventsRemove

Input type: AuditEventsStreamingDestinationEventsRemoveInput

Arguments

Fields

Mutation.auditEventsStreamingDestinationInstanceEventsAdd

Input type: AuditEventsStreamingDestinationInstanceEventsAddInput

Arguments

Fields

Mutation.auditEventsStreamingDestinationInstanceEventsRemove

Input type: AuditEventsStreamingDestinationInstanceEventsRemoveInput

Arguments

Fields

Mutation.auditEventsStreamingHeadersCreate

Input type: AuditEventsStreamingHeadersCreateInput

Arguments

Fields

Mutation.auditEventsStreamingHeadersDestroy

Input type: AuditEventsStreamingHeadersDestroyInput

Arguments

Fields

Mutation.auditEventsStreamingHeadersUpdate

Input type: AuditEventsStreamingHeadersUpdateInput

Arguments

Fields

Mutation.auditEventsStreamingHttpNamespaceFiltersAdd

Input type: AuditEventsStreamingHTTPNamespaceFiltersAddInput

Arguments

Fields

Mutation.auditEventsStreamingHttpNamespaceFiltersDelete

Input type: AuditEventsStreamingHTTPNamespaceFiltersDeleteInput

Arguments