REST API 资源

极狐GitLab REST API 的可用资源可以在以下上下文中进行分组:

请参见:

项目资源

以下 API 资源在项目上下文中可用:

资源 可用端点
访问请求 /projects/:id/access_requests(群组同样可用)
访问令牌 /projects/:id/access_tokens(群组同样可用)
代理 /projects/:id/cluster_agents
分支 /projects/:id/repository/branches/, /projects/:id/repository/merged_branches
提交 /projects/:id/repository/commits, /projects/:id/statuses
容器镜像库 /projects/:id/registry/repositories
自定义属性 /projects/:id/custom_attributes(群组和用户同样可用)
Composer 发行版 /projects/:id/packages/composer (群组同样可用)
Conan 发行版 /projects/:id/packages/conan (独立式部署同样可用)
Debian 发行版 /projects/:id/debian_distributions(群组同样可用)
Debian 软件包 /projects/:id/packages/debian (群组同样可用)
依赖项 /projects/:id/dependencies
部署密钥 /projects/:id/deploy_keys(独立式部署同样可用)
部署令牌 /projects/:id/deploy_tokens(群组和独立式部署同样可用)
部署 /projects/:id/deployments
讨论(主题模式评论) /projects/:id/issues/.../discussions, /projects/:id/snippets/.../discussions, /projects/:id/merge_requests/.../discussions, /projects/:id/commits/.../discussions(群组同样可用)
备注草稿(评论) /projects/:id/merge_requests/.../draft_notes
表情符号反应 /projects/:id/issues/.../award_emoji/projects/:id/merge_requests/.../award_emoji/projects/:id/snippets/.../award_emoji
环境 /projects/:id/environments
错误跟踪 /projects/:id/error_tracking/settings
事件 /projects/:id/events(用户和独立式部署同样可用)
功能标志用户列表 /projects/:id/feature_flags_user_lists
功能标志 /projects/:id/feature_flags
冻结周期 /projects/:id/freeze_periods
Go proxy /projects/:id/packages/go
Helm 仓库 /projects/:id/packages/helm_repository
集成(曾名为”服务”) /projects/:id/integrations
邀请 /projects/:id/invitations(群组同样可用)
议题板 /projects/:id/boards
议题链接 /projects/:id/issues/.../links
议题统计 /projects/:id/issues_statistics(群组和独立式部署同样可用)
议题 /projects/:id/issues(群组和独立式部署同样可用)
迭代 /projects/:id/iterations(群组同样可用)
项目 CI/CD 作业令牌范围 /projects/:id/job_token_scope
作业 /projects/:id/jobs, /projects/:id/pipelines/.../jobs
作业产物 /projects/:id/jobs/:job_id/artifacts
标记 /projects/:id/labels
管理许可证 /projects/:id/managed_licenses
Maven 仓库 /projects/:id/packages/maven(群组和独立式部署同样可用)
成员 /projects/:id/members(群组同样可用)
合并请求审批 /projects/:id/approvals, /projects/:id/merge_requests/.../approvals
合并请求 /projects/:id/merge_requests(群组和独立式部署同样可用)
合并列车 /projects/:id/merge_trains
元数据 /metadata
备注(评论) /projects/:id/issues/.../notes, /projects/:id/snippets/.../notes, /projects/:id/merge_requests/.../notes (群组同样可用)
通知设置 /projects/:id/notification_settings(群组和独立式部署同样可用)
NPM 仓库 /projects/:id/packages/npm
NuGet 软件包 /projects/:id/packages/nuget (群组同样可用)
软件包 /projects/:id/packages
Pages 域 /projects/:id/pages(独立式部署同样可用)
流水线计划 /projects/:id/pipeline_schedules
流水线触发 /projects/:id/triggers
流水线 /projects/:id/pipelines
项目徽章 /projects/:id/badges
项目集群 /projects/:id/clusters
项目导入/导出 /projects/:id/export, /projects/import, /projects/:id/import
项目里程碑 /projects/:id/milestones
项目代码片段 /projects/:id/snippets
项目模板 /projects/:id/templates
项目漏洞 /projects/:id/vulnerabilities
项目 Wiki /projects/:id/wikis
项目级别变量 /projects/:id/variables
项目 包括设置网络钩子 /projects, /projects/:id/hooks(用户同样可用)
受保护分支 /projects/:id/protected_branches
受保护环境 /projects/:id/protected_environments
受保护标签 /projects/:id/protected_tags
PyPI 软件包 /projects/:id/packages/pypi (群组同样可用)
发布链接 /projects/:id/releases/.../assets/links
发布 /projects/:id/releases
远端镜像 /projects/:id/remote_mirrors
仓库 /projects/:id/repository
仓库文件 /projects/:id/repository/files
仓库子模块 /projects/:id/repository/submodules
资源标记事件 /projects/:id/issues/.../resource_label_events, /projects/:id/merge_requests/.../resource_label_events (群组同样可用)
Ruby gems /projects/:id/packages/rubygems
Runner /projects/:id/runners(独立式部署同样可用)
搜索 /projects/:id/search(群组和独立式部署同样可用)
标签 /projects/:id/repository/tags
Terraform 模块 /projects/:id/packages/terraform/modules (独立式部署同样可用)
用户星标的指标仪表板 /projects/:id/metrics/user_starred_dashboards
可见评审讨论 /projects/:id/merge_requests/:merge_request_id/visual_review_discussions
漏洞 /vulnerabilities/:id
漏洞导出 /projects/:id/vulnerability_exports
漏洞发现 /projects/:id/vulnerability_findings

群组资源

以下 API 资源在群组上下文中可用:

资源 可用端点
访问请求 /groups/:id/access_requests/(项目同样可用)
访问令牌 /groups/:id/access_tokens(项目同样可用)
自定义属性 /groups/:id/custom_attributes(项目和用户同样可用)
Debian 发行版 /groups/:id/-/packages/debian(项目同样可用)
部署令牌 /groups/:id/deploy_tokens(项目和独立式部署同样可用)
讨论(评论和主题) /groups/:id/epics/.../discussions(项目同样可用)
史诗议题 /groups/:id/epics/.../issues
史诗链接 /groups/:id/epics/.../epics
史诗 /groups/:id/epics
群组 /groups, /groups/.../subgroups
群组徽章 /groups/:id/badges
群组议题板 /groups/:id/boards
群组迭代 /groups/:id/iterations(项目同样可用)
群组标记 /groups/:id/labels
群组级别的变量 /groups/:id/variables
群组里程碑 /groups/:id/milestones
群组发布 /groups/:id/releases
群组 Wiki /groups/:id/wikis
邀请 /groups/:id/invitations(项目同样可用)
议题 /groups/:id/issues(项目和独立式部署同样可用)
议题统计 /groups/:id/issues_statistics(项目和独立式部署同样可用)
链接史诗 /groups/:id/epics/.../related_epics
成员角色 /groups/:id/member_roles
成员 /groups/:id/members(项目同样可用)
合并请求 /groups/:id/merge_requests(项目和独立式部署同样可用)
备注(评论) /groups/:id/epics/.../notes(项目同样可用)
通知设置 /groups/:id/notification_settings(项目和独立式部署同样可用)
资源标记事件 /groups/:id/epics/.../resource_label_events(项目同样可用)
搜索 /groups/:id/search(项目和独立式部署同样可用)

独立式资源

以下 API 资源在项目和群组上下文之外(包括/users)可用:

资源 可用端点
外观 /application/appearance
应用 /applications
审计事件 /audit_events
头像 /avatar
广播消息 /broadcast_messages
代码片段 /snippets
自定义属性 /users/:id/custom_attributes(群组和项目同样可用)
部署密钥 /deploy_keys(项目同样可用)
部署令牌 /deploy_tokens(群组和项目同样可用)
事件 /events, /users/:id/events (项目同样可用)
功能标志 /features
Geo 节点 /geo_nodes
群组活动分析 /analytics/group_activity/{issues_count}
群组仓库存储移动 /group_repository_storage_moves
从 GitHub 导入仓库 /import/github
从 Bitbucket Server 导入仓库 /import/bitbucket_server
实例集群 /admin/clusters
实例级别的 CI/CD 变量 /admin/ci/variables
议题统计 /issues_statistics(群组和项目同样可用)
议题 /issues(群组和项目同样可用)
作业 /job
密钥 /keys
许可证 /license
Markdown /markdown
合并请求 /merge_requests(群组和项目同样可用)
指标仪表板注释 /environments/:id/metrics_dashboard/annotations, /clusters/:id/metrics_dashboard/annotations
命名空间 /namespaces
通知设置 /notification_settings(群组和项目同样可用)
Pages 域 /pages/domains (项目同样可用)
个人访问令牌 /personal_access_tokens
计划限制 /application/plan_limits
项目仓库存储移动 /project_repository_storage_moves
项目 /users/:id/projects(项目同样可用)
Runner /runners(项目同样可用)
搜索 /search(群组和项目同样可用)
服务数据 /usage_data(仅对极狐GitLab 实例管理员用户可用)
设置 /application/settings
Sidekiq 指标 /sidekiq
Sidekiq 队列管理 /admin/sidekiq/queues/:queue_name
代码片段仓库存储移动 /snippet_repository_storage_moves
统计 /application/statistics
建议 /suggestions
系统钩子 /hooks
待办事项 /todos
主题 /topics
用户 /users
验证 .gitlab-ci.yml 文件 /lint
版本 /version

模板 API 资源

端点在以下内容中可用: