Skip to main content
Мы публикуем частые обновления нашей документации, и перевод этой страницы может все еще выполняться. Актуальные сведения см. в документации на английском языке.
REST API теперь имеет версию. Дополнительные сведения см. в разделе Сведения об управлении версиями API.

Теги репозитория

Используйте REST API для управления тегами для репозитория.

List tag protection states for a repository

Работа с GitHub Apps

This returns the tag protection states of a repository.

This information is only available to repository administrators.

Параметры

Заголовки
Имя, Тип, Описание
acceptstring

Setting to application/vnd.github+json is recommended.

Параметры пути
Имя, Тип, Описание
ownerstringОбязательно

The account owner of the repository. The name is not case sensitive.

repostringОбязательно

The name of the repository. The name is not case sensitive.

Коды состояния HTTP-ответа

Код состоянияОписание
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>"\ -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

Работа с GitHub Apps

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

Параметры

Заголовки
Имя, Тип, Описание
acceptstring

Setting to application/vnd.github+json is recommended.

Параметры пути
Имя, Тип, Описание
ownerstringОбязательно

The account owner of the repository. The name is not case sensitive.

repostringОбязательно

The name of the repository. The name is not case sensitive.

Параметры запроса
Имя, Тип, Описание
patternstringОбязательно

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>"\ -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

Работа с GitHub Apps

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

Параметры

Заголовки
Имя, Тип, Описание
acceptstring

Setting to application/vnd.github+json is recommended.

Параметры пути
Имя, Тип, Описание
ownerstringОбязательно

The account owner of the repository. The name is not case sensitive.

repostringОбязательно

The name of the repository. The name is not case sensitive.

tag_protection_idintegerОбязательно

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>"\ -H "X-GitHub-Api-Version: 2022-11-28" \ https://api.github.com/repos/OWNER/REPO/tags/protection/TAG_PROTECTION_ID

Response

Status: 204