POST ルックアップ
2024年8月22日
ID 198540
インジケーター検索を実行します。
パス
/api/%API_VERSION%/lookup
メソッド
POST
リクエストヘッダー
このリクエストには、次のヘッダーがあります。
リクエストヘッダー
名前 | 値 | 説明 |
---|---|---|
|
| |
|
| レスポンスのコンテンツタイプ。 |
|
| リクエストのコンテンツタイプ。
|
|
| リクエストボディのサイズ(バイト)。 このリクエストボディの最大サイズは、64 MB( |
リクエストボディ
このリクエストボディには、検索対象のオブジェクトの JSON 配列が含まれます。少なくとも 1 つのオブジェクトを指定する必要があります。
[{"object":"%OBJECT_VALUE%"},...{"object":"%OBJECT_VALUE%"}]
次の表でオブジェクトのプロパティについて説明します。
オブジェクトのプロパティ
プロパティ | 値 | 必須 | 説明 |
---|---|---|---|
|
| Yes | 検索対象のオブジェクト。 |
リクエスト例
POST lookup リクエストの例は、次の通りです:
POST https://192.0.2.57/api/1.1/lookup
Accept: application/json Content-Type: application/json Authorization: Basic Content-Length: 81
[{"object":"http:\/\/example.com"},{"object":"C1153422C5F68E731347F6A33F791598"}] |
レスポンスヘッダー
このレスポンスには、次のヘッダーがあります。
レスポンスヘッダー
名前 | 値 | 説明 |
---|---|---|
Content-Type |
| レスポンスのコンテンツタイプ。 |
Content-Length |
| レスポンスボディのサイズ(バイト)。 |
レスポンスボディ
レスポンスボディには、検索結果オブジェクトの JSON 配列が含まれます。
[
{
"object": "%OBJECT_VALUE%",
"result": "%LOOKUP_RESULT%",
"categories":
[
{
"category": "%CATEGORY_1%",
"detected_indicator": "%DETECTED_INDICATOR%",
"context":
{
"%supplier_field_1%": "%supplier_field_1_value%",
...
"%supplier_field_N%": "%supplier_field_N_value%"
}
},
...
{
"category": "%CATEGORY_N%",
"detected_indicator": "%DETECTED_INDICATOR%",
"context":
{
"%supplier_field_1%": "%supplier_field_1_value%",
...
"%supplier_field_N%": "%supplier_field_N_value%"
}
}
]
},
...
{
"object": "%OBJECT_VALUE%",
"result": "%LOOKUP_RESULT%",
"categories":
[
{
"category": "%CATEGORY_1%",
"detected_indicator": "%DETECTED_INDICATOR%",
"context":
{
"%supplier_field_1%": "%supplier_field_1_value%",
...
}
},
...
]
}
]
次の表で検索結果オブジェクトのプロパティについて説明します。
検索結果オブジェクトのプロパティ
プロパティ | 値 | 説明 |
---|---|---|
|
| 検索されたオブジェクト。 |
|
| 検索結果。 設定できる値は以下の通りです:
|
|
| 次に説明する、カテゴリオブジェクトの配列。 このプロパティが含まれるのは、result が |
|
| エラーの原因。 |
次の表でカテゴリオブジェクトのプロパティについて説明します。
カテゴリオブジェクトのプロパティ
プロパティ | 値 | 説明 |
---|---|---|
|
| 検知カテゴリ。 |
|
| 一致したインジケーター。 |
|
| コンテキストオブジェクトの配列。 |
次の表でコンテキストオブジェクトのプロパティについて説明します。
コンテキストオブジェクトのプロパティ
プロパティ | 値 | 説明 |
---|---|---|
|
| プロパティの名前は、一致したインジケーターのフィールドの名前に対応しています。 プロパティの値には、フィールドの値が含まれます。 |
レスポンス例
POST lookup リクエストのレスポンスの例は、次の通りです:
НТТР/1.1 200 ОК Date:Mon, 23 Dec 2019 09:56:10 UTC Content-Type: application/json Content-Length: 372
[{"object":"http:\/\/example.com","result":"not detected"}, {"object":"C1153422C5F68E731347F6A33F791598","result":"detected", "detects": [{"category":"KL_Malicious_Hash","detected_indicator":"C1153422C5F68E731347F6A33F791598","context":{"first_seen":"10.07.2015 23:53","threat":"Trojan.Win32.Generic"}}]} ] |
エラーレスポンス
エラーレスポンスには、レスポンスのステータスに関する情報が含まれます。
エラーレスポンスには、JSON オブジェクトとエラーの説明が含まれます。
[
{
"status": "%ERROR%"
}
]
次の表でエラーオブジェクトのプロパティについて説明します。
エラーオブジェクトのプロパティ
プロパティ | 値 | 説明 |
---|---|---|
|
| エラーの説明。 |
|
| エラーの原因。 |
エラーレスポンスの例
POST lookup エラーレスポンスの例は、次の通りです:
НТТР/1.1 500 Internal Server Error Date:Mon, 23 Dec 2019 09:56:10 UTC Content-Type: application/json Content-Length: 75
[{"status": "An error occurred while creating supplier", "reason": "Supplier already exists"}] |