Skip to main content
REST API 现已经过版本控制。 有关详细信息,请参阅“关于 API 版本控制”。

存储库标记的 REST API 终结点

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

List tag protection states for a repository

This returns the tag protection states of a repository.

This information is only available to repository administrators.

“List tag protection states for a repository”的细粒度访问令牌

This endpoint works with the following fine-grained token types:

令牌必须具有以下权限集:

  • "Administration" repository permissions (read)

“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 without the .git extension. 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

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”的细粒度访问令牌

This endpoint works with the following fine-grained token types:

令牌必须具有以下权限集:

  • "Administration" repository permissions (write)

“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 without the .git extension. 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

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”的细粒度访问令牌

This endpoint works with the following fine-grained token types:

令牌必须具有以下权限集:

  • "Administration" repository permissions (write)

“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 without the .git extension. 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