2021-01-29 00:20:46 +05:30
---
stage: none
group: unassigned
2021-02-22 17:27:13 +05:30
info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/engineering/ux/technical-writing/#assignments
2021-01-29 00:20:46 +05:30
---
2019-09-30 21:07:59 +05:30
# GraphQL API
2018-11-08 19:23:39 +05:30
2020-04-22 19:07:51 +05:30
> - [Introduced](https://gitlab.com/gitlab-org/gitlab-foss/-/merge_requests/19008) in GitLab 11.0 (enabled by feature flag `graphql`).
> - [Always enabled](https://gitlab.com/gitlab-org/gitlab-foss/-/merge_requests/30444) in GitLab 12.1.
2018-11-08 19:23:39 +05:30
2020-01-01 13:55:28 +05:30
## Getting Started
For those new to the GitLab GraphQL API, see
[Getting started with GitLab GraphQL API ](getting_started.md ).
### Quick Reference
2021-02-22 17:27:13 +05:30
- The GitLab GraphQL API endpoint is located at `/api/graphql` .
2020-01-01 13:55:28 +05:30
- Get an [introduction to GraphQL from graphql.org ](https://graphql.org/ ).
- GitLab supports a wide range of resources, listed in the [GraphQL API Reference ](reference/index.md ).
2020-10-24 23:57:45 +05:30
### Examples
To work with sample queries that pull data from public projects on GitLab.com,
see the menu options in the left-hand
documentation menu, under API > GraphQL at `https://docs.gitlab.com/ee/api/graphql/` .
The [Getting started ](getting_started.md ) page includes different methods to customize GraphQL queries.
### GraphiQL
2020-01-01 13:55:28 +05:30
Explore the GraphQL API using the interactive [GraphiQL explorer ](https://gitlab.com/-/graphql-explorer ),
or on your self-managed GitLab instance on
`https://<your-gitlab-site.com>/-/graphql-explorer` .
See the [GitLab GraphQL overview ](getting_started.md#graphiql ) for more information about the GraphiQL Explorer.
## What is GraphQL?
2018-11-08 19:23:39 +05:30
[GraphQL ](https://graphql.org/ ) is a query language for APIs that
allows clients to request exactly the data they need, making it
possible to get all required data in a limited number of requests.
The GraphQL data (fields) can be described in the form of types,
2020-06-23 00:09:42 +05:30
allowing clients to use [client-side GraphQL
2018-11-08 19:23:39 +05:30
libraries](https://graphql.org/code/#graphql-clients) to consume the
API and avoid manual parsing.
2020-06-23 00:09:42 +05:30
Since there's no fixed endpoints and data model, new abilities can be
2021-03-11 19:13:27 +05:30
added to the API without creating [breaking changes ](../../development/contributing/#breaking-changes ). This allows us to
2018-11-08 19:23:39 +05:30
have a versionless API as described in [the GraphQL
documentation](https://graphql.org/learn/best-practices/#versioning).
2019-09-04 21:01:54 +05:30
## Vision
We want the GraphQL API to be the **primary** means of interacting
programmatically with GitLab. To achieve this, it needs full coverage - anything
possible in the REST API should also be possible in the GraphQL API.
To help us meet this vision, the frontend should use GraphQL in preference to
2019-09-30 21:07:59 +05:30
the REST API for new features.
2019-09-04 21:01:54 +05:30
There are no plans to deprecate the REST API. To reduce the technical burden of
supporting two APIs in parallel, they should share implementations as much as
possible.
2021-04-17 20:07:23 +05:30
## Breaking changes
2020-11-24 15:15:51 +05:30
2021-04-17 20:07:23 +05:30
The GitLab GraphQL API is [versionless ](https://graphql.org/learn/best-practices/#versioning ) and
changes are made to the API in a way that maintains backwards-compatibility.
2020-11-24 15:15:51 +05:30
2021-04-17 20:07:23 +05:30
Occassionally GitLab needs to change the GraphQL API in a way that is not backwards-compatible.
These changes include the removal or renaming of fields, arguments or other parts of the schema.
2020-11-24 15:15:51 +05:30
2021-04-17 20:07:23 +05:30
In these situations, GitLab follows a [Deprecation and removal process ](#deprecation-and-removal-process )
where the deprecated part of the schema is supported for a period of time before being removed.
2020-11-24 15:15:51 +05:30
2021-04-17 20:07:23 +05:30
Clients should familiarize themselves with the process to avoid breaking changes affecting their integrations.
2020-11-24 15:15:51 +05:30
2021-03-08 18:12:59 +05:30
NOTE:
Fields behind a feature flag and disabled by default are exempt from the deprecation process,
and can be removed at any time without notice.
2021-04-17 20:07:23 +05:30
### Deprecation and Removal process
Parts of the schema marked for removal from the GitLab GraphQL API are first **deprecated** but still available
for at least six releases, and then **removed entirely** .
Removals occur at `X.0` and `X.6` releases.
The process is as follows:
1. The item is marked as deprecated in the schema. It will be displayed as deprecated in the
[GraphQL API Reference ](reference/index.md ) and in introspection queries.
1. Removals are announced at least one release prior in the [Deprecations ](https://about.gitlab.com/handbook/marketing/blog/release-posts/#deprecations )
section of the release post (at or prior to `X.11` and `X.5` releases).
release post (at or prior to `X.11` and `X.5` releases).
1. Items meeting criteria are removed in `X.0` or `X.6` and added to:
- The [Removals ](https://about.gitlab.com/handbook/marketing/blog/release-posts/#removals ) section of the Release Post.
- The [Removed items page ](removed_items.md ).
This gives consumers of the GraphQL API a minimum of six months to update their GraphQL queries.
When an item is deprecated or removed, an alternative is provided if available.
**Example:**
A field marked as deprecated in `12.7` can be used until its removal in `13.6` .
2021-01-29 00:20:46 +05:30
### List of removed items
View the [fields, enums, and other items we removed ](removed_items.md ) from the GraphQL API.
2018-11-08 19:23:39 +05:30
## Available queries
2020-01-01 13:55:28 +05:30
The GraphQL API includes the following queries at the root level:
2019-07-31 22:56:46 +05:30
2020-03-13 15:44:24 +05:30
1. `project` : Project information, with many of its associations such as issues and merge requests.
2019-09-30 21:07:59 +05:30
1. `group` : Basic group information and epics ** (ULTIMATE)** are currently supported.
2020-06-23 00:09:42 +05:30
1. `user` : Information about a particular user.
2019-09-04 21:01:54 +05:30
1. `namespace` : Within a namespace it is also possible to fetch `projects` .
2020-01-01 13:55:28 +05:30
1. `currentUser` : Information about the currently logged in user.
2020-06-23 00:09:42 +05:30
1. `users` : Information about a collection of users.
2020-01-01 13:55:28 +05:30
1. `metaData` : Metadata about GitLab and the GraphQL API.
1. `snippets` : Snippets visible to the currently logged in user.
2020-03-13 15:44:24 +05:30
New associations and root level objects are constantly being added.
See the [GraphQL API Reference ](reference/index.md ) for up-to-date information.
2020-01-01 13:55:28 +05:30
Root-level queries are defined in
[`app/graphql/types/query_type.rb` ](https://gitlab.com/gitlab-org/gitlab/blob/master/app/graphql/types/query_type.rb ).
2019-09-04 21:01:54 +05:30
### Multiplex queries
2019-07-31 22:56:46 +05:30
2019-09-04 21:01:54 +05:30
GitLab supports batching queries into a single request using
2019-12-21 20:55:43 +05:30
[apollo-link-batch-http ](https://www.apollographql.com/docs/link/links/batch-http/ ). More
2020-04-22 19:07:51 +05:30
information about multiplexed queries is also available for
[GraphQL Ruby ](https://graphql-ruby.org/queries/multiplex.html ), the
2019-09-04 21:01:54 +05:30
library GitLab uses on the backend.
2018-11-08 19:23:39 +05:30
2021-03-11 19:13:27 +05:30
## Limits
The following limits apply to the GitLab GraphQL API.
### Max page size
By default, connections return at most `100` records ("nodes") per page,
and this limit applies to most connections in the API. Particular connections
may have different max page size limits that are higher or lower.
### Max query complexity
The GitLab GraphQL API scores the _complexity_ of a query. Generally, larger
queries will have a higher complexity score. This limit is designed to protect
the API from performing queries that could negatively impact its overall performance.
The complexity of a single query is limited to a maximum of:
- `200` for unauthenticated requests.
- `250` for authenticated requests.
There is no way to discover the complexity of a query except by exceeding the limit.
If a query exceeds the complexity limit an error message response will
be returned.
In general, each field in a query will add `1` to the complexity score, although
this can be higher or lower for particular fields. Sometimes the addition of
certain arguments may also increase the complexity of a query.
2021-04-17 20:07:23 +05:30
NOTE:
2021-03-11 19:13:27 +05:30
The complexity limits may be revised in future, and additionally, the complexity
of a query may be altered.
### Request timeout
Requests time out at 30 seconds.
2019-09-30 21:07:59 +05:30
## Reference
2021-02-22 17:27:13 +05:30
The GitLab GraphQL reference [is available ](reference/index.md ).
2019-09-30 21:07:59 +05:30
2021-02-22 17:27:13 +05:30
It is automatically generated from the GitLab GraphQL schema and embedded in a Markdown file.
2019-09-30 21:07:59 +05:30
2020-11-24 15:15:51 +05:30
## Generate updates for documentation
If you've changed the GraphQL schema, you should set up an MR to gain approval of your changes.
To generate the required documentation and schema, follow the instructions given in the
[Rake tasks for developers ](../../development/rake_tasks.md#update-graphql-documentation-and-schema-definitions ) page.
Be sure to run these commands using the [GitLab Development Kit ](https://gitlab.com/gitlab-org/gitlab-development-kit/ ).
