Недавно мы перенесли некоторые из документации по REST API. Если вам не удается найти нужный объект, попробуйте использовать новые страницы REST API Branches, Collaborators, Commits, Deploy Keys, Deployments, GitHub Pages, Releases, Metrics, Webhooks.
Теги репозитория
Используйте 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"
Заголовки |
---|
Имя, Тип, Описание |
accept stringSetting to |
Параметры пути |
Имя, Тип, Описание |
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. |
Коды состояния HTTP-ответа для "List tag protection states for a repository"
Код состояния | Описание |
---|---|
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"
Заголовки |
---|
Имя, Тип, Описание |
accept stringSetting to |
Параметры пути |
Имя, Тип, Описание |
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. |
Параметры запроса |
Имя, Тип, Описание |
pattern stringОбязательноAn optional glob pattern to match against when enforcing tag protection. |
Коды состояния HTTP-ответа для "Create a tag protection state for a repository"
Код состояния | Описание |
---|---|
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"
Заголовки |
---|
Имя, Тип, Описание |
accept stringSetting to |
Параметры пути |
Имя, Тип, Описание |
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. |
Коды состояния HTTP-ответа для "Delete a tag protection state for a repository"
Код состояния | Описание |
---|---|
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