Skip to main content
我们经常发布文档更新,此页面的翻译可能仍在进行中。 有关最新信息,请访问英语文档
REST API 现已经过版本控制。 有关详细信息,请参阅“关于 API 版本控制”。

存储库标记

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

List tag protection states for a repository

适用于 GitHub Apps

This returns the tag protection states of a repository.

This information is only available to repository administrators.

“List tag protection states for a repository”的参数

标头
名称, 类型, 说明
accept string

Setting to application/vnd.github+json is recommended.

路径参数
名称, 类型, 说明
owner string 必选

The account owner of the repository. The name is not case sensitive.

repo string 必选

The name of the repository. The name is not case sensitive.

“List tag protection states for a repository”的 HTTP 响应状态代码

状态代码说明
200

OK

403

Forbidden

404

Resource not found

“List tag protection states for a repository”的示例代码

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

Response

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

Create a tag protection state for a repository

适用于 GitHub Apps

This creates a tag protection state for a repository. This endpoint is only available to repository administrators.

“Create a tag protection state for a repository”的参数

标头
名称, 类型, 说明
accept string

Setting to application/vnd.github+json is recommended.

路径参数
名称, 类型, 说明
owner string 必选

The account owner of the repository. The name is not case sensitive.

repo string 必选

The name of the repository. The name is not case sensitive.

正文参数
名称, 类型, 说明
pattern string 必选

An optional glob pattern to match against when enforcing tag protection.

“Create a tag protection state for a repository”的 HTTP 响应状态代码

状态代码说明
201

Created

403

Forbidden

404

Resource not found

“Create a tag protection state for a repository”的示例代码

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.*"}'

Response

Status: 201
{ "enabled": true }

Delete a tag protection state for a repository

适用于 GitHub Apps

This deletes a tag protection state for a repository. This endpoint is only available to repository administrators.

“Delete a tag protection state for a repository”的参数

标头
名称, 类型, 说明
accept string

Setting to application/vnd.github+json is recommended.

路径参数
名称, 类型, 说明
owner string 必选

The account owner of the repository. The name is not case sensitive.

repo string 必选

The name of the repository. The name is not case sensitive.

tag_protection_id integer 必选

The unique identifier of the tag protection.

“Delete a tag protection state for a repository”的 HTTP 响应状态代码

状态代码说明
204

No Content

403

Forbidden

404

Resource not found

“Delete a tag protection state for a repository”的示例代码

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

Response

Status: 204