19 KiB
19 KiB
| stage | group | info |
|---|---|---|
| Ecosystem | Integrations | 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 |
REST API resources (FREE)
Available resources for the GitLab REST API can be grouped in the following contexts:
See also:
Project resources
The following API resources are available in the project context:
| Resource | Available endpoints |
|---|---|
| Access requests | /projects/:id/access_requests (also available for groups) |
| Access tokens | /projects/:id/access_tokens (also available for groups) |
| Award emoji | /projects/:id/issues/.../award_emoji, /projects/:id/merge_requests/.../award_emoji, /projects/:id/snippets/.../award_emoji |
| Branches | /projects/:id/repository/branches/, /projects/:id/repository/merged_branches |
| Commits | /projects/:id/repository/commits, /projects/:id/statuses |
| Container Registry | /projects/:id/registry/repositories |
| Custom attributes | /projects/:id/custom_attributes (also available for groups and users) |
| Debian distributions | /projects/:id/debian_distributions (also available for groups) |
| Dependencies (ULTIMATE) | /projects/:id/dependencies |
| Deploy keys | /projects/:id/deploy_keys (also available standalone) |
| Deploy tokens | /projects/:id/deploy_tokens (also available for groups and standalone) |
| Deployments | /projects/:id/deployments |
| Discussions (threaded comments) | /projects/:id/issues/.../discussions, /projects/:id/snippets/.../discussions, /projects/:id/merge_requests/.../discussions, /projects/:id/commits/.../discussions (also available for groups) |
| Environments | /projects/:id/environments |
| Error Tracking | /projects/:id/error_tracking/settings |
| Events | /projects/:id/events (also available for users and standalone) |
| Feature Flag User Lists | /projects/:id/feature_flags_user_lists |
| Feature Flags | /projects/:id/feature_flags |
| Freeze Periods | /projects/:id/freeze_periods |
| Integrations (Formerly "services") | /projects/:id/integrations |
| Invitations | /projects/:id/invitations (also available for groups) |
| Issue boards | /projects/:id/boards |
| Issue links | /projects/:id/issues/.../links |
| Issues Statistics | /projects/:id/issues_statistics (also available for groups and standalone) |
| Issues | /projects/:id/issues (also available for groups and standalone) |
| Iterations (PREMIUM) | /projects/:id/iterations (also available for groups) |
| Jobs | /projects/:id/jobs, /projects/:id/pipelines/.../jobs |
| Labels | /projects/:id/labels |
| Managed licenses (ULTIMATE) | /projects/:id/managed_licenses |
| Members | /projects/:id/members (also available for groups) |
| Merge request approvals (PREMIUM) | /projects/:id/approvals, /projects/:id/merge_requests/.../approvals |
| Merge requests | /projects/:id/merge_requests (also available for groups and standalone) |
| Merge trains | /projects/:id/merge_trains |
| Notes (comments) | /projects/:id/issues/.../notes, /projects/:id/snippets/.../notes, /projects/:id/merge_requests/.../notes (also available for groups) |
| Notification settings | /projects/:id/notification_settings (also available for groups and standalone) |
| Packages | /projects/:id/packages |
| Pages domains | /projects/:id/pages (also available standalone) |
| Pipeline schedules | /projects/:id/pipeline_schedules |
| Pipeline triggers | /projects/:id/triggers |
| Pipelines | /projects/:id/pipelines |
| Project badges | /projects/:id/badges |
| Project clusters | /projects/:id/clusters |
| Project import/export | /projects/:id/export, /projects/import, /projects/:id/import |
| Project milestones | /projects/:id/milestones |
| Project snippets | /projects/:id/snippets |
| Project templates | /projects/:id/templates |
| Project vulnerabilities (ULTIMATE) | /projects/:id/templates |
| Project wikis | /projects/:id/wikis |
| Project-level variables | /projects/:id/variables |
| Projects including setting Webhooks | /projects, /projects/:id/hooks (also available for users) |
| Protected branches | /projects/:id/protected_branches |
| Protected environments | /projects/:id/protected_environments |
| Protected tags | /projects/:id/protected_tags |
| Release links | /projects/:id/releases/.../assets/links |
| Releases | /projects/:id/releases |
| Remote mirrors | /projects/:id/remote_mirrors |
| Repositories | /projects/:id/repository |
| Repository files | /projects/:id/repository/files |
| Repository submodules | /projects/:id/repository/submodules |
| Resource label events | /projects/:id/issues/.../resource_label_events, /projects/:id/merge_requests/.../resource_label_events (also available for groups) |
| Runners | /projects/:id/runners (also available standalone) |
| Search | /projects/:id/search (also available for groups and standalone) |
| Tags | /projects/:id/repository/tags |
| User-starred metrics dashboards | /projects/:id/metrics/user_starred_dashboards |
| Visual Review discussions (PREMIUM) | /projects/:id/merge_requests/:merge_request_id/visual_review_discussions |
| Vulnerabilities (ULTIMATE) | /vulnerabilities/:id |
| Vulnerability exports (ULTIMATE) | /projects/:id/vulnerability_exports |
| Vulnerability findings (ULTIMATE) | /projects/:id/vulnerability_findings |
Group resources
The following API resources are available in the group context:
| Resource | Available endpoints |
|---|---|
| Access requests | /groups/:id/access_requests/ (also available for projects) |
| Access tokens | /groups/:id/access_tokens (also available for projects) |
| Custom attributes | /groups/:id/custom_attributes (also available for projects and users) |
| Debian distributions | /groups/:id/-/packages/debian (also available for projects) |
| Deploy tokens | /groups/:id/deploy_tokens (also available for projects and standalone) |
| Discussions (threaded comments) (ULTIMATE) | /groups/:id/epics/.../discussions (also available for projects) |
| Epic issues (ULTIMATE) | /groups/:id/epics/.../issues |
| Epic links (ULTIMATE) | /groups/:id/epics/.../epics |
| Epics (ULTIMATE) | /groups/:id/epics |
| Groups | /groups, /groups/.../subgroups |
| Group badges | /groups/:id/badges |
| Group issue boards | /groups/:id/boards |
| Group iterations (PREMIUM) | /groups/:id/iterations (also available for projects) |
| Group labels | /groups/:id/labels |
| Group-level variables | /groups/:id/variables |
| Group milestones | /groups/:id/milestones |
| Group wikis (PREMIUM) | /groups/:id/wikis |
| Invitations | /groups/:id/invitations (also available for projects) |
| Issues | /groups/:id/issues (also available for projects and standalone) |
| Issues Statistics | /groups/:id/issues_statistics (also available for projects and standalone) |
| Linked epics | /groups/:id/epics/.../related_epics |
| Members | /groups/:id/members (also available for projects) |
| Merge requests | /groups/:id/merge_requests (also available for projects and standalone) |
| Notes (comments) | /groups/:id/epics/.../notes (also available for projects) |
| Notification settings | /groups/:id/notification_settings (also available for projects and standalone) |
| Resource label events | /groups/:id/epics/.../resource_label_events (also available for projects) |
| Search | /groups/:id/search (also available for projects and standalone) |
Standalone resources
The following API resources are available outside of project and group contexts (including /users):
| Resource | Available endpoints |
|---|---|
| Appearance (FREE SELF) | /application/appearance |
| Applications | /applications |
| Audit Events (PREMIUM SELF) | /audit_events |
| Avatar | /avatar |
| Broadcast messages | /broadcast_messages |
| Code snippets | /snippets |
| Custom attributes | /users/:id/custom_attributes (also available for groups and projects) |
| Deploy keys | /deploy_keys (also available for projects) |
| Deploy tokens | /deploy_tokens (also available for projects and groups) |
| Events | /events, /users/:id/events (also available for projects) |
| Feature flags | /features |
| Geo Nodes (PREMIUM SELF) | /geo_nodes |
| Group Activity Analytics | /analytics/group_activity/{issues_count} |
| Group repository storage moves (PREMIUM SELF) | /group_repository_storage_moves |
| Import repository from GitHub | /import/github |
| Instance clusters (FREE SELF) | /admin/clusters |
| Instance-level CI/CD variables (FREE SELF) | /admin/ci/variables |
| Issues Statistics | /issues_statistics (also available for groups and projects) |
| Issues | /issues (also available for groups and projects) |
| Jobs | /job |
| Keys | /keys |
| License (FREE SELF) | /license |
| Markdown | /markdown |
| Merge requests | /merge_requests (also available for groups and projects) |
| Metrics dashboard annotations | /environments/:id/metrics_dashboard/annotations, /clusters/:id/metrics_dashboard/annotations |
| Namespaces | /namespaces |
| Notification settings | /notification_settings (also available for groups and projects) |
| Pages domains | /pages/domains (also available for projects) |
| Personal access tokens | /personal_access_tokens |
| Plan limits | /application/plan_limits |
| Project repository storage moves (FREE SELF) | /project_repository_storage_moves |
| Projects | /users/:id/projects (also available for projects) |
| Runners | /runners (also available for projects) |
| Search | /search (also available for groups and projects) |
| Service Data | /usage_data (For GitLab instance Administrator users only) |
| Settings (FREE SELF) | /application/settings |
| Sidekiq metrics (FREE SELF) | /sidekiq |
| Sidekiq queues administration (FREE SELF) | /admin/sidekiq/queues/:queue_name |
| Snippet repository storage moves (FREE SELF) | /snippet_repository_storage_moves |
| Statistics | /application/statistics |
| Suggestions | /suggestions |
| System hooks | /hooks |
| To-dos | /todos |
| Topics | /topics |
| Users | /users |
Validate .gitlab-ci.yml file |
/lint |
| Version | /version |
Templates API resources
Endpoints are available for: