存储库标记的 REST API 终结点 - GitHub Enterprise Server 3.14 Docs

Warning

Closing down notice: This operation is closing down and will be removed after August 30, 2024. Use the "Repository Rulesets" endpoint instead.

This returns the tag protection states of a repository.

This information is only available to repository administrators.

此端点支持以下精细令牌类型:

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

"Administration" repository permissions (read)

标头
名称, 类型, 说明
`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.

状态代码	说明
`200`	OK
`403`	Forbidden
`404`	Resource not found

请求示例

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" \
  http(s)://HOSTNAME/api/v3/repos/OWNER/REPO/tags/protection

Response

Status: 200

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

Closing down - Create a tag protection state for a repository

Warning

Closing down notice: This operation is closing down and will be removed after August 30, 2024. Use the "Repository Rulesets" endpoint instead.

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

“Closing down - Create a tag protection state for a repository”的细粒度访问令牌

此端点支持以下精细令牌类型:

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

"Administration" repository permissions (write)

“Closing down - 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.

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

状态代码	说明
`201`	Created
`403`	Forbidden
`404`	Resource not found

“Closing down - 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" \
  http(s)://HOSTNAME/api/v3/repos/OWNER/REPO/tags/protection \
  -d '{"pattern":"v1.*"}'

Response

Status: 201

{
  "enabled": true
}

Closing down - Delete a tag protection state for a repository

Warning

Closing down notice: This operation is closing down and will be removed after August 30, 2024. Use the "Repository Rulesets" endpoint instead.

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

“Closing down - Delete a tag protection state for a repository”的细粒度访问令牌

此端点支持以下精细令牌类型:

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

"Administration" repository permissions (write)

“Closing down - 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.

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

状态代码	说明
`204`	No Content
`403`	Forbidden
`404`	Resource not found

“Closing down - 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" \
  http(s)://HOSTNAME/api/v3/repos/OWNER/REPO/tags/protection/TAG_PROTECTION_ID

Response

Status: 204