Recentemente, movemos algumas das documentações da API REST. Se você não conseguir encontrar o que está procurando, tente as novas páginas da API REST Branches, Collaborators, Commits, Deploy Keys, Deployments, GitHub Pages, Releases, Metrics, Webhooks}.
Marcas de repositório
Use a API REST para gerenciar as tags de um repositório.
List tag protection states for a repository
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"
Cabeçalhos |
---|
Name, Tipo, Descrição |
accept string Setting to |
Parâmetros de caminho |
Name, Tipo, Descrição |
owner string ObrigatórioThe account owner of the repository. The name is not case sensitive. |
repo string ObrigatórioThe name of the repository. The name is not case sensitive. |
Códigos de status de resposta HTTP para "List tag protection states for a repository"
Código de status | Descrição |
---|---|
200 | OK |
403 | Forbidden |
404 | Resource not found |
Exemplos de código para "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.
Parâmetros para "Create a tag protection state for a repository"
Cabeçalhos |
---|
Name, Tipo, Descrição |
accept string Setting to |
Parâmetros de caminho |
Name, Tipo, Descrição |
owner string ObrigatórioThe account owner of the repository. The name is not case sensitive. |
repo string ObrigatórioThe name of the repository. The name is not case sensitive. |
Parâmetros do corpo |
Name, Tipo, Descrição |
pattern string ObrigatórioAn optional glob pattern to match against when enforcing tag protection. |
Códigos de status de resposta HTTP para "Create a tag protection state for a repository"
Código de status | Descrição |
---|---|
201 | Created |
403 | Forbidden |
404 | Resource not found |
Exemplos de código para "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.
Parâmetros para "Delete a tag protection state for a repository"
Cabeçalhos |
---|
Name, Tipo, Descrição |
accept string Setting to |
Parâmetros de caminho |
Name, Tipo, Descrição |
owner string ObrigatórioThe account owner of the repository. The name is not case sensitive. |
repo string ObrigatórioThe name of the repository. The name is not case sensitive. |
tag_protection_id integer ObrigatórioThe unique identifier of the tag protection. |
Códigos de status de resposta HTTP para "Delete a tag protection state for a repository"
Código de status | Descrição |
---|---|
204 | No Content |
403 | Forbidden |
404 | Resource not found |
Exemplos de código para "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