# GitLab API ## Description This is version `v4` of this API documentation. Last update on Aug 25, 2025. 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.com/ee/api/#session-cookie), so each request is made using your account. Instructions for using this tool can be found in [Interactive API Documentation](https://docs.gitlab.com/ee/api/openapi/openapi_interactive.html) ## Servers - https://www.gitlab.com/api/v4: https://www.gitlab.com/api/v4 () ## Authentication ## Topics - [Bump.sh integration](https://bump.sh/demo/doc/gitlab/topic/topic-bump-sh-integration.md) ## Endpoints and operations ### [badges](https://bump.sh/demo/doc/gitlab/group/endpoint-badges.md) - [Gets a badge of a group.](https://bump.sh/demo/doc/gitlab/operation/operation-getapiv4groupsidbadgesbadgeid.md) - [Updates a badge of a group.](https://bump.sh/demo/doc/gitlab/operation/operation-putapiv4groupsidbadgesbadgeid.md) - [Removes a badge from the group.](https://bump.sh/demo/doc/gitlab/operation/operation-deleteapiv4groupsidbadgesbadgeid.md) - [Gets a list of group badges viewable by the authenticated user.](https://bump.sh/demo/doc/gitlab/operation/operation-getapiv4groupsidbadges.md) - [Adds a badge to a group.](https://bump.sh/demo/doc/gitlab/operation/operation-postapiv4groupsidbadges.md) - [Preview a badge from a group.](https://bump.sh/demo/doc/gitlab/operation/operation-getapiv4groupsidbadgesrender.md) - [Gets a badge of a project.](https://bump.sh/demo/doc/gitlab/operation/operation-getapiv4projectsidbadgesbadgeid.md) - [Updates a badge of a project.](https://bump.sh/demo/doc/gitlab/operation/operation-putapiv4projectsidbadgesbadgeid.md) - [Removes a badge from the project.](https://bump.sh/demo/doc/gitlab/operation/operation-deleteapiv4projectsidbadgesbadgeid.md) - [Gets a list of project badges viewable by the authenticated user.](https://bump.sh/demo/doc/gitlab/operation/operation-getapiv4projectsidbadges.md) - [Adds a badge to a project.](https://bump.sh/demo/doc/gitlab/operation/operation-postapiv4projectsidbadges.md) - [Preview a badge from a project.](https://bump.sh/demo/doc/gitlab/operation/operation-getapiv4projectsidbadgesrender.md) ### [branches](https://bump.sh/demo/doc/gitlab/group/endpoint-branches.md) - [Delete all merged branches](https://bump.sh/demo/doc/gitlab/operation/operation-deleteapiv4projectsidrepositorymergedbranches.md) - [Get a single repository branch](https://bump.sh/demo/doc/gitlab/operation/operation-getapiv4projectsidrepositorybranchesbranch.md) - [Delete a branch](https://bump.sh/demo/doc/gitlab/operation/operation-deleteapiv4projectsidrepositorybranchesbranch.md) - [Check if a branch exists](https://bump.sh/demo/doc/gitlab/operation/operation-headapiv4projectsidrepositorybranchesbranch.md) - [Get a project repository branches](https://bump.sh/demo/doc/gitlab/operation/operation-getapiv4projectsidrepositorybranches.md) - [Create branch](https://bump.sh/demo/doc/gitlab/operation/operation-postapiv4projectsidrepositorybranches.md) - [Unprotect a single branch](https://bump.sh/demo/doc/gitlab/operation/operation-putapiv4projectsidrepositorybranchesbranchunprotect.md) - [Protect a single branch](https://bump.sh/demo/doc/gitlab/operation/operation-putapiv4projectsidrepositorybranchesbranchprotect.md) ### [alert_management](https://bump.sh/demo/doc/gitlab/group/endpoint-alert_management.md) - [Update a metric image for an alert](https://bump.sh/demo/doc/gitlab/operation/operation-putapiv4projectsidalertmanagementalertsalertiidmetricimagesmetricimageid.md) - [Remove a metric image for an alert](https://bump.sh/demo/doc/gitlab/operation/operation-deleteapiv4projectsidalertmanagementalertsalertiidmetricimagesmetricimageid.md) - [Metric Images for alert](https://bump.sh/demo/doc/gitlab/operation/operation-getapiv4projectsidalertmanagementalertsalertiidmetricimages.md) - [Upload a metric image for an alert](https://bump.sh/demo/doc/gitlab/operation/operation-postapiv4projectsidalertmanagementalertsalertiidmetricimages.md) - [Workhorse authorize metric image file upload](https://bump.sh/demo/doc/gitlab/operation/operation-postapiv4projectsidalertmanagementalertsalertiidmetricimagesauthorize.md) ### [batched_background_migrations](https://bump.sh/demo/doc/gitlab/group/endpoint-batched_background_migrations.md) - [Retrieve a batched background migration](https://bump.sh/demo/doc/gitlab/operation/operation-getapiv4adminbatchedbackgroundmigrationsid.md) - [Get the list of batched background migrations](https://bump.sh/demo/doc/gitlab/operation/operation-getapiv4adminbatchedbackgroundmigrations.md) - [Resume a batched background migration](https://bump.sh/demo/doc/gitlab/operation/operation-putapiv4adminbatchedbackgroundmigrationsidresume.md) - [Pause a batched background migration](https://bump.sh/demo/doc/gitlab/operation/operation-putapiv4adminbatchedbackgroundmigrationsidpause.md) ### [admin](https://bump.sh/demo/doc/gitlab/group/endpoint-admin.md) - [Retrieve dictionary details](https://bump.sh/demo/doc/gitlab/operation/operation-getapiv4admindatabasesdatabasenamedictionarytablestablename.md) ### [migrations](https://bump.sh/demo/doc/gitlab/group/endpoint-migrations.md) - [Mark the migration as successfully executed](https://bump.sh/demo/doc/gitlab/operation/operation-postapiv4adminmigrationstimestampmark.md) ### [applications](https://bump.sh/demo/doc/gitlab/group/endpoint-applications.md) - [Delete an application](https://bump.sh/demo/doc/gitlab/operation/operation-deleteapiv4applicationsid.md) - [Get applications](https://bump.sh/demo/doc/gitlab/operation/operation-getapiv4applications.md) - [Create a new application](https://bump.sh/demo/doc/gitlab/operation/operation-postapiv4applications.md) ### [avatar](https://bump.sh/demo/doc/gitlab/group/endpoint-avatar.md) - [Return avatar url for a user](https://bump.sh/demo/doc/gitlab/operation/operation-getapiv4avatar.md) ### [broadcast_messages](https://bump.sh/demo/doc/gitlab/group/endpoint-broadcast_messages.md) - [Get a specific broadcast message](https://bump.sh/demo/doc/gitlab/operation/operation-getapiv4broadcastmessagesid.md) - [Update a broadcast message](https://bump.sh/demo/doc/gitlab/operation/operation-putapiv4broadcastmessagesid.md) - [Delete a broadcast message](https://bump.sh/demo/doc/gitlab/operation/operation-deleteapiv4broadcastmessagesid.md) - [Get all broadcast messages](https://bump.sh/demo/doc/gitlab/operation/operation-getapiv4broadcastmessages.md) - [Create a broadcast message](https://bump.sh/demo/doc/gitlab/operation/operation-postapiv4broadcastmessages.md) ### [bulk_imports](https://bump.sh/demo/doc/gitlab/group/endpoint-bulk_imports.md) - [Get GitLab Migration entity details](https://bump.sh/demo/doc/gitlab/operation/operation-getapiv4bulkimportsimportidentitiesentityid.md) - [List GitLab Migration entities](https://bump.sh/demo/doc/gitlab/operation/operation-getapiv4bulkimportsimportidentities.md) - [Get GitLab Migration details](https://bump.sh/demo/doc/gitlab/operation/operation-getapiv4bulkimportsimportid.md) - [List all GitLab Migrations' entities](https://bump.sh/demo/doc/gitlab/operation/operation-getapiv4bulkimportsentities.md) - [List all GitLab Migrations](https://bump.sh/demo/doc/gitlab/operation/operation-getapiv4bulkimports.md) - [Start a new GitLab Migration](https://bump.sh/demo/doc/gitlab/operation/operation-postapiv4bulkimports.md) ### [application](https://bump.sh/demo/doc/gitlab/group/endpoint-application.md) - [Get the current appearance](https://bump.sh/demo/doc/gitlab/operation/operation-getapiv4applicationappearance.md) - [Modify appearance](https://bump.sh/demo/doc/gitlab/operation/operation-putapiv4applicationappearance.md) ### [access_requests](https://bump.sh/demo/doc/gitlab/group/endpoint-access_requests.md) - [Denies an access request for the given user.](https://bump.sh/demo/doc/gitlab/operation/operation-deleteapiv4groupsidaccessrequestsuserid.md) - [Approves an access request for the given user.](https://bump.sh/demo/doc/gitlab/operation/operation-putapiv4groupsidaccessrequestsuseridapprove.md) - [Gets a list of access requests for a group.](https://bump.sh/demo/doc/gitlab/operation/operation-getapiv4groupsidaccessrequests.md) - [Requests access for the authenticated user to a group.](https://bump.sh/demo/doc/gitlab/operation/operation-postapiv4groupsidaccessrequests.md) - [Denies an access request for the given user.](https://bump.sh/demo/doc/gitlab/operation/operation-deleteapiv4projectsidaccessrequestsuserid.md) - [Approves an access request for the given user.](https://bump.sh/demo/doc/gitlab/operation/operation-putapiv4projectsidaccessrequestsuseridapprove.md) - [Gets a list of access requests for a project.](https://bump.sh/demo/doc/gitlab/operation/operation-getapiv4projectsidaccessrequests.md) - [Requests access for the authenticated user to a project.](https://bump.sh/demo/doc/gitlab/operation/operation-postapiv4projectsidaccessrequests.md) ### [ci_variables](https://bump.sh/demo/doc/gitlab/group/endpoint-ci_variables.md) - [Get the details of a specific instance-level variable](https://bump.sh/demo/doc/gitlab/operation/operation-getapiv4admincivariableskey.md) - [Update an instance-level variable](https://bump.sh/demo/doc/gitlab/operation/operation-putapiv4admincivariableskey.md) - [Delete an existing instance-level variable](https://bump.sh/demo/doc/gitlab/operation/operation-deleteapiv4admincivariableskey.md) - [List all instance-level variables](https://bump.sh/demo/doc/gitlab/operation/operation-getapiv4admincivariables.md) - [Create a new instance-level variable](https://bump.sh/demo/doc/gitlab/operation/operation-postapiv4admincivariables.md) ### [clusters](https://bump.sh/demo/doc/gitlab/group/endpoint-clusters.md) - [Get a single instance cluster](https://bump.sh/demo/doc/gitlab/operation/operation-getapiv4adminclustersclusterid.md) - [Edit instance cluster](https://bump.sh/demo/doc/gitlab/operation/operation-putapiv4adminclustersclusterid.md) - [Delete instance cluster](https://bump.sh/demo/doc/gitlab/operation/operation-deleteapiv4adminclustersclusterid.md) - [Add existing instance cluster](https://bump.sh/demo/doc/gitlab/operation/operation-postapiv4adminclustersadd.md) - [List instance clusters](https://bump.sh/demo/doc/gitlab/operation/operation-getapiv4adminclusters.md) ### [jobs](https://bump.sh/demo/doc/gitlab/group/endpoint-jobs.md) - [List jobs for a project](https://bump.sh/demo/doc/gitlab/operation/operation-listprojectjobs.md) - [Get a single job by ID](https://bump.sh/demo/doc/gitlab/operation/operation-getsinglejob.md) - [Run a manual job](https://bump.sh/demo/doc/gitlab/operation/operation-triggermanualjob.md) ### [metadata](https://bump.sh/demo/doc/gitlab/group/endpoint-metadata.md) - [Retrieve metadata information for this GitLab instance](https://bump.sh/demo/doc/gitlab/operation/operation-getapiv4metadata.md) - [Retrieves version information for the GitLab instance](https://bump.sh/demo/doc/gitlab/operation/operation-getapiv4version.md) ### [plan_limits](https://bump.sh/demo/doc/gitlab/group/endpoint-plan_limits.md) - [Get current plan limits](https://bump.sh/demo/doc/gitlab/operation/operation-getapiv4applicationplanlimits.md) - [Change plan limits](https://bump.sh/demo/doc/gitlab/operation/operation-putapiv4applicationplanlimits.md) [Powered by Bump.sh](https://bump.sh)