POST ルックアップ

サポート

法人向けアプリケーション

Kaspersky CyberTrace

REST API リファレンス

リクエスト

POST ルックアップ

2024年4月11日

ID 198540

インジケーター検索を実行します。

パス

/api/%API_VERSION%/lookup

メソッド

POST

リクエストヘッダー

このリクエストには、次のヘッダーがあります。

リクエストヘッダー

名前	値	説明
`Authorization`	`string (base 64)`	認証文字列。
`Accept`	`application/json`	レスポンスのコンテンツタイプ。
`Content-Type`	`application/json`	リクエストのコンテンツタイプ。 `utf-8` charset タイプを指定することもできます。例：`Content-Type: application/json; charset=utf-8`
`Content-Length`	`integer`	リクエストボディのサイズ（バイト）。このリクエストボディの最大サイズは、64 MB（`67108864`）です。

リクエストボディ

このリクエストボディには、検索対象のオブジェクトの JSON 配列が含まれます。少なくとも 1 つのオブジェクトを指定する必要があります。

[{"object":"%OBJECT_VALUE%"},...{"object":"%OBJECT_VALUE%"}]

次の表でオブジェクトのプロパティについて説明します。

オブジェクトのプロパティ

プロパティ	値	必須	説明
`object`	`string`	Yes	検索対象のオブジェクト。

リクエスト例

POST lookup リクエストの例は、次の通りです：

POST https://192.0.2.57/api/1.1/lookup

Accept: application/json

Content-Type: application/json

Authorization: Basic dXNlcjpwYXNzd29yZA==

Content-Length: 81

[{"object":"http:\/\/example.com"},{"object":"C1153422C5F68E731347F6A33F791598"}]

レスポンスヘッダー

このレスポンスには、次のヘッダーがあります。

レスポンスヘッダー

名前	値	説明
Content-Type	`application/json`	レスポンスのコンテンツタイプ。
Content-Length	`integer`	レスポンスボディのサイズ（バイト）。

レスポンスボディ

レスポンスボディには、検索結果オブジェクトの 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%",

...

}

...

]

}

]

次の表で検索結果オブジェクトのプロパティについて説明します。

検索結果オブジェクトのプロパティ

プロパティ	値	説明
`object`	`string`	検索されたオブジェクト。
`result`	`文字列`	検索結果。設定できる値は以下の通りです： detected インジケーターとの一致が検知されました。 not detected インジケーターとの一致が検知されませんでした。 error 検索中にエラーが発生しました。
`categories`	`array`	次に説明する、カテゴリオブジェクトの配列。このプロパティが含まれるのは、result が`「detected」`の場合です。
`reason`	`文字列`	エラーの原因。

次の表でカテゴリオブジェクトのプロパティについて説明します。

カテゴリオブジェクトのプロパティ

プロパティ	値	説明
`category`	`文字列`	検知カテゴリ。
`detected_indicator`	`string`	一致したインジケーター。
`context`	`配列`	コンテキストオブジェクトの配列。

次の表でコンテキストオブジェクトのプロパティについて説明します。

コンテキストオブジェクトのプロパティ

プロパティ	値	説明
`%field_name%`	`文字列`	プロパティの名前は、一致したインジケーターのフィールドの名前に対応しています。プロパティの値には、フィールドの値が含まれます。

プロパティ

値

説明

%field_name%

文字列

プロパティの名前は、一致したインジケーターのフィールドの名前に対応しています。

プロパティの値には、フィールドの値が含まれます。

レスポンス例

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%"

}

]

次の表でエラーオブジェクトのプロパティについて説明します。

エラーオブジェクトのプロパティ

プロパティ	値	説明
`status`	`文字列`	エラーの説明。
`reason`	`文字列`	エラーの原因。

エラーレスポンスの例

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"}]

この記事はお役に立ちましたか？

改善できる点がありましたらお聞かせください。

フィードバックをいただき、ありがとうございました。改善に向けて取り組んでまいります。