REST API ドキュメントの一部は最近移動されました。 探しているものが見つからない場合は、新しい Branches, Collaborators, Commits, Deploy Keys, Deployments, GitHub Pages, Releases, Metrics, Webhooks 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" のパラメーター
ヘッダー |
---|
名前, Type, 説明 |
accept string Setting to |
パス パラメーター |
名前, Type, 説明 |
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" のコード サンプル
curl -L \
-H "Accept: application/vnd.github+json" \
-H "Authorization: Bearer <YOUR-TOKEN>" \
http(s)://HOSTNAME/api/v3/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" のパラメーター
ヘッダー |
---|
名前, Type, 説明 |
accept string Setting to |
パス パラメーター |
名前, Type, 説明 |
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. |
本文のパラメーター |
名前, Type, 説明 |
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" のコード サンプル
curl -L \
-X POST \
-H "Accept: application/vnd.github+json" \
-H "Authorization: Bearer <YOUR-TOKEN>" \
http(s)://HOSTNAME/api/v3/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" のパラメーター
ヘッダー |
---|
名前, Type, 説明 |
accept string Setting to |
パス パラメーター |
名前, Type, 説明 |
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" のコード サンプル
curl -L \
-X DELETE \
-H "Accept: application/vnd.github+json" \
-H "Authorization: Bearer <YOUR-TOKEN>" \
http(s)://HOSTNAME/api/v3/repos/OWNER/REPO/tags/protection/TAG_PROTECTION_ID
Response
Status: 204