Skip to main content
Publicamos actualizaciones para la documentación con frecuencia y es posible que aún se esté traduciendo esta página. Para obtener la información más reciente, consulta la documentación en inglés.
All products
API DE REST

Recientemente hemos movido parte de la documentación de la API REST. Si no encuentras lo que estás buscando, puedes probar las nuevas páginas de la API REST Branches, Collaborators, Commits, Deploy Keys, Deployments, GitHub Pages, Releases, Metrics, Webhooks.

Etiquetas de repositorio

Usa la API de REST para administrar etiquetas para un repositorio.

List tag protection states for a repository

Funciona con GitHub Apps

This returns the tag protection states of a repository.

This information is only available to repository administrators.

Parámetros para "List tag protection states for a repository"

Encabezados
accept string

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

Parámetros de la ruta de acceso
owner string Requerido

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

repo string Requerido

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

Códigos de estado de respuesta HTTP para "List tag protection states for a repository"

status codeDescripción
200

OK

403

Forbidden

404

Resource not found

Ejemplos de código para "List tag protection states for a repository"

get/repos/{owner}/{repo}/tags/protection
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

Funciona con GitHub Apps

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

Parámetros para "Create a tag protection state for a repository"

Encabezados
accept string

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

Parámetros de la ruta de acceso
owner string Requerido

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

repo string Requerido

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

Parámetros del cuerpo
pattern string Requerido

An optional glob pattern to match against when enforcing tag protection.

Códigos de estado de respuesta HTTP para "Create a tag protection state for a repository"

status codeDescripción
201

Created

403

Forbidden

404

Resource not found

Ejemplos de código para "Create a tag protection state for a repository"

post/repos/{owner}/{repo}/tags/protection
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

Funciona con GitHub Apps

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

Parámetros para "Delete a tag protection state for a repository"

Encabezados
accept string

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

Parámetros de la ruta de acceso
owner string Requerido

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

repo string Requerido

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

tag_protection_id integer Requerido

The unique identifier of the tag protection.

Códigos de estado de respuesta HTTP para "Delete a tag protection state for a repository"

status codeDescripción
204

No Content

403

Forbidden

404

Resource not found

Ejemplos de código para "Delete a tag protection state for a repository"

delete/repos/{owner}/{repo}/tags/protection/{tag_protection_id}
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