跳至主要内容
REST API 现在已分版本。 有关详细信息,请参阅“关于 API 版本控制”。

存储库标记的 REST API 终结点

使用 REST API 管理存储库的标记。

已弃用 - 列出存储库的标记保护状态

注意:此操作已弃用,并将在 2024 年 8 月 30 日之后删除。请改用“存储库规则集”终结点。

这将返回存储库的标记保护状态。

此信息仅对存储库管理员可用。

“已弃用 - 列出存储库的标记保护状态”的细粒度访问令牌

此终结点适用于以下细粒度令牌类型

细粒度令牌必须具有以下权限设置

  • “管理”存储库权限(读取)

“已弃用 - 列出存储库的标记保护状态”的参数

标头
名称、类型、描述
accept 字符串

建议设置为 application/vnd.github+json

路径参数
名称、类型、描述
owner 字符串 必需

存储库的帐户所有者。名称不区分大小写。

repo 字符串 必需

不带 .git 扩展名的存储库名称。名称不区分大小写。

“已弃用 - 列出存储库的标签保护状态”的 HTTP 响应状态代码

状态代码描述
200

确定

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

响应

状态:200
[ { "id": 2, "pattern": "v1.*" } ]

已弃用 - 为存储库创建标签保护状态

注意:此操作已弃用,并将于 2024 年 8 月 30 日之后移除。请改用“存储库规则集”端点。

此操作为存储库创建标签保护状态。此端点仅对存储库管理员可用。

“已弃用 - 为存储库创建标签保护状态”的细粒度访问令牌

此终结点适用于以下细粒度令牌类型

细粒度令牌必须具有以下权限设置

  • “管理”存储库权限(写入)

“已弃用 - 为存储库创建标签保护状态”的参数

标头
名称、类型、描述
accept 字符串

建议设置为 application/vnd.github+json

路径参数
名称、类型、描述
owner 字符串 必需

存储库的帐户所有者。名称不区分大小写。

repo 字符串 必需

不带 .git 扩展名的存储库名称。名称不区分大小写。

主体参数
名称、类型、描述
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.*"}'

响应

状态:201
{ "enabled": true }

已弃用 - 删除存储库的标签保护状态

注意:此操作已弃用,将在 2024 年 8 月 30 日之后移除。请改用“存储库规则集”端点。

这会删除存储库的标签保护状态。此端点仅对存储库管理员可用。

“已弃用 - 删除存储库的标签保护状态”的细粒度访问令牌

此终结点适用于以下细粒度令牌类型

细粒度令牌必须具有以下权限设置

  • “管理”存储库权限(写入)

“已弃用 - 删除存储库的标签保护状态”的参数

标头
名称、类型、描述
accept 字符串

建议设置为 application/vnd.github+json

路径参数
名称、类型、描述
owner 字符串 必需

存储库的帐户所有者。名称不区分大小写。

repo 字符串 必需

不带 .git 扩展名的存储库名称。名称不区分大小写。

tag_protection_id 整数 必需

标签保护的唯一标识符。

“已弃用 - 删除存储库的标签保护状态”的 HTTP 响应状态代码

状态代码描述
204

无内容

403

禁止

404

未找到资源

“已弃用 - 删除存储库的标签保护状态”的代码示例

请求示例

删除/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