更新时间:2025-08-20 GMT+08:00
分享

API概览

SSH密钥相关接口

表1 SSH密钥接口列表

接口

说明

检验私钥是否有拉取代码的权限

检验私钥是否有拉取代码的权限。

仓库相关接口

通过调用这些接口,您可以实现仓库的创建、删除以及仓库信息的统计等功能,从而有效管理仓库。

表2 仓库相关接口列表

接口

说明

获取仓库统计数据

获取仓库统计数据。

获取一个仓库下特定分支的图片文件

获取一个仓库下特定分支的图片文件。

修改被流水线引用的仓库状态

修改被流水线引用的仓库状态。

判断用户是否有仓库的管理员权限

判断用户是否有仓库的管理员权限。

设置仓库是公开状态还是私有状态

设置仓库是公开状态还是私有状态。

获取一个仓库下特定分支指定文件内容

获取一个仓库下特定分支指定文件内容。

创建仓库

用指定的名称在指定项目上创建仓库。传入参数:仓库名、模板id、是否导入项目成员、归属项目。

根据仓库名组名获取仓库短id,用以拼接与commitid对应提交详情页面url

获取仓库短id,用于获取仓库详情页面url。

根据组名和仓库名查询某仓库某分支对应的提交

根据仓库组名、仓库名和分支获取提交列表。

根据仓库id查询仓库某分支对应的提交,提供更多可选参数

根据仓库id查询仓库某分支对应的提交。

添加部署密钥

添加部署密钥。

删除仓库部署密钥

删除仓库部署密钥。

获取仓库上一次的提交统计信息

获取仓库上一次的提交统计信息。

仓库统计

根据仓库短id,查询仓库的代码提交记录统计。

删除仓库

根据仓库32位uuid删除指定的仓库。

查看仓库的创建状态

获取仓库状态。

获取代码提交行数

获取指定日期内代码仓指定分支的代码提交行数。

获取关联工作项信息

通过调用此接口,可以获取仓库关联工作项信息。

仓库成员相关接口

表3 仓库成员接口列表

接口

说明

删除仓库成员

删除仓库成员。

Commit相关接口

表4 Commit的接口列表

接口

说明

查询某个仓库的提交信息

根据仓库短ID获取提交信息,支持根据文件路径,查询这个路径下所有的commits列表。

代码仓文件相关接口

表5 仓库文件的接口列表

接口

说明

查询某个仓库的文件信息

获取仓库中文件的信息,如名称、大小、内容。请注意,文件内容是Base64编码的。

User相关接口

表6 User的接口列表

接口

说明

https账号密码校验

判断用户使用HTTPS密码上传/下载代码时输入的用户名和密码是否合法。

WebHook

接口

说明

查询指定仓库的webhook

获取仓库webhook。

为指定仓库添加hook

提交代码自动触发编译构建,添加仓库钩子。

删除指定仓库的 hook

提交代码自动触发编译构建,删除仓库钩子。

项目的相关接口

通过调用这些接口,用户可以查询项目下的所有公开仓库列表、获取项目下所有仓库信息等。

表7

接口

说明

获取一个项目下可以设置为公开状态的仓库列表

获取一个项目下可以设置为公开状态的仓库列表。

校验指定项目下的仓库名

一般创建仓库时调用。通过传入项目uuid,仓库名,调用CoudeHubAdapter接口,查询数据库来判断仓库是否重名。

校验指定项目下的仓库名

获取仓库列表 模糊查询支持范围,如果未传入project_id,则支持按仓库名或项目名模糊查询,否则,只按仓库名模糊匹配。

相关文档