GitLab

GitLab API

GitLab API endpoints from GitLab

Developer tools#openapi

Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.

Overview

GitLab API endpoints from GitLab

Endpoints 400

award_emoji

  • GETList all emoji reactions for an epic/api/v4/groups/:id/epics/:epic_iid/award_emoji?page=1&per_page=20Lists all emoji reactions for a specified epic. This endpoint can be accessed without authentication if the epic is publicly accessible.
  • POSTAdd an emoji reaction to an epic/api/v4/groups/:id/epics/:epic_iid/award_emojiAdds an emoji reaction to an epic.
  • GETRetrieve an emoji reaction from an epic/api/v4/groups/:id/epics/:epic_iid/award_emoji/:award_idRetrieves a specified emoji reaction from an epic. This endpoint can be accessed without authentication if the epic is publicly accessible.
  • DELETEDelete an emoji reaction from an epic/api/v4/groups/:id/epics/:epic_iid/award_emoji/:award_idDeletes a specified emoji reaction from an epic. Only an administrator or the user who added the reaction can delete it.
  • GETList all emoji reactions for an epic comment/api/v4/groups/:id/epics/:epic_iid/notes/:note_id/award_emoji?page=1&per_page=20Lists all emoji reactions for a specified comment on an epic. This endpoint can be accessed without authentication if the comment is publicly accessible.
  • POSTAdd an emoji reaction to an epic comment/api/v4/groups/:id/epics/:epic_iid/notes/:note_id/award_emojiAdds an emoji reaction to a comment on an epic.
  • GETRetrieve an emoji reaction from an epic comment/api/v4/groups/:id/epics/:epic_iid/notes/:note_id/award_emoji/:award_idRetrieves a specified emoji reaction from a comment on an epic. This endpoint can be accessed without authentication if the comment is publicly accessible.
  • DELETEDelete an emoji reaction from an epic comment/api/v4/groups/:id/epics/:epic_iid/notes/:note_id/award_emoji/:award_idDeletes a specified emoji reaction from a comment on an epic. Only an administrator or the user who added the reaction can delete it.
  • GETList all emoji reactions for an issue/api/v4/projects/:id/issues/:issue_iid/award_emoji?page=1&per_page=20Lists all emoji reactions for a specified issue. This endpoint can be accessed without authentication if the issue is publicly accessible.
  • POSTAdd an emoji reaction to an issue/api/v4/projects/:id/issues/:issue_iid/award_emojiAdds an emoji reaction to an issue.
  • GETRetrieve an emoji reaction from an issue/api/v4/projects/:id/issues/:issue_iid/award_emoji/:award_idRetrieves a specified emoji reaction from an issue. This endpoint can be accessed without authentication if the issue is publicly accessible.
  • DELETEDelete an emoji reaction from an issue/api/v4/projects/:id/issues/:issue_iid/award_emoji/:award_idDeletes a specified emoji reaction from an issue. Only an administrator or the user who added the reaction can delete it.
  • GETList all emoji reactions for an issue comment/api/v4/projects/:id/issues/:issue_iid/notes/:note_id/award_emoji?page=1&per_page=20Lists all emoji reactions for a specified comment on an issue. This endpoint can be accessed without authentication if the comment is publicly accessible.
  • POSTAdd an emoji reaction to an issue comment/api/v4/projects/:id/issues/:issue_iid/notes/:note_id/award_emojiAdds an emoji reaction to a comment on an issue.
  • GETRetrieve an emoji reaction from an issue comment/api/v4/projects/:id/issues/:issue_iid/notes/:note_id/award_emoji/:award_idRetrieves a specified emoji reaction from a comment on an issue. This endpoint can be accessed without authentication if the comment is publicly accessible.
  • DELETEDelete an emoji reaction from an issue comment/api/v4/projects/:id/issues/:issue_iid/notes/:note_id/award_emoji/:award_idDeletes a specified emoji reaction from a comment on an issue. Only an administrator or the user who added the reaction can delete it.
  • GETList all emoji reactions for a merge request/api/v4/projects/:id/merge_requests/:merge_request_iid/award_emoji?page=1&per_page=20Lists all emoji reactions for a specified merge request. This endpoint can be accessed without authentication if the merge request is publicly accessible.
  • POSTAdd an emoji reaction to a merge request/api/v4/projects/:id/merge_requests/:merge_request_iid/award_emojiAdds an emoji reaction to a merge request.
  • GETRetrieve an emoji reaction from a merge request/api/v4/projects/:id/merge_requests/:merge_request_iid/award_emoji/:award_idRetrieves a specified emoji reaction from a merge request. This endpoint can be accessed without authentication if the merge request is publicly accessible.
  • DELETEDelete an emoji reaction from a merge request/api/v4/projects/:id/merge_requests/:merge_request_iid/award_emoji/:award_idDeletes a specified emoji reaction from a merge request. Only an administrator or the user who added the reaction can delete it.
  • GETList all emoji reactions for a merge request comment/api/v4/projects/:id/merge_requests/:merge_request_iid/notes/:note_id/award_emoji?page=1&per_page=20Lists all emoji reactions for a specified comment on a merge request. This endpoint can be accessed without authentication if the comment is publicly…
  • POSTAdd an emoji reaction to a merge request comment/api/v4/projects/:id/merge_requests/:merge_request_iid/notes/:note_id/award_emojiAdds an emoji reaction to a comment on a merge request.
  • GETRetrieve an emoji reaction from a merge request comment/api/v4/projects/:id/merge_requests/:merge_request_iid/notes/:note_id/award_emoji/:award_idRetrieves a specified emoji reaction from a comment on a merge request. This endpoint can be accessed without authentication if the comment is publicly…
  • DELETEDelete an emoji reaction from a merge request comment/api/v4/projects/:id/merge_requests/:merge_request_iid/notes/:note_id/award_emoji/:award_idDeletes a specified emoji reaction from a comment on a merge request. Only an administrator or the user who added the reaction can delete it.
  • GETList all emoji reactions for a snippet/api/v4/projects/:id/snippets/:snippet_id/award_emoji?page=1&per_page=20Lists all emoji reactions for a specified snippet. This endpoint can be accessed without authentication if the snippet is publicly accessible.
  • POSTAdd an emoji reaction to a snippet/api/v4/projects/:id/snippets/:snippet_id/award_emojiAdds an emoji reaction to a snippet.
  • GETRetrieve an emoji reaction from a snippet/api/v4/projects/:id/snippets/:snippet_id/award_emoji/:award_idRetrieves a specified emoji reaction from a snippet. This endpoint can be accessed without authentication if the snippet is publicly accessible.
  • DELETEDelete an emoji reaction from a snippet/api/v4/projects/:id/snippets/:snippet_id/award_emoji/:award_idDeletes a specified emoji reaction from a snippet. Only an administrator or the user who added the reaction can delete it.
  • GETList all emoji reactions for a snippet comment/api/v4/projects/:id/snippets/:snippet_id/notes/:note_id/award_emoji?page=1&per_page=20Lists all emoji reactions for a specified comment on a snippet. This endpoint can be accessed without authentication if the comment is publicly accessible.
  • POSTAdd an emoji reaction to a snippet comment/api/v4/projects/:id/snippets/:snippet_id/notes/:note_id/award_emojiAdds an emoji reaction to a comment on a snippet.
  • GETRetrieve an emoji reaction from a snippet comment/api/v4/projects/:id/snippets/:snippet_id/notes/:note_id/award_emoji/:award_idRetrieves a specified emoji reaction from a comment on a snippet. This endpoint can be accessed without authentication if the comment is publicly accessible.
  • DELETEDelete an emoji reaction from a snippet comment/api/v4/projects/:id/snippets/:snippet_id/notes/:note_id/award_emoji/:award_idDeletes a specified emoji reaction from a comment on a snippet. Only an administrator or the user who added the reaction can delete it.

badges

  • GETList all badges for a group/api/v4/groups/:id/badges?page=1&per_page=20&name=stringLists all badges for a specified group.
  • POSTCreate a badge for a group/api/v4/groups/:id/badgesCreates a badge for a specified group.
  • GETRetrieve a badge preview for a group/api/v4/groups/:id/badges/render?link_url=string&image_url=stringPreviews the final link_url and image_url for a specified group after resolving the placeholder interpolation.
  • GETRetrieve a badge for a group/api/v4/groups/:id/badges/:badge_idRetrieves a specified badge for a group.
  • PUTUpdate a badge for a group/api/v4/groups/:id/badges/:badge_idUpdates a specified badge for a group.
  • DELETEDelete a badge from a group/api/v4/groups/:id/badges/:badge_idDeletes a specified badge from a group.
  • GETList all badges for a project/api/v4/projects/:id/badges?page=1&per_page=20&name=stringLists all badges for a specified project, including group badges.
  • POSTCreate a badge for a project/api/v4/projects/:id/badgesCreates a badge for a specified project.
  • GETRetrieve a badge preview for a project/api/v4/projects/:id/badges/render?link_url=string&image_url=stringPreviews the final link_url and image_url for a specified project after resolving the placeholder interpolation.
  • GETRetrieve a badge for a project/api/v4/projects/:id/badges/:badge_idRetrieves a specified badge for a project.
  • PUTUpdate a badge for a project/api/v4/projects/:id/badges/:badge_idUpdates a specified badge for a project.
  • DELETEDelete a badge from a project/api/v4/projects/:id/badges/:badge_idDeletes a specified badge from a project.

custom_attributes

  • GETList all custom attributes for a group/api/v4/groups/:id/custom_attributesLists all custom attributes for a specified group.
  • GETRetrieve a custom attribute for a group/api/v4/groups/:id/custom_attributes/:keyRetrieves a specified custom attribute for a group.
  • PUTCreates or updates a custom attribute for a group/api/v4/groups/:id/custom_attributes/:keyCreates or updates a custom attribute for a specified group. If the attribute already exists, it is updated, otherwise a new attribute is created.
  • DELETEDelete a custom attribute for a group/api/v4/groups/:id/custom_attributes/:keyDeletes a specified custom attribute for a group.
  • GETList all custom attributes for a project/api/v4/projects/:id/custom_attributesLists all custom attributes for a specified project.
  • GETRetrieve a custom attribute for a project/api/v4/projects/:id/custom_attributes/:keyRetrieves a specified custom attribute for a project.
  • PUTCreates or updates a custom attribute for a project/api/v4/projects/:id/custom_attributes/:keyCreates or updates a custom attribute for a specified project. If the attribute already exists, it is updated, otherwise a new attribute is created.
  • DELETEDelete a custom attribute for a project/api/v4/projects/:id/custom_attributes/:keyDeletes a specified custom attribute for a project.

groups

  • GETList all groups/api/v4/groups?statistics=false&archived=true&skip_groups=0&all_available=true&visibility=private&search=string&owned=false&order_by=name&sort=asc&min_access_level=10&top_level_only=true&marked_for_deletion_on=2024-01-01&active=true&repository_storage=string&page=1&per_page=20&with_custom_attributes=falseLists all visible groups for the authenticated user. Unauthenticated requests return only public groups.
  • POSTCreate a group/api/v4/groupsCreates a project group. Available only for users who can create groups.
  • GETRetrieve a group/api/v4/groups/:id?with_custom_attributes=false&with_projects=trueRetrieves a specified group by ID or path.
  • PUTUpdate group attributes/api/v4/groups/:idUpdates the attributes for a specified group. You must be an administrator or have the Owner role for the group.
  • DELETESchedule a group for deletion/api/v4/groups/:idSchedules a group for deletion. Groups are deleted at the end of the retention period (30 days by default). Use the permanently_remove param to override the…
  • POSTArchive a group/api/v4/groups/:id/archiveArchives a specified group. You must be an administrator or have the Owner role for the group.
  • POSTUnarchive a group/api/v4/groups/:id/unarchiveUnarchives a specified group. You must be an administrator or have the Owner role for the group.
  • POSTRestore a group/api/v4/groups/:id/restoreRestores a specified group that was previously scheduled for deletion. Can not restore groups outside of the retention period (30 days by default).
  • GETList all shared groups/api/v4/groups/:id/groups/shared?skip_groups=0&visibility=private&search=string&min_access_level=10&order_by=name&sort=asc&page=1&per_page=20&with_custom_attributes=falseLists all groups shared with a specified group.
  • GETList all invited groups/api/v4/groups/:id/invited_groups?relation=direct&search=string&min_access_level=10&page=1&per_page=20&with_custom_attributes=falseLists all groups invited to a specified group.
  • GETList all projects in a group/api/v4/groups/:id/projects?active=true&archived=true&visibility=private&search=string&order_by=created_at&sort=desc&simple=false&owned=false&starred=false&with_issues_enabled=false&with_merge_requests_enabled=false&with_shared=true&include_subgroups=false&include_ancestor_groups=false&min_access_level=10&page=1&per_page=20&with_custom_attributes=false&with_security_reports=falseLists all projects in a specified group accessible to the authenticated user. Unauthenticated requests return only public projects with a limited subset of…
  • GETList all shared projects/api/v4/groups/:id/projects/shared?archived=true&visibility=private&search=string&order_by=created_at&sort=desc&simple=false&starred=false&with_issues_enabled=false&with_merge_requests_enabled=false&min_access_level=10&page=1&per_page=20&with_custom_attributes=falseLists all projects shared with a specified group.
  • GETList all subgroups/api/v4/groups/:id/subgroups?statistics=false&archived=true&skip_groups=0&all_available=true&visibility=private&search=string&owned=false&order_by=name&sort=asc&min_access_level=10&top_level_only=true&marked_for_deletion_on=2024-01-01&active=true&repository_storage=string&page=1&per_page=20&with_custom_attributes=falseLists all subgroups for a specified group.
  • GETList all descendant groups/api/v4/groups/:id/descendant_groups?statistics=false&archived=true&skip_groups=0&all_available=true&visibility=private&search=string&owned=false&order_by=name&sort=asc&min_access_level=10&top_level_only=true&marked_for_deletion_on=2024-01-01&active=true&repository_storage=string&page=1&per_page=20&with_custom_attributes=falseLists all descendant groups for a specified group.
  • POSTTransfer a project to a group/api/v4/groups/:id/projects/:project_idTransfers a specified project to another group. Administrators only.
  • GETList all transfer locations for a group/api/v4/groups/:id/transfer_locations?search=string&page=1&per_page=20Lists all groups that a specified source group can be transferred to.
  • POSTTransfer a group/api/v4/groups/:id/transferTransfers a group to another parent group or transforms a subgroup into a top-level group. You must be an administrator or have the Owner role for the group.
  • POSTpostApiV4GroupsIdTransferToOrganization/api/v4/groups/:id/transfer_to_organizationTransfer a group to an organization
  • POSTAdd a group to a group/api/v4/groups/:id/shareAdds a group to a group.
  • DELETERemove a group from a group/api/v4/groups/:id/share/:group_idRemoves a group from a group.
  • DELETERemove a shared project from a group/api/v4/groups/:id/shared_projects/:project_idRemoves a shared project targeting this group. The group Owner can remove a shared project without access to the source project.
  • GETRetrieve a group audit event/api/v4/groups/:id/audit_events/:audit_event_idRetrieves an audit event for a specified group. Only available to group Owners and administrators.
  • GETList all SAML users/api/v4/groups/:id/saml_users?username=string&search=string&active=false&blocked=false&created_after=2024-01-01T00:00:00Z&created_before=2024-01-01T00:00:00Z&page=1&per_page=20Lists all SAML users for a specified top-level group. Use the page and per_page pagination parameters to filter the results.
  • GETList all provisioned users/api/v4/groups/:id/provisioned_users?username=string&search=string&active=false&blocked=false&created_after=2024-01-01T00:00:00Z&created_before=2024-01-01T00:00:00Z&page=1&per_page=20Lists all provisioned users for a specified group.
  • GETRetrieve pending reassignments/api/v4/groups/:id/placeholder_reassignmentsRetrieves a CSV file with a list of pending reassignments. This feature was introduced in GitLab 17.10.
  • POSTReassign placeholders/api/v4/groups/:id/placeholder_reassignmentsReassigns placeholder users with an uploaded CSV file.
  • POSTWorkhorse authorization for the reassignment CSV file/api/v4/groups/:id/placeholder_reassignments/authorizeAuthorizes Workhorse to handle CSV file uploads for placeholder reassignments. This feature was introduced in GitLab 17.10
  • GETList all issues for a group/api/v4/groups/:id/issues?with_labels_details=false&state=all&closed_by_id=0&order_by=created_at&sort=desc&due_date=0&issue_type=issue&labels=string&milestone=string&milestone_id=Any&iids=0&search=string&in=string&author_id=0&author_username=string&assignee_id=0&assignee_username=string&created_after=2024-01-01T00:00:00Z&created_before=2024-01-01T00:00:00Z&updated_after=2024-01-01T00:00:00Z&updated_before=2024-01-01T00:00:00Z&not[labels]=string&not[milestone]=string&not[milestone_id]=Any&not[iids]=0&not[author_id]=0&not[author_username]=string&not[assignee_id]=0&not[assignee_username]=string&not[weight]=0&not[iteration_id]=0&not[iteration_title]=string&scope=created-by-me&my_reaction_emoji=string&confidential=true&weight=0&epic_id=0&health_status=on_track&iteration_id=0&iteration_title=string&page=1&per_page=20&non_archived=trueLists all issues for a specified group. If the group is private, you must provide credentials to authorize. In most cases, you should authenticate with a…
  • GETRetrieve issues statistics for a group/api/v4/groups/:id/issues_statistics?labels=string&milestone=string&milestone_id=Any&iids=0&search=string&in=string&author_id=0&author_username=string&assignee_id=0&assignee_username=string&created_after=2024-01-01T00:00:00Z&created_before=2024-01-01T00:00:00Z&updated_after=2024-01-01T00:00:00Z&updated_before=2024-01-01T00:00:00Z&not[labels]=string&not[milestone]=string&not[milestone_id]=Any&not[iids]=0&not[author_id]=0&not[author_username]=string&not[assignee_id]=0&not[assignee_username]=string&not[weight]=0&not[iteration_id]=0&not[iteration_title]=string&scope=created-by-me&my_reaction_emoji=string&confidential=true&weight=0&epic_id=0&health_status=on_track&iteration_id=0&iteration_title=stringRetrieves statistics for issues in a specified group.
  • POSTWorkhorse authorize the file upload/api/v4/groups/:id/uploads/authorizeThis feature was introduced in GitLab 19.0
  • GETList all uploads for a group/api/v4/groups/:id/uploads?page=1&per_page=20Lists all uploads for a specified group sorted by created_at in descending order. You must have the Maintainer or Owner role for the group.
  • POSTUpload a file to a group/api/v4/groups/:id/uploadsUploads a file to the specified group. Returns a markdown-formatted link to the file.
  • GETDownload an uploaded file by ID/api/v4/groups/:id/uploads/:upload_idDownloads an uploaded file with a specified ID. You must have the Maintainer or Owner role for the group.
  • DELETEDelete an uploaded file by ID/api/v4/groups/:id/uploads/:upload_idDeletes an uploaded file with a specified ID. You must have the Maintainer or Owner role for the group.
  • GETDownload an uploaded file by secret and filename/api/v4/groups/:id/uploads/:secret/:filenameDownloads an uploaded file with a specified secret and filename. You must have the Guest, Planner, Reporter, Developer, Maintainer, or Owner role for the group.
  • DELETEDelete an uploaded file by secret and filename/api/v4/groups/:id/uploads/:secret/:filenameDeletes an uploaded file with a specified secret and filename. You must have the Maintainer or Owner role for the group.
  • GETList all billable group members/api/v4/groups/:id/billable_members?page=1&per_page=20&search=string&sort=access_level_ascLists all billable members of a specified top-level group. Includes members in any subgroups or projects. You must have the Owner role for the group.

ldap

  • POSTSync a group with LDAP/api/v4/groups/:id/ldap_syncSyncs a specified group with its linked LDAP group. You must be an administrator or have the Owner role for the group.

audit_events

  • GETList all group audit events/api/v4/groups/:id/audit_events?created_after=2016-01-19T09:05:50.355Z&created_before=2016-01-19T09:05:50.355Z&page=1&per_page=20Lists all audit events for a specified group.

keys

  • GETGet a list of Groups::SshCertificate for a Group./api/v4/groups/:id/ssh_certificates?page=1&per_page=20Lists all SSH certificates for a specified group.
  • POSTAdd a Groups::SshCertificate./api/v4/groups/:id/ssh_certificatesAdds a group SSH certificate for a specified group.
  • DELETEDelete a group SSH certificate/api/v4/groups/:id/ssh_certificates/:ssh_certificates_idDeletes a specified group SSH certificate.
  • GETRetrieve user by SSH key ID/api/v4/keys/:idRetrieves user by SSH key ID. Administrators only.
  • GETRetrieve user by SSH key fingerprint/api/v4/keys?fingerprint=ba:81:59:68:d7:6c:cd:02:02:bf:6a:9b:55:4e:af:d1Retrieves user by SSH key fingerprint. Administrators only.

runners

  • GETList all runners in a group/api/v4/groups/:id/runners?type=instance_type&paused=true&status=active&tag_list=macos,shell&version_prefix=15.1.&page=1&per_page=20Lists all runners available in a specified group and any ancestor groups, including any allowed instance runners.
  • POSTReset the runner registration token for a group/api/v4/groups/:id/runners/reset_registration_tokenResets the runner registration token for a specified group.
  • GETList project's runners/api/v4/projects/:id/runners?scope=specific&type=instance_type&paused=true&status=active&tag_list=macos,shell&version_prefix=15.1.&page=1&per_page=20List all runners available in the project, including from ancestor groups and any allowed shared runners.
  • POSTAssign a runner to a project/api/v4/projects/:id/runnersAssigns an available project runner to a project.
  • DELETEUnassign a runner from a project/api/v4/projects/:id/runners/:runner_idUnassigns a specified project runner from a project. You cannot unassign a runner from the owner project. Use the delete a runner operation instead.
  • POSTReset the runner registration token for a project/api/v4/projects/:id/runners/reset_registration_tokenResets the runner registration token for a specified project.
  • GETList available runners/api/v4/runners?scope=specific&type=instance_type&paused=true&status=active&tag_list=macos,shell&version_prefix=15.1.&page=1&per_page=20Lists all runners available to the user. For group runners, you must have the Owner role in the owner namespace.
  • GETList all runners/api/v4/runners/all?scope=specific&type=instance_type&paused=true&status=active&tag_list=macos,shell&version_prefix=15.1.&page=1&per_page=20Lists all runners in the GitLab instance (project and shared). You must have either administrator access or auditor access.
  • GETRetrieve details on a runner/api/v4/runners/:id?include_projects=trueRetrieves details of a runner. Instance runner details are available to all authenticated users through this endpoint. For groups and projects, you must have…
  • PUTUpdate details of a runner/api/v4/runners/:idUpdates a specified runner.
  • DELETEDelete a runner/api/v4/runners/:idDeletes a specified runner.
  • GETList all managers for a runner/api/v4/runners/:id/managersList all managers for a specified runner.
  • GETList runner's projects/api/v4/runners/:id/projects?page=1&per_page=20Get a paginated list of all projects associated with the specified runner. Access is restricted based on user permissions.
  • GETList all jobs processed by a runner/api/v4/runners/:id/jobs?system_id=string&status=created&order_by=id&sort=desc&cursor=string&page=1&per_page=20Lists all jobs that are being processed or were processed by a specified runner. The list of jobs is limited to projects where the user has the Reporter,…
  • POSTReset runner's authentication token/api/v4/runners/:id/reset_authentication_tokenResets the authentication token for a specified runner.
  • POSTReset the runner registration token for the instance/api/v4/runners/reset_registration_tokenResets the runner registration token for the GitLab instance.

packages_debian

  • GETThe Release file signature/api/v4/groups/:id/-/packages/debian/dists/*distribution/Release.gpg?distribution=my-distroThis feature was introduced in GitLab 13.5
  • GETThe unsigned Release file/api/v4/groups/:id/-/packages/debian/dists/*distribution/Release?distribution=my-distroThis feature was introduced in GitLab 13.5
  • GETThe signed Release file/api/v4/groups/:id/-/packages/debian/dists/*distribution/InRelease?distribution=my-distroThis feature was introduced in GitLab 13.5
  • GETThe installer (udeb) binary files index/api/v4/groups/:id/-/packages/debian/dists/*distribution/:component/debian-installer/binary-:architecture/Packages?distribution=my-distroThis feature was introduced in GitLab 15.4
  • GETThe installer (udeb) binary files index by hash/api/v4/groups/:id/-/packages/debian/dists/*distribution/:component/debian-installer/binary-:architecture/by-hash/SHA256/:file_sha256?distribution=my-distroThis feature was introduced in GitLab 15.4
  • GETThe source files index/api/v4/groups/:id/-/packages/debian/dists/*distribution/:component/source/Sources?distribution=my-distroThis feature was introduced in GitLab 15.4
  • GETThe source files index by hash/api/v4/groups/:id/-/packages/debian/dists/*distribution/:component/source/by-hash/SHA256/:file_sha256?distribution=my-distroThis feature was introduced in GitLab 15.4
  • GETThe binary files index/api/v4/groups/:id/-/packages/debian/dists/*distribution/:component/binary-:architecture/Packages?distribution=my-distroThis feature was introduced in GitLab 13.5
  • GETThe binary files index by hash/api/v4/groups/:id/-/packages/debian/dists/*distribution/:component/binary-:architecture/by-hash/SHA256/:file_sha256?distribution=my-distroThis feature was introduced in GitLab 15.4
  • GETDownload Debian package/api/v4/groups/:id/-/packages/debian/pool/:distribution/:project_id/:letter/:package_name/:package_version/:file_nameThis feature was introduced in GitLab 14.2
  • GETList all Debian group distributions/api/v4/groups/:id/-/debian_distributions?page=1&per_page=20&codename=sid&suite=unstable&origin=Grep&label=grep.be&version=12&description=My description&valid_time_duration_seconds=604800&components=main&architectures=amd64Lists all Debian distributions for a specified group.
  • POSTCreate a Debian group distribution/api/v4/groups/:id/-/debian_distributionsCreates a Debian group distribution for a specified group.
  • GETRetrieve a Debian group distribution/api/v4/groups/:id/-/debian_distributions/:codenameRetrieves a specified Debian group distribution for a group.
  • PUTUpdate a Debian group distribution/api/v4/groups/:id/-/debian_distributions/:codenameUpdates a specified Debian group distribution for a group.
  • DELETEDelete a Debian group distribution/api/v4/groups/:id/-/debian_distributions/:codename?suite=unstable&origin=Grep&label=grep.be&version=12&description=My description&valid_time_duration_seconds=604800&components=main&architectures=amd64Deletes a specified Debian group distribution for a group.
  • GETRetrieve a Debian group distribution key/api/v4/groups/:id/-/debian_distributions/:codename/key.ascRetrieves a specified Debian group distribution key for a group.
  • GETThe Release file signature/api/v4/projects/:id/packages/debian/dists/*distribution/Release.gpg?distribution=my-distroThis feature was introduced in GitLab 13.5
  • GETThe unsigned Release file/api/v4/projects/:id/packages/debian/dists/*distribution/Release?distribution=my-distroThis feature was introduced in GitLab 13.5
  • GETThe signed Release file/api/v4/projects/:id/packages/debian/dists/*distribution/InRelease?distribution=my-distroThis feature was introduced in GitLab 13.5
  • GETThe installer (udeb) binary files index/api/v4/projects/:id/packages/debian/dists/*distribution/:component/debian-installer/binary-:architecture/Packages?distribution=my-distroThis feature was introduced in GitLab 15.4
  • GETThe installer (udeb) binary files index by hash/api/v4/projects/:id/packages/debian/dists/*distribution/:component/debian-installer/binary-:architecture/by-hash/SHA256/:file_sha256?distribution=my-distroThis feature was introduced in GitLab 15.4
  • GETThe source files index/api/v4/projects/:id/packages/debian/dists/*distribution/:component/source/Sources?distribution=my-distroThis feature was introduced in GitLab 15.4
  • GETThe source files index by hash/api/v4/projects/:id/packages/debian/dists/*distribution/:component/source/by-hash/SHA256/:file_sha256?distribution=my-distroThis feature was introduced in GitLab 15.4
  • GETThe binary files index/api/v4/projects/:id/packages/debian/dists/*distribution/:component/binary-:architecture/Packages?distribution=my-distroThis feature was introduced in GitLab 13.5
  • GETThe binary files index by hash/api/v4/projects/:id/packages/debian/dists/*distribution/:component/binary-:architecture/by-hash/SHA256/:file_sha256?distribution=my-distroThis feature was introduced in GitLab 15.4
  • GETDownload a Debian package file/api/v4/projects/:id/packages/debian/pool/:distribution/:letter/:package_name/:package_version/:file_nameDownloads a specified Debian package file for a project.
  • PUTUpload a Debian package file/api/v4/projects/:id/packages/debian/:file_nameUploads a Debian package file for a specified project.
  • PUTAuthorize Debian package upload/api/v4/projects/:id/packages/debian/:file_name/authorizeThis feature was introduced in GitLab 13.5
  • GETList all Debian project distributions/api/v4/projects/:id/debian_distributions?page=1&per_page=20&codename=sid&suite=unstable&origin=Grep&label=grep.be&version=12&description=My description&valid_time_duration_seconds=604800&components=main&architectures=amd64Lists all Debian distributions for a specified project.
  • POSTCreate a Debian project distribution/api/v4/projects/:id/debian_distributionsCreates a Debian project distribution for a specified project.
  • GETRetrieve a Debian project distribution/api/v4/projects/:id/debian_distributions/:codenameRetrieves a specified Debian project distribution for a project.
  • PUTUpdate a Debian project distribution/api/v4/projects/:id/debian_distributions/:codenameUpdates a specified Debian project distribution for a project.
  • DELETEDelete a Debian project distribution/api/v4/projects/:id/debian_distributions/:codename?suite=unstable&origin=Grep&label=grep.be&version=12&description=My description&valid_time_duration_seconds=604800&components=main&architectures=amd64Deletes a specified Debian project distribution for a project.
  • GETRetrieve a Debian project distribution key/api/v4/projects/:id/debian_distributions/:codename/key.ascRetrieves a specified Debian project distribution key for a project.

deploy_resources

  • GETList all group deploy tokens/api/v4/groups/:id/deploy_tokens?page=1&per_page=20&active=trueLists all group deploy tokens.
  • POSTCreate a group deploy token/api/v4/groups/:id/deploy_tokensCreates a group deploy token.
  • GETRetrieve a group deploy token/api/v4/groups/:id/deploy_tokens/:token_idGet a single group's deploy token by ID. This feature was introduced in GitLab 14.9.
  • DELETEDelete a group deploy token/api/v4/groups/:id/deploy_tokens/:token_idDeletes a group deploy token.
  • GETList all deploy keys for project/api/v4/projects/:id/deploy_keys?page=1&per_page=20Lists all deploy keys for a specified project.
  • POSTAdd a deploy key for a project/api/v4/projects/:id/deploy_keysAdds a deploy key for a specified project. If the deploy key already exists in another project, it is joined to the current project only if the original one…
  • GETRetrieve a deploy key/api/v4/projects/:id/deploy_keys/:key_idRetrieves a specified deploy key.
  • PUTUpdate a deploy key/api/v4/projects/:id/deploy_keys/:key_idUpdates a deploy key for a project.
  • DELETEDelete a deploy key/api/v4/projects/:id/deploy_keys/:key_idDeletes a deploy key from the project. If the deploy key is used only for this project, it is deleted from the system.
  • POSTEnable a deploy key/api/v4/projects/:id/deploy_keys/:key_id/enableEnables a deploy key for a project so this can be used. Returns the enabled key, with a status code 201 when successful.
  • GETList all project deploy tokens/api/v4/projects/:id/deploy_tokens?page=1&per_page=20&active=trueLists all project deploy tokens.
  • POSTCreate a project deploy token/api/v4/projects/:id/deploy_tokensCreates a project deploy token.
  • GETRetrieve a project deploy token/api/v4/projects/:id/deploy_tokens/:token_idRetrieves a project deploy token.
  • DELETEDelete a project deploy token/api/v4/projects/:id/deploy_tokens/:token_idDeletes a project deploy token.
  • GETList all project deployments/api/v4/projects/:id/deployments?page=1&per_page=20&order_by=id&sort=asc&updated_after=2024-01-01T00:00:00Z&updated_before=2024-01-01T00:00:00Z&finished_after=2024-01-01T00:00:00Z&finished_before=2024-01-01T00:00:00Z&environment=string&status=createdLists all deployments in a project.
  • POSTCreate a deployment/api/v4/projects/:id/deploymentsCreates a deployment.
  • GETRetrieve a deployment/api/v4/projects/:id/deployments/:deployment_idRetrieves a specified deployment.
  • PUTUpdate a deployment/api/v4/projects/:id/deployments/:deployment_idUpdates a specified deployment.
  • DELETEDelete a deployment/api/v4/projects/:id/deployments/:deployment_idDeletes a specified deployment that is not currently the last deployment for an environment or in a running state.
  • GETList all merge requests associated with a deployment/api/v4/projects/:id/deployments/:deployment_id/merge_requests?page=1&per_page=20&author_id=0&author_username=string&assignee_id=0&assignee_username=string&reviewer_username=string&labels=string&milestone=string&my_reaction_emoji=string&reviewer_id=0&state=all&order_by=created_at&sort=desc&with_labels_details=false&with_merge_status_recheck=false&created_after=2019-03-15T08:00:00Z&created_before=2019-03-15T08:00:00Z&updated_after=2019-03-15T08:00:00Z&updated_before=2019-03-15T08:00:00Z&merged_after=2019-03-15T08:00:00Z&merged_before=2019-03-15T08:00:00Z&view=simple&scope=created-by-me&source_branch=string&source_project_id=0&target_branch=string&search=string&in=title,description&wip=yes&draft=true&not[author_id]=0&not[author_username]=string&not[assignee_id]=0&not[assignee_username]=string&not[reviewer_username]=string&not[labels]=string&not[milestone]=string&not[my_reaction_emoji]=string&not[reviewer_id]=0&deployed_before=2019-03-15T08:00:00Z&deployed_after=2019-03-15T08:00:00Z&environment=2019-03-15T08:00:00Z&merge_user_id=0&merge_user_username=stringLists all merge requests shipped with a specified deployment.
  • POSTApprove or reject a deployment/api/v4/projects/:id/deployments/:deployment_id/approvalApproves or rejects a deployment.
  • GETList all deploy keys/api/v4/deploy_keys?page=1&per_page=20&public=falseLists all deploy keys for the instance.
  • POSTCreate a deploy key/api/v4/deploy_keysCreates a deploy key for the GitLab instance. Requires administrator access.
  • GETList all deploy tokens/api/v4/deploy_tokens?page=1&per_page=20&active=trueLists all deploy tokens for the instance.

avatars

  • GETDownload a group avatar/api/v4/groups/:id/avatarDownloads a group avatar image.
  • GETDownload a project avatar/api/v4/projects/:id/avatarDownloads a project avatar. You can access this endpoint without authentication if the project is publicly accessible. This feature was introduced in GitLab…
  • GETgetApiV4Avatar/api/v4/avatar?email=string&size=0Return avatar url for a user

group_import_and_export

  • GETRetrieve a group export download/api/v4/groups/:id/export/downloadRetrieves the exported archive for a specified group.
  • POSTCreate a group export/api/v4/groups/:id/exportCreates a group export for a specified group.
  • POSTSchedule a relations export for a group/api/v4/groups/:id/export_relationsSchedules a relations export for a specified group.
  • GETDownload a relations export for a group/api/v4/groups/:id/export_relations/download?relation=string&batched=true&batch_number=0Downloads a group relations export file.
  • GETRetrieve the status of an relations export for a group/api/v4/groups/:id/export_relations/status?relation=stringRetrieves the status of a relations export for a group.
  • POSTWorkhorse authorize the group import upload/api/v4/groups/import/authorizeThis feature was introduced in GitLab 12.8
  • POSTCreate a group import/api/v4/groups/importCreates a group import. The maximum import file size can be set by the Administrator on GitLab Self-Managed (defaults to 0 (unlimited)).

packages

  • GETList all packages for a group/api/v4/groups/:id/packages?exclude_subgroups=false&page=1&per_page=20&order_by=created_at&sort=asc&package_type=maven&package_name=string&package_version=string&include_versionless=true&status=defaultLists all packages for a specified group. When accessed without authentication, only packages of public projects are returned. By default, packages with…
  • GETDownload the maven package file at a group level/api/v4/groups/:id/-/packages/maven/*path/:file_name?path=foo/bar/mypkg/1.0-SNAPSHOTThis feature was introduced in GitLab 11.7
  • PUTWorkhorse authorize generic package file/api/v4/projects/:id/packages/generic/:package_name/*package_version/(*path/):file_name/authorizeThis feature was introduced in GitLab 13.5
  • GETDownload package file/api/v4/projects/:id/packages/generic/:package_name/*package_version/(*path/):file_name?package_version=string&path=stringThis feature was introduced in GitLab 13.5
  • PUTUpload package file/api/v4/projects/:id/packages/generic/:package_name/*package_version/(*path/):file_nameThis feature was introduced in GitLab 13.5
  • GETList/api/v4/projects/:id/packages/go/*module_name/@v/list?module_name=stringGet all tagged versions for a given Go module.See go help goproxy, GET $GOPROXY/<module>/@v/list. This feature was introduced in GitLab 13.1.
  • GETVersion metadata/api/v4/projects/:id/packages/go/*module_name/@v/:module_version.info?module_name=stringGet all tagged versions for a given Go module.See go help goproxy, GET $GOPROXY/<module>/@v/<version>.info. This feature was introduced in GitLab 13.1
  • GETDownload module file/api/v4/projects/:id/packages/go/*module_name/@v/:module_version.mod?module_name=stringGet the module file of a given module version.See go help goproxy, GET $GOPROXY/<module>/@v/<version>.mod. This feature was introduced in GitLab 13.1.
  • GETDownload module source/api/v4/projects/:id/packages/go/*module_name/@v/:module_version.zip?module_name=stringGet a zip of the source of the given module version.See go help goproxy, GET $GOPROXY/<module>/@v/<version>.zip. This feature was introduced in GitLab 13.1.
  • GETDownload the maven package file at a project level/api/v4/projects/:id/packages/maven/*path/:file_name?path=foo/bar/mypkg/1.0-SNAPSHOTThis feature was introduced in GitLab 11.3
  • PUTUpload the maven package file/api/v4/projects/:id/packages/maven/*path/:file_nameThis feature was introduced in GitLab 11.3
  • PUTWorkhorse authorize the maven package file upload/api/v4/projects/:id/packages/maven/*path/:file_name/authorizeThis feature was introduced in GitLab 11.3
  • GETList all package files/api/v4/projects/:id/packages/:package_id/package_files?page=1&per_page=20&order_by=id&sort=ascLists all package files for a specified package.
  • DELETEDelete a package file/api/v4/projects/:id/packages/:package_id/package_files/:package_file_idDeletes a specified package file.
  • GETDownload a package file/api/v4/projects/:id/packages/:package_id/package_files/:package_file_id/downloadThis feature was introduced in GitLab 18.4
  • GETList all packages for a project/api/v4/projects/:id/packages?page=1&per_page=20&order_by=created_at&sort=asc&package_type=maven&package_name=string&package_version=string&include_versionless=true&status=defaultLists all packages for a specified project. All package types are included in results. Unauthenticated requests return only packages of public projects. By…
  • GETRetrieve a project package/api/v4/projects/:id/packages/:package_idRetrieves a specified project package. Only packages with status default or deprecated are returned.
  • DELETEDelete a project package/api/v4/projects/:id/packages/:package_idDeletes a specified project package.
  • GETList all package pipelines/api/v4/projects/:id/packages/:package_id/pipelines?page=1&per_page=20&cursor=stringLists all pipelines for a specified package. The results are sorted by id in descending order. The results are paginated and return up to 20 records per page.…
  • GETDownload the maven package file at instance level/api/v4/packages/maven/*path/:file_name?path=foo/bar/mypkg/1.0-SNAPSHOTThis feature was introduced in GitLab 11.6

invitations

  • GETList all pending invitations for a group/api/v4/groups/:id/invitations?page=1&per_page=20&query=stringLists all pending invitations for a specified group viewable by the authenticated user. Returns invitations to direct members only, and not through inherited…
  • POSTAdd a member to a group/api/v4/groups/:id/invitationsAdds a member to a group. You can specify a user ID or invite a user by email.
  • PUTUpdate an invitation to a group/api/v4/groups/:id/invitations/:emailUpdates a pending invitation to a group.
  • DELETEDelete an invitation to a group/api/v4/groups/:id/invitations/:emailDeletes a pending invitation to a specified email address for a group.
  • GETList all pending invitations for a project/api/v4/projects/:id/invitations?page=1&per_page=20&query=stringLists all pending invitations for a specified project viewable by the authenticated user. Returns invitations to direct members only, and not through…
  • POSTAdd a member to a project/api/v4/projects/:id/invitationsAdds a member to a project. You can specify a user ID or invite a user by email.
  • PUTUpdate an invitation to a project/api/v4/projects/:id/invitations/:emailUpdates a pending invitation to a project.
  • DELETEDelete an invitation to a project/api/v4/projects/:id/invitations/:emailDeletes a pending invitation to a specified email address for a project.

members

  • GETList all direct members of a group/api/v4/groups/:id/members?query=string&user_ids=0&skip_users=0&show_seat_info=true&with_saml_identity=true&page=1&per_page=20Lists all direct members of a specified group viewable by the authenticated user. Does not return inherited members from ancestor groups or invited groups.
  • POSTAdd a member to a group/api/v4/groups/:id/membersAdds a member to a specified group.
  • GETList all members of a group/api/v4/groups/:id/members/all?query=string&user_ids=0&show_seat_info=true&state=awaiting&page=1&per_page=20Lists all members of a specified group viewable by the authenticated user. Also returns inherited members from ancestor groups or invited groups. If a user is…
  • GETRetrieve a direct group member/api/v4/groups/:id/members/:user_idRetrieves a specified member of a group. Returns only direct members and not inherited members through ancestor groups.
  • PUTUpdate a group member/api/v4/groups/:id/members/:user_idUpdates a specified member of a group.
  • DELETERemove a member from a group/api/v4/groups/:id/members/:user_id?skip_subresources=false&unassign_issuables=falseRemoves a specified user from a group. The user must be a direct member.
  • GETRetrieve a group member/api/v4/groups/:id/members/all/:user_idRetrieves a specified member of a group. Returns direct members and members inherited or invited through ancestor groups.
  • POSTSet override flag for a member of a group/api/v4/groups/:id/members/:user_id/overrideSets the override flag for a member of a group. By default, the access level of LDAP group members is set to the value specified by LDAP through Group Sync.
  • DELETERemove an LDAP access level override/api/v4/groups/:id/members/:user_id/overrideRemoves an LDAP access level override for a member of a group.
  • PUTApprove a group member/api/v4/groups/:id/members/:member_id/approveApproves a specified pending user for a top-level group and any subgroups or projects.
  • POSTApprove all pending group members/api/v4/groups/:id/members/approve_allApproves all pending users for a specified top-level group and any subgroups or projects.
  • GETList all pending group members/api/v4/groups/:id/pending_members?page=1&per_page=20Lists all members in an awaiting state and those who are invited but do not have a GitLab account for a specified group and any subgroups and projects. This…
  • PUTUpdate group membership state for a user/api/v4/groups/:id/members/:user_id/stateUpdates the membership state for a specified user in a group.
  • GETList all memberships for a billable group member/api/v4/groups/:id/billable_members/:user_id/memberships?page=1&per_page=20Lists all memberships for a specified billable member of a group. The response represents only direct memberships. Inherited memberships are not included.
  • GETList all indirect memberships for a billable group member/api/v4/groups/:id/billable_members/:user_id/indirect?page=1&per_page=20Lists all indirect memberships for a billable member of a group. This operation works on top-level groups only. It does not work on subgroups.
  • DELETERemove a billable member from a group/api/v4/groups/:id/billable_members/:user_idRemoves a specified billable member from a group and its subgroups and projects. The user does not need to be a group member to qualify for removal. For…
  • GETList all direct members of a project/api/v4/projects/:id/members?query=string&user_ids=0&skip_users=0&show_seat_info=true&with_saml_identity=true&page=1&per_page=20Lists all direct members of a specified project viewable by the authenticated user. Does not return inherited members from ancestor groups or invited groups.
  • POSTAdd a member to a project/api/v4/projects/:id/membersAdds a member to a specified project.
  • GETList all members of a project/api/v4/projects/:id/members/all?query=string&user_ids=0&show_seat_info=true&state=awaiting&page=1&per_page=20Lists all members of a specified project viewable by the authenticated user. Also returns inherited members from ancestor groups or invited groups. If a user…
  • GETRetrieve a direct project member/api/v4/projects/:id/members/:user_idRetrieves a specified member of a project. Returns only direct members and not inherited members through ancestor groups.
  • PUTUpdate a project member/api/v4/projects/:id/members/:user_idUpdates a specified member of a project.
  • DELETERemove a member from a project/api/v4/projects/:id/members/:user_id?skip_subresources=false&unassign_issuables=falseRemoves a specified user from a project. The user must be a direct member.
  • GETRetrieve a project member/api/v4/projects/:id/members/all/:user_idRetrieves a specified member of a project. Returns direct members and members inherited or invited through ancestor groups.

packages_npm

  • GETGet all tags for a given an NPM package/api/v4/groups/:id/-/packages/npm/-/package/*package_name/dist-tags?package_name=stringThis feature was introduced in GitLab 12.7
  • PUTCreate or Update the given tag for the given NPM package and version/api/v4/groups/:id/-/packages/npm/-/package/*package_name/dist-tags/:tagThis feature was introduced in GitLab 12.7
  • DELETEDeletes the given tag/api/v4/groups/:id/-/packages/npm/-/package/*package_name/dist-tags/:tag?package_name=stringThis feature was introduced in GitLab 12.7
  • POSTNPM registry bulk advisory endpoint/api/v4/groups/:id/-/packages/npm/-/npm/v1/security/advisories/bulkThis feature was introduced in GitLab 15.6
  • POSTNPM registry quick audit endpoint/api/v4/groups/:id/-/packages/npm/-/npm/v1/security/audits/quickThis feature was introduced in GitLab 15.6
  • GETNPM registry metadata endpoint/api/v4/groups/:id/-/packages/npm/*package_name?package_name=mypackageThis feature was introduced in GitLab 11.8
  • GETGet all tags for a given an NPM package/api/v4/projects/:id/packages/npm/-/package/*package_name/dist-tags?package_name=stringThis feature was introduced in GitLab 12.7
  • PUTCreate or Update the given tag for the given NPM package and version/api/v4/projects/:id/packages/npm/-/package/*package_name/dist-tags/:tagThis feature was introduced in GitLab 12.7
  • DELETEDeletes the given tag/api/v4/projects/:id/packages/npm/-/package/*package_name/dist-tags/:tag?package_name=stringThis feature was introduced in GitLab 12.7
  • POSTNPM registry bulk advisory endpoint/api/v4/projects/:id/packages/npm/-/npm/v1/security/advisories/bulkThis feature was introduced in GitLab 15.6
  • POSTNPM registry quick audit endpoint/api/v4/projects/:id/packages/npm/-/npm/v1/security/audits/quickThis feature was introduced in GitLab 15.6
  • GETDownload the NPM tarball/api/v4/projects/:id/packages/npm/*package_name/-/*file_name?package_name=string&file_name=stringThis feature was introduced in GitLab 11.8
  • PUTCreate or deprecate an NPM package/api/v4/projects/:id/packages/npm/:package_nameCreates or deprecates an NPM package for a specified project. Deprecate support was added in GitLab 16.0.
  • GETNPM registry metadata endpoint/api/v4/projects/:id/packages/npm/*package_name?package_name=mypackageThis feature was introduced in GitLab 11.8
  • GETGet all tags for a given an NPM package/api/v4/packages/npm/-/package/*package_name/dist-tags?package_name=stringThis feature was introduced in GitLab 12.7
  • PUTCreate or Update the given tag for the given NPM package and version/api/v4/packages/npm/-/package/*package_name/dist-tags/:tagThis feature was introduced in GitLab 12.7
  • DELETEDeletes the given tag/api/v4/packages/npm/-/package/*package_name/dist-tags/:tag?package_name=stringThis feature was introduced in GitLab 12.7
  • POSTNPM registry bulk advisory endpoint/api/v4/packages/npm/-/npm/v1/security/advisories/bulkThis feature was introduced in GitLab 15.6
  • POSTNPM registry quick audit endpoint/api/v4/packages/npm/-/npm/v1/security/audits/quickThis feature was introduced in GitLab 15.6
  • GETNPM registry metadata endpoint/api/v4/packages/npm/*package_name?package_name=mypackageThis feature was introduced in GitLab 11.8

packages_nuget

  • GETThe NuGet V3 Feed Service Index/api/v4/groups/:id/-/packages/nuget/indexThis feature was introduced in GitLab 12.6
  • GETThe NuGet Symbol File Download Endpoint/api/v4/groups/:id/-/packages/nuget/symbolfiles/*file_name/*signature/*same_file_name?file_name=mynugetpkg.pdb&signature=k813f89485474661234z7109cve5709eFFFFFFFF&same_file_name=stringThis feature was introduced in GitLab 16.7
  • GETThe NuGet V2 Feed Service Index/api/v4/groups/:id/-/packages/nuget/v2This feature was introduced in GitLab 16.2
  • GETThe NuGet V2 Feed Package $metadata endpoint/api/v4/groups/:id/-/packages/nuget/v2/$metadataThis feature was introduced in GitLab 16.3
  • GETThe NuGet Metadata Service - Package name level/api/v4/groups/:id/-/packages/nuget/metadata/*package_name/index?package_name=MyNuGetPkgThis feature was introduced in GitLab 12.8
  • GETThe NuGet Metadata Service - Package name and version level/api/v4/groups/:id/-/packages/nuget/metadata/*package_name/*package_version?package_name=MyNuGetPkg&package_version=1.0.0This feature was introduced in GitLab 12.8
  • GETThe NuGet Search Service/api/v4/groups/:id/-/packages/nuget/query?q=MyNuGet&skip=1&take=1&prerelease=trueThis feature was introduced in GitLab 12.8
  • GETThe NuGet V3 Feed Service Index/api/v4/projects/:id/packages/nuget/indexThis feature was introduced in GitLab 12.6
  • GETThe NuGet Symbol File Download Endpoint/api/v4/projects/:id/packages/nuget/symbolfiles/*file_name/*signature/*same_file_name?file_name=mynugetpkg.pdb&signature=k813f89485474661234z7109cve5709eFFFFFFFF&same_file_name=stringThis feature was introduced in GitLab 16.7
  • GETThe NuGet V2 Feed Service Index/api/v4/projects/:id/packages/nuget/v2This feature was introduced in GitLab 16.2
  • PUTUpload a NuGet v2 package file for a project/api/v4/projects/:id/packages/nuget/v2Uploads a NuGet v2 package file for a specified project.
  • GETThe NuGet V2 Feed Package $metadata endpoint/api/v4/projects/:id/packages/nuget/v2/$metadataThis feature was introduced in GitLab 16.3
  • GETThe NuGet Metadata Service - Package name level/api/v4/projects/:id/packages/nuget/metadata/*package_name/index?package_name=MyNuGetPkgThis feature was introduced in GitLab 12.8
  • GETThe NuGet Metadata Service - Package name and version level/api/v4/projects/:id/packages/nuget/metadata/*package_name/*package_version?package_name=MyNuGetPkg&package_version=1.0.0This feature was introduced in GitLab 12.8
  • GETThe NuGet Search Service/api/v4/projects/:id/packages/nuget/query?q=MyNuGet&skip=1&take=1&prerelease=trueThis feature was introduced in GitLab 12.8
  • GETThe NuGet Content Service - index request/api/v4/projects/:id/packages/nuget/download/*package_name/index?package_name=mynugetpkg.1.3.0.17.nupkgThis feature was introduced in GitLab 12.8
  • GETThe NuGet Content Service - content request/api/v4/projects/:id/packages/nuget/download/*package_name/*package_version/*package_filename?package_name=mynugetpkg.1.3.0.17.nupkg&package_version=1.3.0.17&package_filename=mynugetpkg.1.3.0.17.nupkgThis feature was introduced in GitLab 12.8
  • PUTUpload a NuGet v3 package file for a project/api/v4/projects/:id/packages/nugetUploads a NuGet v3 package file for a specified project.
  • PUTThe NuGet Package Authorize endpoint/api/v4/projects/:id/packages/nuget/authorizeThis feature was introduced in GitLab 14.1
  • PUTUpload a NuGet symbol package file/api/v4/projects/:id/packages/nuget/symbolpackageUploads a specified NuGet symbol package file (.snupkg) for a project.
  • PUTThe NuGet Symbol Package Authorize endpoint/api/v4/projects/:id/packages/nuget/symbolpackage/authorizeThis feature was introduced in GitLab 14.1
  • DELETEThe NuGet Package Delete endpoint/api/v4/projects/:id/packages/nuget/*package_name/*package_version?package_name=mynugetpkg&package_version=1.0.1This feature was introduced in GitLab 16.5
  • PUTThe NuGet V2 Feed Package Authorize endpoint/api/v4/projects/:id/packages/nuget/v2/authorizeThis feature was introduced in GitLab 16.2
  • GETThe NuGet V2 Feed Find Packages by ID endpoint/api/v4/projects/:project_id/packages/nuget/v2/FindPackagesById\(\)?id=mynugetpkgThis feature was introduced in GitLab 16.4
  • GETThe NuGet V2 Feed Enumerate Packages endpoint/api/v4/projects/:project_id/packages/nuget/v2/Packages\(\)?$filter=mynugetpkgThis feature was introduced in GitLab 16.4
  • GETThe NuGet V2 Feed Single Package Metadata endpoint/api/v4/projects/:project_id/packages/nuget/v2/Packages\(Id='*package_name',Version='*package_version'\)?package_name=mynugetpkg&package_version=1.3.0.17This feature was introduced in GitLab 16.4

packages_pypi

  • GETDownload a package file from a group/api/v4/groups/:id/-/packages/pypi/files/:sha256/*file_identifier?file_identifier=my.pypi.package-0.0.1.tar.gzThis feature was introduced in GitLab 13.12
  • GETList all packages for a group/api/v4/groups/:id/-/packages/pypi/simpleLists all packages for a specified group in an HTML file.
  • GETThe PyPi Simple Group Package Endpoint/api/v4/groups/:id/-/packages/pypi/simple/*package_name?package_name=my.pypi.packageThis feature was introduced in GitLab 12.10
  • GETThe PyPi package download endpoint/api/v4/projects/:id/packages/pypi/files/:sha256/*file_identifier?file_identifier=my.pypi.package-0.0.1.tar.gzThis feature was introduced in GitLab 12.10
  • GETDownload a forwarded (proxied) PyPI package file/api/v4/projects/:id/packages/pypi/forward/:package_name/*upstream_path?upstream_path=stringEnforces the Dependency Firewall then redirects to the upstream artifact.
  • GETList all packages for a project/api/v4/projects/:id/packages/pypi/simpleLists all packages for a specified project in an HTML file.
  • GETThe PyPi Simple Project Package Endpoint/api/v4/projects/:id/packages/pypi/simple/*package_name?package_name=my.pypi.packageThis feature was introduced in GitLab 12.10
  • POSTUpload a package/api/v4/projects/:id/packages/pypiUploads a PyPI package for a specified project.
  • POSTAuthorize the PyPi package upload from workhorse/api/v4/projects/:id/packages/pypi/authorizeThis feature was introduced in GitLab 12.10

access_tokens

  • POSTRotate a group access token/api/v4/groups/:id/access_tokens/self/rotateRotates a group access token by passing it to the API in a header.
  • POSTRotate a project access token/api/v4/projects/:id/access_tokens/self/rotateRotates a project access token by passing it to the API in a header.
  • GETRetrieve a personal access token/api/v4/personal_access_tokens/selfRetrieves a specified personal access token by passing it to the API in a header.
  • DELETERevoke a personal access token/api/v4/personal_access_tokens/selfRevokes a personal access token by passing it to the API in a header.
  • GETList all token associations/api/v4/personal_access_tokens/self/associations?min_access_level=10&page=1&per_page=20Lists all groups and projects accessible by the personal access token used to authenticate the request. Generally, this includes any groups or projects that…
  • POSTRotate a personal access token/api/v4/personal_access_tokens/self/rotateRotates a personal access token by passing it to the API in a header
  • GETList all personal access tokens/api/v4/personal_access_tokens?user_id=2&revoked=true&state=active&created_before=2022-01-01T00:00:00Z&created_after=2021-01-01T00:00:00Z&last_used_before=2021-01-01T00:00:00Z&last_used_after=2022-01-01T00:00:00Z&expires_before=2022-01-01&expires_after=2021-01-01&search=token&sort=created_at_desc&page=1&per_page=20Lists all personal access tokens accessible by the authenticated user. For administrators, returns all personal access tokens in the instance. For…
  • GETRetrieve a personal access token/api/v4/personal_access_tokens/:idRetrieves details for a specified personal access token. Administrators can retrieve details on any token. Non-administrators can only retrieve details on…
  • DELETERevoke a personal access token/api/v4/personal_access_tokens/:idRevokes a specified personal access token. Administrators can revoke tokens for any user. Non-administrators can only revoke their own tokens.
  • POSTRotate a personal access token/api/v4/personal_access_tokens/:id/rotateRotates a specified personal access token. This revokes the previous token and creates a token that expires after one week. Administrators can revoke tokens…

search

  • GETSearch on GitLab within a group/api/v4/groups/:id/(-/)search?search=string&scope=wiki_blobs&state=all&confidential=true&type=string&include_archived=false&fields=title&exclude_forks=true&num_context_lines=0&regex=true&page=1&per_page=20This feature was introduced in GitLab 10.5.
  • GETSearch a project/api/v4/projects/:id/(-/)search?search=string&scope=issues&ref=string&state=all&confidential=true&type=string&fields=title&num_context_lines=0&regex=true&page=1&per_page=20Searches for content in a specified project.
  • GETSearch an instance/api/v4/search?search=string&scope=wiki_blobs&state=all&confidential=true&type=string&include_archived=false&fields=title&exclude_forks=true&num_context_lines=0&regex=true&page=1&per_page=20Searches for a term across the entire GitLab instance. The response depends on the requested scope.

wikis

  • GETList all wiki pages for a group/api/v4/groups/:id/wikis?with_content=falseLists all wiki pages for a specified group.

Showing 300 of 400 endpoints. Fork the collection to see all of them.

API details

Base URL
https://gitlab.com
Authentication
An API key in the PRIVATE-TOKEN header
An API key in the private_token query parameter
Operations
1151 operations on 898 pathsGET 508PUT 263POST 243DELETE 125PATCH 9HEAD 3
3 marked deprecated
Main resources
integrations 168projects 76packages_conan 59groups 41packages_debian 34award_emoji 32merge_requests 32packages_nuget 26deploy_resources 24members 23
Response formats
application/json
Description format
Swagger 2.0, API version v4

How to test the GitLab API in Swastik Codes

  1. Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
  2. Fork it into your workspaceChoose a workspace. You get your own copy of the GitLab API collection, without the publisher's secrets.
  3. Add your credentialsThis API uses an API key in the PRIVATE-TOKEN header. Add yours in the collection's variables or an environment; the requests already reference it.
  4. Send a requestPick an endpoint, for example “List all emoji reactions for an epic” (GET /api/v4/groups/:id/epics/:epic_iid/award_emoji?page=1&per_page=20), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the GitLab API?

GitLab API endpoints from GitLab It is listed under Developer tools and has 1151 endpoints.

Who publishes the GitLab API?

It is listed from GitLab's public API description (an OpenAPI document), not published by GitLab on Swastik Codes. Anyone who controls gitlab.com can claim the profile by adding a DNS TXT record.

What is the base URL of the GitLab API?

Requests go to https://gitlab.com. Endpoint paths are added to this base URL.

How do I authenticate with the GitLab API?

It accepts 2 methods: an API key in the PRIVATE-TOKEN header; an API key in the private_token query parameter.

How many endpoints does the GitLab API have?

1151 operations on 898 paths (508 GET, 263 PUT, 243 POST, 125 DELETE, 9 PATCH, 3 HEAD). The largest groups are integrations, projects, packages_conan, groups. This listing's collection holds the first 400.

Is forking the GitLab API free?

Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.

Suggest an API

Tell us which public API is missing. We check it, then add it here with its endpoints when it has an OpenAPI (Swagger) description.