27 KiB
27 KiB
API resources
Available resources for the GitLab 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) |
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) |
Dependencies (ULTIMATE) | /projects/:id/dependencies |
Deploy keys | /projects/:id/deploy_keys (also available standalone) |
Freeze Periods | /projects/:id/freeze_periods |
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 Flags | /projects/:id/feature_flags |
Feature Flag User Lists | /projects/:id/feature_flags_user_lists |
Issues | /projects/:id/issues (also available for groups and standalone) |
Issues Statistics | /projects/:id/issues_statistics (also available for groups and standalone) |
Issue boards | /projects/:id/boards |
Issue links (STARTER) | /projects/:id/issues/.../links |
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 (STARTER) | /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) |
Pipelines | /projects/:id/pipelines |
Pipeline schedules | /projects/:id/pipeline_schedules |
Pipeline triggers | /projects/:id/triggers |
Projects including setting Webhooks | /projects , /projects/:id/hooks (also available for users) |
Project badges | /projects/:id/badges |
Project clusters | /projects/:id/clusters |
Project-level variables | /projects/:id/variables |
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 |
Protected environments | /projects/:id/protected_environments |
Protected branches | /projects/:id/protected_branches |
Protected tags | /projects/:id/protected_tags |
Releases | /projects/:id/releases |
Release links | /projects/:id/releases/.../assets/links |
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) |
Services | /projects/:id/services |
Tags | /projects/:id/repository/tags |
User-starred metrics dashboards | /projects/:id/metrics/user_starred_dashboards |
Visual Review discussions (STARTER) | /projects/:id/merge_requests/:merge_request_id/visual_review_discussions |
Vulnerabilities (ULTIMATE) | /vulnerabilities/:id |
Vulnerability exports (ULTIMATE) | /projects/:id/vulnerability_exports |
Project vulnerabilities (ULTIMATE) | /projects/:id/vulnerabilities |
Vulnerability findings (ULTIMATE) | /projects/:id/vulnerability_findings |
Project wikis | /projects/:id/wikis |
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) |
Custom attributes | /groups/:id/custom_attributes (also available for projects and users) |
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 labels | /groups/:id/labels |
Group-level variables | /groups/:id/variables |
Group milestones | /groups/:id/milestones |
Issues | /groups/:id/issues (also available for projects and standalone) |
Issues Statistics | /groups/:id/issues_statistics (also available for projects and standalone) |
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) |
Group wikis (PREMIUM) | /groups/:id/wikis |
Standalone resources
The following API resources are available outside of project and group contexts (including /users
):
Resource | Available endpoints |
---|---|
Instance-level CI/CD variables | /admin/ci/variables |
Sidekiq queues administration (CORE ONLY) | /admin/sidekiq/queues/:queue_name |
Appearance (CORE ONLY) | /application/appearance |
Applications | /applications |
Audit Events (PREMIUM ONLY) | /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) |
Events | /events , /users/:id/events (also available for projects) |
Feature flags | /features |
Geo Nodes (PREMIUM ONLY) | /geo_nodes |
Group Activity Analytics (STARTER) | `/analytics/group_activity/{issues_count |
Import repository from GitHub | /import/github |
Instance clusters | /admin/clusters |
Issues | /issues (also available for groups and projects) |
Issues Statistics | /issues_statistics (also available for groups and projects) |
Keys | /keys |
License (CORE ONLY) | /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 |
Projects | /users/:id/projects (also available for projects) |
Project repository storage moves (CORE ONLY) | /project_repository_storage_moves |
Runners | /runners (also available for projects) |
Search | /search (also available for groups and projects) |
Settings (CORE ONLY) | /application/settings |
Statistics | /application/statistics |
Sidekiq metrics (CORE ONLY) | /sidekiq |
Suggestions | /suggestions |
System hooks | /hooks |
To-dos | /todos |
Users | /users |
Validate .gitlab-ci.yml file |
/lint |
Version | /version |
Templates API resources
Endpoints are available for: