存储库标记
使用 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.
Parameters for "List tag protection states for a repository"
名称, 类型, 说明 |
---|
accept string Setting to |
名称, 类型, 说明 |
---|
owner string 必须The account owner of the repository. The name is not case sensitive. |
repo string 必须The name of the repository without the |
HTTP response status codes for "List tag protection states for a repository"
Status code | Description |
---|---|
200 | OK |
403 | Forbidden |
404 | Resource not found |
Code samples for "List tag protection states for a repository"
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.
Parameters for "Create a tag protection state for a repository"
名称, 类型, 说明 |
---|
accept string Setting to |
名称, 类型, 说明 |
---|
owner string 必须The account owner of the repository. The name is not case sensitive. |
repo string 必须The name of the repository without the |
名称, 类型, 说明 |
---|
pattern string 必须An optional glob pattern to match against when enforcing tag protection. |
HTTP response status codes for "Create a tag protection state for a repository"
Status code | Description |
---|---|
201 | Created |
403 | Forbidden |
404 | Resource not found |
Code samples for "Create a tag protection state for a repository"
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.
Parameters for "Delete a tag protection state for a repository"
名称, 类型, 说明 |
---|
accept string Setting to |
名称, 类型, 说明 |
---|
owner string 必须The account owner of the repository. The name is not case sensitive. |
repo string 必须The name of the repository without the |
tag_protection_id integer 必须The unique identifier of the tag protection. |
HTTP response status codes for "Delete a tag protection state for a repository"
Status code | Description |
---|---|
204 | No Content |
403 | Forbidden |
404 | Resource not found |
Code samples for "Delete a tag protection state for a repository"
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