Skip to main content

We've recently moved some of the REST API documentation. If you can't find what you're looking for, you might try the new Branches, Collaborators, Commits, Deploy Keys, Deployments, GitHub Pages, Releases, Metrics, Webhooks REST API pages.

Repository tags

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

Encabezados
Nombre, Tipo, Descripción
acceptstring

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

Parámetros de ruta
Nombre, Tipo, Descripción
ownerstringRequerido

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

repostringRequerido

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

Códigos de estado de respuesta HTTP

Código de estadoDescripción
200

OK

403

Forbidden

404

Resource not found

Ejemplos de código

get/repos/{owner}/{repo}/tags/protection
curl \ -H "Accept: application/vnd.github+json" \ -H "Authorization: token <TOKEN>" \ https://api.github.com/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

Encabezados
Nombre, Tipo, Descripción
acceptstring

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

Parámetros de ruta
Nombre, Tipo, Descripción
ownerstringRequerido

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

repostringRequerido

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

Parámetros de cuerpo
Nombre, Tipo, Descripción
patternstringRequerido

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

Códigos de estado de respuesta HTTP

Código de estadoDescripción
201

Created

403

Forbidden

404

Resource not found

Ejemplos de código

post/repos/{owner}/{repo}/tags/protection
curl \ -X POST \ -H "Accept: application/vnd.github+json" \ -H "Authorization: token <TOKEN>" \ 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

Funciona con GitHub Apps

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

Parámetros

Encabezados
Nombre, Tipo, Descripción
acceptstring

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

Parámetros de ruta
Nombre, Tipo, Descripción
ownerstringRequerido

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

repostringRequerido

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

tag_protection_idintegerRequerido

The unique identifier of the tag protection.

Códigos de estado de respuesta HTTP

Código de estadoDescripción
204

No Content

403

Forbidden

404

Resource not found

Ejemplos de código

delete/repos/{owner}/{repo}/tags/protection/{tag_protection_id}
curl \ -X DELETE \ -H "Accept: application/vnd.github+json" \ -H "Authorization: token <TOKEN>" \ https://api.github.com/repos/OWNER/REPO/tags/protection/TAG_PROTECTION_ID

Response

Status: 204