REST API 现在已版本化。 更多信息,请参阅“关于 API 版本控制”。
代码库标签的 REST API 端点
使用 REST API 管理代码库的标签。
即将停用 - 列出代码库的标签保护状态
“即将停用 - 列出代码库的标签保护状态”的细粒度访问令牌
此端点可以使用以下细粒度令牌类型:
细粒度令牌必须具有以下权限集
- “管理”代码库权限(读取)
“即将停用 - 列出代码库的标签保护状态”的参数
名称,类型,描述 |
---|
accept 字符串建议设置为 |
名称,类型,描述 |
---|
owner 字符串 必填代码库的账户所有者。名称不区分大小写。 |
repo 字符串 必填代码库名称,不包含 |
“即将停用 - 列出代码库的标签保护状态”的HTTP响应状态码
状态码 | 描述 |
---|---|
200 | OK |
403 | 禁止 |
404 | 资源未找到 |
“即将停用 - 列出代码库的标签保护状态”的代码示例
请求示例
get/repos/{owner}/{repo}/tags/protection
curl -L \ -H "Accept: application/vnd.github+json" \ -H "Authorization: Bearer <YOUR-TOKEN>" \ -H "X-GitHub-Api-Version: 2022-11-28" \ https://api.github.com/repos/OWNER/REPO/tags/protection
响应
即将停用 - 为代码库创建标签保护状态
警告
即将停用通知:此操作即将停用,将于 2024 年 8 月 30 日后移除。请改用“代码库规则集”端点。
这将为代码库创建一个标签保护状态。此端点仅对代码库管理员可用。
“即将停用 - 为代码库创建标签保护状态”的细粒度访问令牌
此端点可以使用以下细粒度令牌类型:
细粒度令牌必须具有以下权限集
- “管理”代码库权限(写入)
“即将停用 - 为代码库创建标签保护状态”的参数
名称,类型,描述 |
---|
accept 字符串建议设置为 |
名称,类型,描述 |
---|
owner 字符串 必填代码库的账户所有者。名称不区分大小写。 |
repo 字符串 必填代码库名称,不包含 |
名称,类型,描述 |
---|
pattern 字符串 必填一个可选的 glob 模式,用于在执行标签保护时进行匹配。 |
“即将停用 - 为代码库创建标签保护状态”的HTTP响应状态码
状态码 | 描述 |
---|---|
201 | 已创建 |
403 | 禁止 |
404 | 资源未找到 |
“即将停用 - 为代码库创建标签保护状态”的代码示例
请求示例
post/repos/{owner}/{repo}/tags/protection
curl -L \ -X POST \ -H "Accept: application/vnd.github+json" \ -H "Authorization: Bearer <YOUR-TOKEN>" \ -H "X-GitHub-Api-Version: 2022-11-28" \ https://api.github.com/repos/OWNER/REPO/tags/protection \ -d '{"pattern":"v1.*"}'
响应
即将停用 - 删除代码库的标签保护状态
警告
即将停用通知:此操作即将停用,将于 2024 年 8 月 30 日后移除。请改用“代码库规则集”端点。
这将删除代码库的标签保护状态。此端点仅对代码库管理员可用。
“即将停用 - 删除代码库的标签保护状态”的细粒度访问令牌
此端点可以使用以下细粒度令牌类型:
细粒度令牌必须具有以下权限集
- “管理”代码库权限(写入)
“即将停用 - 删除代码库的标签保护状态”的参数
名称,类型,描述 |
---|
accept 字符串建议设置为 |
名称,类型,描述 |
---|
owner 字符串 必填代码库的账户所有者。名称不区分大小写。 |
repo 字符串 必填代码库名称,不包含 |
tag_protection_id 整数 必填标签保护的唯一标识符。 |
“即将停用 - 删除代码库的标签保护状态”的HTTP响应状态码
状态码 | 描述 |
---|---|
204 | 无内容 |
403 | 禁止 |
404 | 资源未找到 |
“即将停用 - 删除代码库的标签保护状态”的代码示例
请求示例
delete/repos/{owner}/{repo}/tags/protection/{tag_protection_id}
curl -L \ -X DELETE \ -H "Accept: application/vnd.github+json" \ -H "Authorization: Bearer <YOUR-TOKEN>" \ -H "X-GitHub-Api-Version: 2022-11-28" \ https://api.github.com/repos/OWNER/REPO/tags/protection/TAG_PROTECTION_ID
响应
状态:204