从 REST API 使用推送保护

了解当 secret scanning 在 API 请求的内容中检测到机密时使用 REST API 取消阻止到 GitHub 的推送的选项。

谁可以使用此功能？

Secret scanning 可用于以下存储库：

  • 公共存储库（免费）
  • 使用启用了 GitHub Advanced Security 的 GitHub Enterprise Cloud 的组织中的专用存储库和内部存储库

本文内容

关于从 REST API 进行的推送保护

推送保护通过阻止包含支持的机密的推送，防止你无意将机密提交到存储库。

REST API 中的“创建 blob”和“创建或更新文件内容”终结点包括推送保护。 请参阅“Git Blob 的 REST API 终结点”和“存储库内容的 REST API 终结点”。

如果对内容包括受支持的机密的这些终结点发出请求，REST API 将返回 409 错误，指示检测到机密。

可通过以下任一方法解决该错误：

  • 在重试之前，从 API 请求的内容中删除机密。
  • 创建推送保护绕过：你可以使用“创建推送保护绕过”终结点绕过推送保护。 有关详细信息，请参阅“适用于机密扫描的 REST API 终结点”。

其他阅读材料