Trabalhando com a proteção contra push via API REST

Conheça suas opções para desbloquear o push para o GitHub usando a API REST se o secret scanning detectar um segredo no conteúdo da sua solicitação de API.

Quem pode usar esse recurso?

O Secret scanning está disponível para os seguintes repositórios:

  • Repositórios públicos (grátis)
  • Repositórios privados e internos em organizações que usam o GitHub Enterprise Cloud com GitHub Advanced Security habilitado
  • Repositórios pertencentes ao usuário para GitHub Enterprise Cloud com Enterprise Managed Users

Neste artigo

Sobre a proteção contra push via API REST

A proteção contra push evita que você faça commit de segredos acidentalmente em um repositório ao realizar o bloqueio de envios por pushes que contêm segredos com suporte.

Os pontos de extremidade "Criar um blob" e "Criar ou atualizar conteúdo de arquivo" na API REST incluem proteção por push. Consulte "Pontos de extremidade da API REST para blobs Git" e "Pontos de extremidade da API REST para conteúdos de repositório".

Se você fizer uma solicitação com esses pontos de extremidade cujo conteúdo inclui um segredo compatível, a API REST retornará um erro 409, indicando que um segredo foi detectado.

Para resolver esse erro, você pode:

  • Remova o segredo do conteúdo da solicitação de API antes de tentar novamente.
  • Criar um bypass de proteção contra push: você pode ignorar a proteção contra push usando o ponto de extremidade "Criar um bypass de proteção contra push". Para obter mais informações, confira "Pontos de extremidade da API REST para verificação de segredos".

Leitura adicional