Skip to main content
L’API REST est maintenant versionnée. Pour plus d’informations, consultez « À propos des versions de l’API ».

Étiquettes d’un référentiel

Utilisez l’API REST pour gérer les étiquettes d’un référentiel.

List tag protection states for a repository

This returns the tag protection states of a repository.

This information is only available to repository administrators.

Jetons d’accès affinés pour « List tag protection states for a repository »

Ce point de terminaison fonctionne avec les types de jetons suivants:

Le jeton doit avoir l’ensemble d’autorisations suivant:

  • administration:read

Paramètres pour « List tag protection states for a repository »

En-têtes
Nom, Type, Description
accept string

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

Paramètres de chemin d’accès
Nom, Type, Description
owner string Obligatoire

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

repo string Obligatoire

The name of the repository without the .git extension. The name is not case sensitive.

Codes d’état de la réponse HTTP pour « List tag protection states for a repository »

Code d’étatDescription
200

OK

403

Forbidden

404

Resource not found

Exemples de code pour « List tag protection states for a repository »

Exemple de requête

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

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

Jetons d’accès affinés pour « Create a tag protection state for a repository »

Ce point de terminaison fonctionne avec les types de jetons suivants:

Le jeton doit avoir l’ensemble d’autorisations suivant:

  • administration:write

Paramètres pour « Create a tag protection state for a repository »

En-têtes
Nom, Type, Description
accept string

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

Paramètres de chemin d’accès
Nom, Type, Description
owner string Obligatoire

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

repo string Obligatoire

The name of the repository without the .git extension. The name is not case sensitive.

Paramètres du corps
Nom, Type, Description
pattern string Obligatoire

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

Codes d’état de la réponse HTTP pour « Create a tag protection state for a repository »

Code d’étatDescription
201

Created

403

Forbidden

404

Resource not found

Exemples de code pour « Create a tag protection state for a repository »

Exemple de requête

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

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

Jetons d’accès affinés pour « Delete a tag protection state for a repository »

Ce point de terminaison fonctionne avec les types de jetons suivants:

Le jeton doit avoir l’ensemble d’autorisations suivant:

  • administration:write

Paramètres pour « Delete a tag protection state for a repository »

En-têtes
Nom, Type, Description
accept string

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

Paramètres de chemin d’accès
Nom, Type, Description
owner string Obligatoire

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

repo string Obligatoire

The name of the repository without the .git extension. The name is not case sensitive.

tag_protection_id integer Obligatoire

The unique identifier of the tag protection.

Codes d’état de la réponse HTTP pour « Delete a tag protection state for a repository »

Code d’étatDescription
204

No Content

403

Forbidden

404

Resource not found

Exemples de code pour « Delete a tag protection state for a repository »

Exemple de requête

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