Nous avons récemment déplacé une partie de la documentation de l’API REST. Si vous ne trouvez pas ce que vous recherchez, vous pouvez essayer les nouvelles pages d’API REST Branches, Collaborators, Commits, Deploy Keys, Deployments, GitHub Pages, Releases, Metrics, Webhooks.
É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.
Paramètres pour « List tag protection states for a repository »
En-têtes |
---|
Nom, Type, Description |
accept string Setting to |
Paramètres de chemin d’accès |
Nom, Type, Description |
owner string ObligatoireThe account owner of the repository. The name is not case sensitive. |
repo string ObligatoireThe name of the repository. The name is not case sensitive. |
Codes d’état de la réponse HTTP pour « List tag protection states for a repository »
Code d’état | Description |
---|---|
200 | OK |
403 | Forbidden |
404 | Resource not found |
Exemples de code pour « 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.
Paramètres pour « Create a tag protection state for a repository »
En-têtes |
---|
Nom, Type, Description |
accept string Setting to |
Paramètres de chemin d’accès |
Nom, Type, Description |
owner string ObligatoireThe account owner of the repository. The name is not case sensitive. |
repo string ObligatoireThe name of the repository. The name is not case sensitive. |
Paramètres du corps |
Nom, Type, Description |
pattern string ObligatoireAn 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’état | Description |
---|---|
201 | Created |
403 | Forbidden |
404 | Resource not found |
Exemples de code pour « 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.
Paramètres pour « Delete a tag protection state for a repository »
En-têtes |
---|
Nom, Type, Description |
accept string Setting to |
Paramètres de chemin d’accès |
Nom, Type, Description |
owner string ObligatoireThe account owner of the repository. The name is not case sensitive. |
repo string ObligatoireThe name of the repository. The name is not case sensitive. |
tag_protection_id integer ObligatoireThe 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’état | Description |
---|---|
204 | No Content |
403 | Forbidden |
404 | Resource not found |
Exemples de code pour « 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