REST APIにより、外部ツールとBurp Suiteを連携できます。これらの設定で次が可能です:
REST APIサービスを有効にするには、サービス起動中チェックボックスを選択します。
サービスのURLとポートを指定するには:
信頼できないネットワークに接続している場合は、ループバックインタフェースにバインドする設定以外にしないことを強く推奨します。
BurpのREST APIはデフォルトで、呼び出し時にAPIキーを使用して認証する必要があります。この要件を無効にするには、APIキー無しのアクセスを許可するを選択します。
APIキー無しのアクセスを許可するオプションは推奨されません。APIキーが必要ない場合、サービスエンドポイントへのネットワークアクセスができる人は誰でも、Burp内のアクションを起動してしてそのデータにアクセスできます。これには、Burpと同じマシンでブラウズする信頼できないWebサイトからのCSRFリクエストも含まれます。サービスがループバックインタフェースのみでリッスンしている場合でも、常にAPIキーを使用する必要があります。
APIキーの設定には、現在のAPIキーの一覧が表示されます。用途別にAPIキーを作成し、一覧のチェックボックスで有効または無効を選択できます。
新しいAPIキーを作成するには:
APIキーは秘密情報で、慎重に扱う必要があります。APIキーの値は、作成された時点でしか取得できないことに注意してください。
編集をクリックするとキーの名前を編集でき、削除をクリックするとリストから削除できます。
サービスの設定が完了したら、[サービスURL]/[APIキー]でAPIドキュメントのブラウズができ、APIとのやりとりができます。
REST APIは機密性の高い機能とデータを公開します。信頼できないネットワークインタフェースではREST APIサービスを有効にせず、アクセスを許可するクライアントごとに個別のAPIキーを使用するべきです。
REST API設定は、ユーザ設定です。あなたのマシンにインストールされたすべてのBurpに適用されます。