PUT suppliers/{supplier}/indicators
2024年8月22日
ID 198659
InternalTIおよび FalsePositive 脅威インジケーターを含む脅威インジケーターに新しいインジケーターを追加し、既存のインジケーターを更新します。
このリクエストで更新できるのは、REST API で作成された脅威インジケーターと InternalTI および FalsePositive 脅威インジケーターからのインジケーターのみです。
パス
/api/%API_VERSION%/suppliers/{supplier}/indicators
メソッド
PUT
リクエストヘッダー
このリクエストには、次のヘッダーがあります。
リクエストヘッダー
名前 | 値 | 説明 |
---|---|---|
|
| |
|
| レスポンスのコンテンツタイプ。 |
|
| リクエストのコンテンツタイプ。
|
|
| リクエストボディのサイズ(バイト)。 このリクエストボディの最大サイズは、128 MB( |
リクエストのパラメータ
このリクエストには、次のパラメータがあります:
リクエストのパラメータ
名前 | パラメータタイプ | 説明 |
---|---|---|
| パス | 脅威インジケーターの名前。 |
リクエストボディ
このリクエストボディには、インジケーターオブジェクトの JSON 配列が含まれます。
[
{
"indicator":"%INDICATOR_VALUE_1%",
"context":
{
"%FIELD_NAME_1%":"%FIELD_VALUE_1%",
...
"%FIELD_NAME_N%":"%FIELD_VALUE_N%"
},
"tags":
[
"%TAG_NAME_1%",
...
"%TAG_NAME_N%"
]
},
...
{
"indicator":"%INDICATOR_VALUE_N%",
"context":
{
"%FIELD_NAME_1%":"%FIELD_VALUE_1%",
...
"%FIELD_NAME_N%":"%FIELD_VALUE_N%"
}
}
]
次の表でインジケーターオブジェクトのプロパティについて説明します。
インジケーターオブジェクトのプロパティ
プロパティ | 値 | 必須 | 説明 |
---|---|---|---|
| string | Yes | インジケーターの値。 次のインジケータータイプを指定できます:
|
| インジケーターコンテキストオブジェクト | No(説明を参照) | インジケーターコンテキスト。 このプロパティには、インジケーターコンテキストオブジェクトが含まれる必要があります。 FalsePositive 脅威インジケーターにインジケーターを追加する場合、context プロパティを指定しないでください。 |
| インジケータータグオブジェクト | No | REST API 1.1 以降で使用可能です。 インジケーターに割り当てられたタグのリスト。 このリストには、Kaspersky CyberTrace データベース内に既に存在するタグのみを含める必要があります。データベースに新しいタグを追加するには、POST tags リクエストを使用します。 インジケータータグオブジェクトが欠落している場合、データベース内のインジケータータグに関する情報は変更されません。 インジケータータグオブジェクトが空である場合、データベース内のインジケーターから全てのタグが削除されます。タグ自体は削除されません。 タグ名を追加または変更する場合、文字が大文字に変換されます。 |
| boolean | No | REST API 1.2 以降で使用可能です。 インジケーター関連の検知を誤検知としてマーク付けするフラグ。 このパラメーターは、リクエストパスで指定された脅威インジケーターの値が REST API 1.2 を使用する場合は、リクエストボディに |
次の表でインジケーターコンテキストオブジェクトのプロパティについて説明します。
インジケーターコンテキストオブジェクトのプロパティ
プロパティ | 値 | 必須 | 説明 |
---|---|---|---|
|
| Yes | インジケーターの 1 つ以上のコンテキストフィールド。 プロパティの名前は、インジケーターのコンテキストフィールドの名前に対応している必要があります。 プロパティの値は、インジケーターのコンテキストフィールドの値に対応している必要があります。 |
リクエスト例
PUT suppliers/{supplier}/indicators リクエストの例は、次の通りです。
PUT https://192.0.2.57/api/1.1/
Accept: application/json Content-Type: application/json Authorization: Basic Content-Length: 150
[ {"indicator":"tux.example.com","context":{"ip":"192.0.2.42","name":"ExampleIndicator", "threat_level":1},"tags":["OSINT", "EXAMPLE"]}, {"indicator":"malicious.example.com"} ] |
以下は、Mark_detections
パラメーターを FalsePositive
脅威インジケーターに適用した PUTsuppliers/{supplier}/indicators リクエストの例です。
PUT https://192.0.2.57/api/1.2/suppliers/FalsePositive/indicators Accept: application/json Content-Type: application/json Authorization: Basic dXNlcjpwYXNzd29yZA== Content-Length: 150
[ { "indicator":"DC212B238A5A7C0A9DF7BF298546A154", "tags": [ "FP" ], "mark_detections": false }, ... ]
|
レスポンスヘッダー
このレスポンスには、次のヘッダーがあります。
レスポンスヘッダー
名前 | 値 | 説明 |
---|---|---|
Content-Type |
| レスポンスのコンテンツタイプ。 |
Content-Length |
| レスポンスボディのサイズ(バイト)。 |
レスポンスボディ
レスポンスボディには、JSON オブジェクトと操作のステータスが含まれます。
[
{
"status": "All indicators were successfully added to the database"
}
]
次の表でステータスオブジェクトのプロパティについて説明します。
ステータスオブジェクトのプロパティ
プロパティ | 値 | 説明 |
---|---|---|
|
| 操作のステータス。 |
レスポンス例
PUT suppliers/{supplier}/indicators リクエストのレスポンス例は、次の通りです。
НТТР/1.1 201 ОК Date:Mon, 23 Dec 2019 09:56:10 UTC Content-Type: application/json Content-Length: 46
[{"status": "All indicators successfully added to the database"}] |
一部成功のレスポンス
このレスポンスは、一部のインジケーターが正常に処理されなかった時に生成されます。
レスポンスボディには、一部成功オブジェクトと操作のステータス、およびインジケーターエラーオブジェクトの配列が含まれます。
[
{
"status": "An error occurred while adding some of the indicators to the database",
"error_indicators":[
{
"indicator": "%INDICATOR_VALUE_1%",
"reason": "%REASON%"
},
...
{
"indicator": "%INDICATOR_VALUE_N%",
"reason": "%REASON%"
}
]
}
]
次の表で一部成功オブジェクトのプロパティについて説明します。
一部成功オブジェクトのプロパティ
プロパティ | 値 | 説明 |
---|---|---|
|
| 操作のステータス。 |
| インジケーターエラーオブジェクト | 処理されなかったインジケーターに関する情報の配列。 |
次の表でインジケーターエラーオブジェクトのプロパティについて説明します。
インジケーターエラーオブジェクトのプロパティ
プロパティ | 値 | 説明 |
---|---|---|
|
| 処理されなかったインジケーター。 |
|
| エラーの原因。 このプロパティは、レスポンス内に存在しない可能性があります。 |
一部成功のレスポンス例
PUT suppliers/{supplier}/indicators リクエストの一部成功のレスポンス例は、次の通りです。
НТТР/1.1 202 Partial success Date:Mon, 23 Dec 2019 09:56:10 UTC Content-Type: application/json Content-Length: 265
[{"status": "An error occurred while adding some of the indicators to the database","error_indicators":[{"indicator":"bad\.example.com", "reason": "Invalid indicator format"},{"indicator":"bad2.example.com bad3.example.com", "reason": "Invalid indicator format"}]}] |
エラーレスポンス
エラーレスポンスには、レスポンスのステータスに関する情報が含まれます。
エラーレスポンスには、JSON オブジェクトとエラーの説明が含まれます。
[
{
"status": "An error occurred while adding indicators to the database",
}
]
次の表でエラーオブジェクトのプロパティについて説明します。
エラーオブジェクトのプロパティ
プロパティ | 値 | 説明 |
---|---|---|
|
| エラーの説明。 |
エラーレスポンスの例
PUT suppliers/{supplier} エラーのレスポンス例は、次の通りです。
HTTP/1.1 500 Internal Server Error Date:Mon, 23 Dec 2019 09:56:10 UTC Content-Type: application/json Content-Length: 73
[{"status": "An error occurred while adding indicators to the database"}] |