REST API からのプッシュ保護を操作する

secret scanning が API リクエストのコンテンツ内にシークレットを検出した場合に、REST API を使用して GitHub へのプッシュのブロックを解除するオプションについて説明します。

この機能を使用できるユーザーについて

書き込み アクセスを持つユーザー

この記事の内容

REST API からのプッシュ保護について

プッシュ保護は、サポートされているシークレットなどプッシュをブロックすることで、誤ってシークレットをリポジトリにコミットすることを防ぎます。

REST API の [BLOB の作成] エンドポイントと [ファイルコンテンツの作成または更新] エンドポイントには、プッシュ保護が含まれます。 「Git BLOB の REST API エンドポイント」と「リポジトリ コンテンツの REST API エンドポイント」を参照してください。

サポートされているシークレットがコンテンツに含まれるこれらのエンドポイントで要求を行うと、REST API はシークレットが検出されたことを示す 409 エラーを返します。

このエラーを解決する場合、次のいずれかの操作を行うことができます:

  • もう一度試す前に、API 要求のコンテンツからシークレットを 削除 します。
  •         **プッシュ保護バイパスの作成**: [プッシュ保護バイパスの作成] エンドポイントを使用してプッシュ保護をバイパスできます。 詳しくは、「[AUTOTITLE](/rest/secret-scanning/secret-scanning?apiVersion=2022-11-28#create-a-push-protection-bypass)」をご覧ください。

詳細については、次を参照してください。

  •         [AUTOTITLE](/code-security/secret-scanning/working-with-secret-scanning-and-push-protection/working-with-push-protection-from-the-command-line)

  •         [AUTOTITLE](/code-security/secret-scanning/working-with-secret-scanning-and-push-protection/working-with-push-protection-in-the-github-ui)