存储库标记

存储库标记

This returns the tag protection states of a repository.

This information is only available to repository administrators.

Headers
Name, Type, Description
`accept`string Setting to `application/vnd.github+json` is recommended.
Path parameters
Name, Type, Description
`owner`stringRequired The account owner of the repository. The name is not case sensitive.
`repo`stringRequired The name of the repository. The name is not case sensitive.

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

get/repos/{owner}/{repo}/tags/protection

curl \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  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.

参数

Headers
Name, Type, Description
`accept`string Setting to `application/vnd.github+json` is recommended.
Path parameters
Name, Type, Description
`owner`stringRequired The account owner of the repository. The name is not case sensitive.
`repo`stringRequired The name of the repository. The name is not case sensitive.
Body parameters
Name, Type, Description
`pattern`stringRequired An optional glob pattern to match against when enforcing tag protection.

HTTP 响应状态代码

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

代码示例

post/repos/{owner}/{repo}/tags/protection

curl \
  -X POST \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  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.

参数

Headers
Name, Type, Description
`accept`string Setting to `application/vnd.github+json` is recommended.
Path parameters
Name, Type, Description
`owner`stringRequired The account owner of the repository. The name is not case sensitive.
`repo`stringRequired The name of the repository. The name is not case sensitive.
`tag_protection_id`integerRequired The unique identifier of the tag protection.

HTTP 响应状态代码

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

代码示例

delete/repos/{owner}/{repo}/tags/protection/{tag_protection_id}

curl \
  -X DELETE \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  https://api.github.com/repos/OWNER/REPO/tags/protection/TAG_PROTECTION_ID

Response

Status: 204

List tag protection states for a repository

Response

Create a tag protection state for a repository

Response

Delete a tag protection state for a repository

Response