2020-10-26 17:08:22 -04:00
---
stage: none
group: unassigned
2020-11-26 01:09:20 -05:00
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
2020-10-26 17:08:22 -04:00
---
2019-08-07 22:58:29 -04:00
# API resources
Available resources for the [GitLab API ](README.md ) can be grouped in the following contexts:
- [Projects ](#project-resources ).
- [Groups ](#group-resources ).
- [Standalone ](#standalone-resources ).
See also:
- [V3 to V4 ](v3_to_v4.md ).
2020-09-28 02:09:56 -04:00
- Adding [deploy keys for multiple projects ](deploy_keys.md#adding-deploy-keys-to-multiple-projects ).
2019-08-07 22:58:29 -04:00
- [API Resources for various templates ](#templates-api-resources ).
## Project resources
The following API resources are available in the project context:
| Resource | Available endpoints |
|:--------------------------------------------------------------------|:------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| [Access requests ](access_requests.md ) | `/projects/:id/access_requests` (also available for groups) |
2021-01-29 16:09:34 -05:00
| [Access tokens ](resource_access_tokens.md ) | `/projects/:id/access_tokens` |
2019-08-07 22:58:29 -04:00
| [Award emoji ](award_emoji.md ) | `/projects/:id/issues/.../award_emoji` , `/projects/:id/merge_requests/.../award_emoji` , `/projects/:id/snippets/.../award_emoji` |
| [Branches ](branches.md ) | `/projects/:id/repository/branches/` , `/projects/:id/repository/merged_branches` |
| [Commits ](commits.md ) | `/projects/:id/repository/commits` , `/projects/:id/statuses` |
| [Container Registry ](container_registry.md ) | `/projects/:id/registry/repositories` |
| [Custom attributes ](custom_attributes.md ) | `/projects/:id/custom_attributes` (also available for groups and users) |
2019-10-24 05:06:18 -04:00
| [Dependencies ](dependencies.md ) ** (ULTIMATE)** | `/projects/:id/dependencies` |
2019-08-07 22:58:29 -04:00
| [Deploy keys ](deploy_keys.md ) | `/projects/:id/deploy_keys` (also available standalone) |
2020-05-15 23:08:23 -04:00
| [Freeze Periods ](freeze_periods.md ) | `/projects/:id/freeze_periods` |
2019-08-07 22:58:29 -04:00
| [Deployments ](deployments.md ) | `/projects/:id/deployments` |
| [Discussions ](discussions.md ) (threaded comments) | `/projects/:id/issues/.../discussions` , `/projects/:id/snippets/.../discussions` , `/projects/:id/merge_requests/.../discussions` , `/projects/:id/commits/.../discussions` (also available for groups) |
| [Environments ](environments.md ) | `/projects/:id/environments` |
2020-01-13 16:07:39 -05:00
| [Error Tracking ](error_tracking.md ) | `/projects/:id/error_tracking/settings` |
2019-08-07 22:58:29 -04:00
| [Events ](events.md ) | `/projects/:id/events` (also available for users and standalone) |
2020-04-21 11:21:10 -04:00
| [Feature Flags ](feature_flags.md ) | `/projects/:id/feature_flags` |
| [Feature Flag User Lists ](feature_flag_user_lists.md ) | `/projects/:id/feature_flags_user_lists` |
2020-11-04 19:09:16 -05:00
| [Invitations ](invitations.md ) | `/projects/:id/invitations` (also available for groups) |
2019-08-07 22:58:29 -04:00
| [Issues ](issues.md ) | `/projects/:id/issues` (also available for groups and standalone) |
| [Issues Statistics ](issues_statistics.md ) | `/projects/:id/issues_statistics` (also available for groups and standalone) |
| [Issue boards ](boards.md ) | `/projects/:id/boards` |
| [Issue links ](issue_links.md ) ** (STARTER)** | `/projects/:id/issues/.../links` |
2020-10-16 20:08:46 -04:00
| [Iterations ](iterations.md ) ** (STARTER)** | `/projects/:id/iterations` (also available for groups) |
2019-08-07 22:58:29 -04:00
| [Jobs ](jobs.md ) | `/projects/:id/jobs` , `/projects/:id/pipelines/.../jobs` |
| [Labels ](labels.md ) | `/projects/:id/labels` |
| [Managed licenses ](managed_licenses.md ) ** (ULTIMATE)** | `/projects/:id/managed_licenses` |
| [Members ](members.md ) | `/projects/:id/members` (also available for groups) |
| [Merge request approvals ](merge_request_approvals.md ) ** (STARTER)** | `/projects/:id/approvals` , `/projects/:id/merge_requests/.../approvals` |
| [Merge requests ](merge_requests.md ) | `/projects/:id/merge_requests` (also available for groups and standalone) |
2020-09-06 20:08:51 -04:00
| [Merge trains ](merge_trains.md ) | `/projects/:id/merge_trains` |
2019-08-07 22:58:29 -04:00
| [Notes ](notes.md ) (comments) | `/projects/:id/issues/.../notes` , `/projects/:id/snippets/.../notes` , `/projects/:id/merge_requests/.../notes` (also available for groups) |
| [Notification settings ](notification_settings.md ) | `/projects/:id/notification_settings` (also available for groups and standalone) |
2020-07-21 14:09:45 -04:00
| [Packages ](packages.md ) | `/projects/:id/packages` |
2019-08-07 22:58:29 -04:00
| [Pages domains ](pages_domains.md ) | `/projects/:id/pages` (also available standalone) |
| [Pipelines ](pipelines.md ) | `/projects/:id/pipelines` |
| [Pipeline schedules ](pipeline_schedules.md ) | `/projects/:id/pipeline_schedules` |
| [Pipeline triggers ](pipeline_triggers.md ) | `/projects/:id/triggers` |
| [Projects ](projects.md ) including setting Webhooks | `/projects` , `/projects/:id/hooks` (also available for users) |
| [Project badges ](project_badges.md ) | `/projects/:id/badges` |
| [Project clusters ](project_clusters.md ) | `/projects/:id/clusters` |
| [Project-level variables ](project_level_variables.md ) | `/projects/:id/variables` |
| [Project import/export ](project_import_export.md ) | `/projects/:id/export` , `/projects/import` , `/projects/:id/import` |
| [Project milestones ](milestones.md ) | `/projects/:id/milestones` |
| [Project snippets ](project_snippets.md ) | `/projects/:id/snippets` |
| [Project templates ](project_templates.md ) | `/projects/:id/templates` |
2020-04-21 11:21:10 -04:00
| [Protected environments ](protected_environments.md ) | `/projects/:id/protected_environments` |
2019-08-07 22:58:29 -04:00
| [Protected branches ](protected_branches.md ) | `/projects/:id/protected_branches` |
| [Protected tags ](protected_tags.md ) | `/projects/:id/protected_tags` |
| [Releases ](releases/index.md ) | `/projects/:id/releases` |
| [Release links ](releases/links.md ) | `/projects/:id/releases/.../assets/links` |
2020-03-06 16:07:59 -05:00
| [Remote mirrors ](remote_mirrors.md ) | `/projects/:id/remote_mirrors` |
2019-08-07 22:58:29 -04:00
| [Repositories ](repositories.md ) | `/projects/:id/repository` |
| [Repository files ](repository_files.md ) | `/projects/:id/repository/files` |
2021-01-29 16:09:34 -05:00
| [Repository submodules ](repository_submodules.md ) | `/projects/:id/repository/submodules` |
2019-08-07 22:58:29 -04:00
| [Resource label events ](resource_label_events.md ) | `/projects/:id/issues/.../resource_label_events` , `/projects/:id/merge_requests/.../resource_label_events` (also available for groups) |
| [Runners ](runners.md ) | `/projects/:id/runners` (also available standalone) |
| [Search ](search.md ) | `/projects/:id/search` (also available for groups and standalone) |
| [Services ](services.md ) | `/projects/:id/services` |
| [Tags ](tags.md ) | `/projects/:id/repository/tags` |
2020-05-13 14:08:47 -04:00
| [User-starred metrics dashboards ](metrics_user_starred_dashboards.md ) | `/projects/:id/metrics/user_starred_dashboards` |
2020-04-21 11:21:10 -04:00
| [Visual Review discussions ](visual_review_discussions.md ) ** (STARTER)** | `/projects/:id/merge_requests/:merge_request_id/visual_review_discussions` |
2020-04-09 14:09:34 -04:00
| [Vulnerabilities ](vulnerabilities.md ) ** (ULTIMATE)** | `/vulnerabilities/:id` |
| [Vulnerability exports ](vulnerability_exports.md ) ** (ULTIMATE)** | `/projects/:id/vulnerability_exports` |
| [Project vulnerabilities ](project_vulnerabilities.md ) ** (ULTIMATE)** | `/projects/:id/vulnerabilities` |
| [Vulnerability findings ](vulnerability_findings.md ) ** (ULTIMATE)** | `/projects/:id/vulnerability_findings` |
2020-10-16 11:08:46 -04:00
| [Project wikis ](wikis.md ) | `/projects/:id/wikis` |
2019-08-07 22:58:29 -04:00
## Group resources
The following API resources are available in the group context:
| Resource | Available endpoints |
|:-----------------------------------------------------------------|:---------------------------------------------------------------------------------|
| [Access requests ](access_requests.md ) | `/groups/:id/access_requests/` (also available for projects) |
| [Custom attributes ](custom_attributes.md ) | `/groups/:id/custom_attributes` (also available for projects and users) |
| [Discussions ](discussions.md ) (threaded comments) ** (ULTIMATE)** | `/groups/:id/epics/.../discussions` (also available for projects) |
| [Epic issues ](epic_issues.md ) ** (ULTIMATE)** | `/groups/:id/epics/.../issues` |
| [Epic links ](epic_links.md ) ** (ULTIMATE)** | `/groups/:id/epics/.../epics` |
| [Epics ](epics.md ) ** (ULTIMATE)** | `/groups/:id/epics` |
| [Groups ](groups.md ) | `/groups` , `/groups/.../subgroups` |
| [Group badges ](group_badges.md ) | `/groups/:id/badges` |
| [Group issue boards ](group_boards.md ) | `/groups/:id/boards` |
2020-10-16 20:08:46 -04:00
| [Group iterations ](group_iterations.md ) ** (STARTER)** | `/groups/:id/iterations` (also available for projects) |
2019-08-07 22:58:29 -04:00
| [Group labels ](group_labels.md ) | `/groups/:id/labels` |
| [Group-level variables ](group_level_variables.md ) | `/groups/:id/variables` |
| [Group milestones ](group_milestones.md ) | `/groups/:id/milestones` |
2020-11-04 19:09:16 -05:00
| [Invitations ](invitations.md ) | `/groups/:id/invitations` (also available for projects) |
2019-08-07 22:58:29 -04:00
| [Issues ](issues.md ) | `/groups/:id/issues` (also available for projects and standalone) |
| [Issues Statistics ](issues_statistics.md ) | `/groups/:id/issues_statistics` (also available for projects and standalone) |
| [Members ](members.md ) | `/groups/:id/members` (also available for projects) |
| [Merge requests ](merge_requests.md ) | `/groups/:id/merge_requests` (also available for projects and standalone) |
| [Notes ](notes.md ) (comments) | `/groups/:id/epics/.../notes` (also available for projects) |
| [Notification settings ](notification_settings.md ) | `/groups/:id/notification_settings` (also available for projects and standalone) |
| [Resource label events ](resource_label_events.md ) | `/groups/:id/epics/.../resource_label_events` (also available for projects) |
| [Search ](search.md ) | `/groups/:id/search` (also available for projects and standalone) |
2020-10-16 11:08:46 -04:00
| [Group wikis ](group_wikis.md ) ** (PREMIUM)** | `/groups/:id/wikis` |
2019-08-07 22:58:29 -04:00
## Standalone resources
The following API resources are available outside of project and group contexts (including `/users` ):
2020-03-03 10:08:08 -05:00
| Resource | Available endpoints |
|:---------------------------------------------------|:------------------------------------------------------------------------|
2020-05-15 11:08:04 -04:00
| [Instance-level CI/CD variables ](instance_level_ci_variables.md ) | `/admin/ci/variables` |
2021-01-28 01:08:59 -05:00
| [Sidekiq queues administration ](admin_sidekiq_queues.md ) ** (FREE SELF)** | `/admin/sidekiq/queues/:queue_name` |
| [Appearance ](appearance.md ) ** (FREE SELF)** | `/application/appearance` |
2020-03-03 10:08:08 -05:00
| [Applications ](applications.md ) | `/applications` |
2021-01-28 07:09:54 -05:00
| [Audit Events ](audit_events.md ) ** (PREMIUM SELF)** | `/audit_events` |
2020-03-03 10:08:08 -05:00
| [Avatar ](avatar.md ) | `/avatar` |
| [Broadcast messages ](broadcast_messages.md ) | `/broadcast_messages` |
| [Code snippets ](snippets.md ) | `/snippets` |
| [Custom attributes ](custom_attributes.md ) | `/users/:id/custom_attributes` (also available for groups and projects) |
| [Deploy keys ](deploy_keys.md ) | `/deploy_keys` (also available for projects) |
| [Events ](events.md ) | `/events` , `/users/:id/events` (also available for projects) |
| [Feature flags ](features.md ) | `/features` |
2021-01-28 07:09:54 -05:00
| [Geo Nodes ](geo_nodes.md ) ** (PREMIUM SELF)** | `/geo_nodes` |
2020-04-03 05:09:31 -04:00
| [Group Activity Analytics ](group_activity_analytics.md ) ** (STARTER)** | `/analytics/group_activity/{issues_count | merge_requests_count | new_members_count }` |
2020-03-03 10:08:08 -05:00
| [Import repository from GitHub ](import.md ) | `/import/github` |
2020-07-16 20:09:37 -04:00
| [Instance clusters ](instance_clusters.md ) | `/admin/clusters` |
2020-03-03 10:08:08 -05:00
| [Issues ](issues.md ) | `/issues` (also available for groups and projects) |
| [Issues Statistics ](issues_statistics.md ) | `/issues_statistics` (also available for groups and projects) |
| [Keys ](keys.md ) | `/keys` |
2021-01-28 01:08:59 -05:00
| [License ](license.md ) ** (FREE SELF)** | `/license` |
2020-03-03 10:08:08 -05:00
| [Markdown ](markdown.md ) | `/markdown` |
| [Merge requests ](merge_requests.md ) | `/merge_requests` (also available for groups and projects) |
2020-04-22 17:10:00 -04:00
| [Metrics dashboard annotations ](metrics_dashboard_annotations.md ) | `/environments/:id/metrics_dashboard/annotations` , `/clusters/:id/metrics_dashboard/annotations` |
2020-03-03 10:08:08 -05:00
| [Namespaces ](namespaces.md ) | `/namespaces` |
| [Notification settings ](notification_settings.md ) | `/notification_settings` (also available for groups and projects) |
| [Pages domains ](pages_domains.md ) | `/pages/domains` (also available for projects) |
2020-08-06 17:10:15 -04:00
| [Personal access tokens ](personal_access_tokens.md ) | `/personal_access_tokens` |
2020-03-03 10:08:08 -05:00
| [Projects ](projects.md ) | `/users/:id/projects` (also available for projects) |
2021-01-28 01:08:59 -05:00
| [Project repository storage moves ](project_repository_storage_moves.md ) ** (FREE SELF)** | `/project_repository_storage_moves` |
2020-03-03 10:08:08 -05:00
| [Runners ](runners.md ) | `/runners` (also available for projects) |
| [Search ](search.md ) | `/search` (also available for groups and projects) |
2021-01-28 01:08:59 -05:00
| [Settings ](settings.md ) ** (FREE SELF)** | `/application/settings` |
| [Snippet repository storage moves ](snippet_repository_storage_moves.md ) ** (FREE SELF)** | `/snippet_repository_storage_moves` |
2020-03-03 10:08:08 -05:00
| [Statistics ](statistics.md ) | `/application/statistics` |
2021-01-28 01:08:59 -05:00
| [Sidekiq metrics ](sidekiq_metrics.md ) ** (FREE SELF)** | `/sidekiq` |
2020-03-03 10:08:08 -05:00
| [Suggestions ](suggestions.md ) | `/suggestions` |
| [System hooks ](system_hooks.md ) | `/hooks` |
2020-09-16 11:09:32 -04:00
| [To-dos ](todos.md ) | `/todos` |
2020-03-03 10:08:08 -05:00
| [Users ](users.md ) | `/users` |
| [Validate `.gitlab-ci.yml` file ](lint.md ) | `/lint` |
| [Version ](version.md ) | `/version` |
2019-08-07 22:58:29 -04:00
## Templates API resources
Endpoints are available for:
- [Dockerfile templates ](templates/dockerfiles.md ).
- [`.gitignore` templates ](templates/gitignores.md ).
2020-03-26 23:07:56 -04:00
- [GitLab CI/CD YAML templates ](templates/gitlab_ci_ymls.md ).
2019-08-07 22:58:29 -04:00
- [Open source license templates ](templates/licenses.md ).
