GitLab API

www.gitlab.com

Community

An OpenAPI definition for the GitLab REST API. Few API resources or endpoints are currently included. The intent is to expand this to match the entire Markdown documentation of the API: . Contributions are welcome. When viewing this on gitlab.com, you can test API calls directly from the browser against the `gitlab.com` instance, if you are logged in. The feature uses the current [GitLab session cookie](https://docs.gitlab.

Auth

api_key

Pricing

free

Spec version

1.0

Base URL

https://www.gitlab.com/api/v4

Last verified

2026-03-01 11:55:30

Health

Loading health data...

Capabilities

access_requests

Manage access requests — requests access for the authenticated user to a group, requests access for the authenticated user to a project, approves an access request for the given user. Supports standard CRUD operations through the REST API.

Detail: https://www.gitlab.com/api/v4/capabilities/access_requests

admin

Manage admin — retrieve dictionary details. Supports standard CRUD operations through the REST API.

Detail: https://www.gitlab.com/api/v4/capabilities/admin

alert_management

Manage alert management — upload a metric image for an alert, workhorse authorize metric image file upload, update a metric image for an alert. Supports standard CRUD operations through the REST API.

Detail: https://www.gitlab.com/api/v4/capabilities/alert_management

applications

Manage applications — create a new application, get applications, delete an application. Supports standard CRUD operations through the REST API.

Detail: https://www.gitlab.com/api/v4/capabilities/applications

avatar

Manage avatar — return avatar url for a user. Supports standard CRUD operations through the REST API.

Detail: https://www.gitlab.com/api/v4/capabilities/avatar

badges

Manage badges — adds a badge to a group, adds a badge to a project, updates a badge of a group. Supports standard CRUD operations through the REST API.

Detail: https://www.gitlab.com/api/v4/capabilities/badges

batched_background_migrations

Manage batched background migrations — resume a batched background migration, pause a batched background migration, get the list of batched background migrations. Supports standard CRUD operations through the REST API.

Detail: https://www.gitlab.com/api/v4/capabilities/batched_background_migrations

branches

Manage branches — create branch, unprotect a single branch, protect a single branch. Supports standard CRUD operations through the REST API.

Detail: https://www.gitlab.com/api/v4/capabilities/branches

broadcast_messages

Manage broadcast messages — create a broadcast message, update a broadcast message, get all broadcast messages. Supports standard CRUD operations through the REST API.

Detail: https://www.gitlab.com/api/v4/capabilities/broadcast_messages

clusters

Manage clusters — add existing instance cluster, edit instance cluster, list instance clusters. Supports standard CRUD operations through the REST API.

Detail: https://www.gitlab.com/api/v4/capabilities/clusters

migrations

Manage migrations — mark the migration as successfully executed. Supports standard CRUD operations through the REST API.

Detail: https://www.gitlab.com/api/v4/capabilities/migrations

pipeline_composition

Manage pipeline composition — create a new instance-level variable, update an instance-level variable, list all instance-level variables. Supports standard CRUD operations through the REST API.

Detail: https://www.gitlab.com/api/v4/capabilities/pipeline_composition

Agent Preview

This is what an AI agent sees when it discovers this service via the Gateway:

Service: GitLab API
Description: An OpenAPI definition for the GitLab REST API.
Few API resources or endpoints are currently included.
The intent is to expand this to match the entire Markdown documentation of the API:
. Contributions are welcome.

When viewing this on gitlab.com, you can test API calls directly from the browser
against the `gitlab.com` instance, if you are logged in.
The feature uses the current [GitLab session cookie](https://docs.gitlab.
Auth: api_key
Capabilities:
  - access_requests: Manage access requests — requests access for the authenticated user to a group, requests access for the authenticated user to a project, approves an access request for the given user. Supports standard CRUD operations through the REST API.
  - admin: Manage admin — retrieve dictionary details. Supports standard CRUD operations through the REST API.
  - alert_management: Manage alert management — upload a metric image for an alert, workhorse authorize metric image file upload, update a metric image for an alert. Supports standard CRUD operations through the REST API.
  - applications: Manage applications — create a new application, get applications, delete an application. Supports standard CRUD operations through the REST API.
  - avatar: Manage avatar — return avatar url for a user. Supports standard CRUD operations through the REST API.
  - badges: Manage badges — adds a badge to a group, adds a badge to a project, updates a badge of a group. Supports standard CRUD operations through the REST API.
  - batched_background_migrations: Manage batched background migrations — resume a batched background migration, pause a batched background migration, get the list of batched background migrations. Supports standard CRUD operations through the REST API.
  - branches: Manage branches — create branch, unprotect a single branch, protect a single branch. Supports standard CRUD operations through the REST API.
  - broadcast_messages: Manage broadcast messages — create a broadcast message, update a broadcast message, get all broadcast messages. Supports standard CRUD operations through the REST API.
  - clusters: Manage clusters — add existing instance cluster, edit instance cluster, list instance clusters. Supports standard CRUD operations through the REST API.
  - migrations: Manage migrations — mark the migration as successfully executed. Supports standard CRUD operations through the REST API.
  - pipeline_composition: Manage pipeline composition — create a new instance-level variable, update an instance-level variable, list all instance-level variables. Supports standard CRUD operations through the REST API.