シンプルな POST リクエストを介して、セキュリティ データ API を介してカスタムの脆弱性またはセキュリティ データを New Relic に送信します。統合によるセキュリティ サービスが現在サポートされていない場合、または API を介してセキュリティ データを送信する方がカスタム ワークフローに適している場合は、API を使用してください。
前提条件
データのレポート先となるアカウントの New Relic
。
New Relicへのデータ送信
脆弱性またはその他のセキュリティ データを送信するには、結果配列を含む POST メソッドを介して JSON オブジェクトを送信します。配列内の各オブジェクトは、検出された脆弱性またはその他のセキュリティ イベントを表します。New Relic のセキュリティ エンドポイントを必ず含めてください。お住まいの地域に応じて、次のいずれかを使用してください。
- 米国の場合、
https://security-api.newrelic.com/security/v1 - EUの場合、
https://security-api.service.eu.newrelic.com/security/v1
POST リクエストの例を次に示します。次のセクションでは、個々のコンポーネントを見ていきます。
$curl -X POST https://security-api.newrelic.com/security/v1 \> -H "Content-Type: application/json" \> -H "Api-Key: INSERT_YOUR_API_KEY " \> -d '{$ "findings": [$ {$ "source": "Insert security tool name, such as Snyk",$ "title": "Insert a short description of security issue",$ "message": "Insert long description and remediation advice",$ "issueType": "Insert Library|Container|Host Vulnerability",$ "issueId": "Insert vulnerability identifier like CVE, CWE, CIS, etc.",$ "issueVendorId": "Vendor-specific identifier if different from issueId",$ "issueInstanceKey": "Insert the unique path to this instance of the issue",$ "disclosureUrl": "Insert a URL to additional information on the issue",$ "severity": "Insert CRITICAL|HIGH|MEDIUM|LOW|INFO",$ "remediationExists": Insert boolean true | false (no quotation marks),$ "remediationRecommendation": "Explain the action to take",$ "detectedAt": "Insert timestamp when detected, in milliseconds since epoch",$ "entityType": "Insert Host|Service|Repository|Image|AWS",$ "entityLookupValue": "Insert a URL to find entity",$ "entityGuid": "ABCDEFG",$ "customFields": {$ "sourceDetailInfo": "DecadeCoffee"$ }$ }$ ]$}'URL パラメータ
パラメータ | 説明 |
|---|---|
| オプション: 統合されたアプリケーションのリポジトリ URL。 |
必須項目
リクエストには次のフィールドが必要です。
フィールド | 説明 |
|---|---|
|
|
| 問題の短い (50 ～ 100 文字) 要約。ページ タイトルまたは表のセル コンテンツとしての使用に適している必要があります。 |
| 調査結果の説明とその修正方法を含む、問題の詳細な説明。マークダウンを含めることができます。 |
| New Relic がサポートする課題タイプ。現在、これらは次のとおりです。
|
| 検出された問題の標準識別子。たとえば、CVE または CWE 識別子、あるいは CIS ベンチマーク ルールなどです。複数のツールが同じ問題を検出した場合、 |
| 問題またはスキャン ツールの重大度に関する定義済みのコミュニティ コンセンサス。これは、次のいずれかである必要があります。
|
| 報告された問題を New Relic プラットフォームに知られているエンティティに関連付けるために使用されます。エンティティ検索 API によって認識されるタイプ、または Security API によってサポートされる特殊なケース (
|
| そのタイプの適切なエンティティを見つけるために使用されます。
|
| New Relic プラットフォーム内の特定のエンティティの一意の識別子。アプリケーション、サービス、またはインフラストラクチャ コンポーネントの追跡と管理に不可欠です。
|
オプションのフィールド
リクエストには、次のオプション フィールドのいずれかを含めることができます。
フィールド | 説明 |
|---|---|
| JSON/ の浮動小数点数として、CVE に割り当てられた CVSSv3 スコア |
| この CVE を記述する CVSSv3 ベクトル。 |
| この脆弱性のインスタンスの発生を、同じリポジトリ、サービス、エンティティ、またはアカウント内の他のインスタンスから一意に識別するパスまたは識別子。例: ファイルへのフル パスとソース コードの検出結果の行番号、またはホストまたはコンテナー イメージ内の脆弱なバイナリへのパス。インスタンス キーは、それぞれ修復が必要な複数のインスタンスを区別しながら、同じ問題の繰り返し検出に対して同一である必要があります。指定しない場合、解決された |
|
|
| 問題に関する追加情報への URL (ソース ツール ベンダーの Web サイトまたは公開情報参照)。信頼できる情報源である必要があります。 |
| 問題の修正が存在することがわかっているかどうかを示すブール値。 |
| 修復のために実行するアクションを説明する短い形式のテキスト。サードパーティの依存関係については、フォームを使用してください |
| 問題が検出されたときのタイムスタンプ (エポックからのミリ秒単位)。提供されない場合、データが New Relic に送信された時点で使用されます。 |