PUT suppliers/{supplier}

サポート

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

Kaspersky CyberTrace

REST API リファレンス

リクエスト

PUT suppliers/{supplier}

2024年4月11日

ID 198644

指定した脅威インジケーター情報を更新します。

REST API を使用して作成された脅威インジケーターのみを、このリクエストを使用して更新できます。

パス

/api/%API_VERSION%/suppliers/{supplier}

メソッド

PUT

リクエストヘッダー

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

リクエストヘッダー

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

リクエストのパラメータ

このリクエストには、次のパラメータがあります：

リクエストのパラメータ

名前	パラメータタイプ	説明
`supplier`	パス	脅威インジケーターの名前。

リクエストボディ

このリクエストボディには、JSON 配列と脅威インジケーターオブジェクトが含まれます。1 つの脅威インジケーターオブジェクトのみを指定する必要があります。

[

{

"name":"%SUPPLIER_NAME%",

"status":"%SUPPLIER_STATUS%,

"confidence": %SUPPLIER_CONFIDENCE%,

"retention": %SUPPLIER_RETENTION%,

"vendor": "%SUPPLIER_VENDOR%"

}

]

次の表で脅威インジケーターオブジェクトのプロパティについて説明します。

脅威インジケーターオブジェクトのプロパティ

プロパティ	値	必須	説明
`name`	`文字列`	No	脅威インジケーターの名前。
`status`	`文字列`	No	脅威インジケーターのステータス。脅威インジケーターを有効にする場合、この値は `enabled` である必要があります。脅威インジケーターを無効にする場合、この値は `disabled` である必要があります。
`confidence`	`整数`	No	この脅威インジケーターのインジケーターの信頼性レベル。
`retention`	`整数`	No	インジケーターの保持時間（分）。このパラメータにより、この脅威インジケーターのインジケーターがマッチングで使用されなくなるまでの期間が決定されます。
`vendor`	`文字列`	No	脅威インジケーターのベンダー名。

リクエスト例

PUT suppliers/{supplier} リクエストの例は、次の通りです。

PUT https://192.0.2.57/api/1.1/suppliers/ExampleSupplier

Accept: application/json

Content-Type: application/json

Authorization: Basic dXNlcjpwYXNzd29yZA==

Content-Length: 41

[

{"name":"NewName", "confidence": 90}

]

レスポンスヘッダー

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

レスポンスヘッダー

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

レスポンスボディ

レスポンスボディには、JSON オブジェクトと操作のステータスが含まれます。

[

{

"status": "Supplier info successfully updated"

}

]

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

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

プロパティ	値	説明
`status`	`文字列`	操作のステータス。

レスポンス例

PUT suppliers/{supplier} リクエストのレスポンス例は、次の通りです。

НТТР/1.1 201 ОК

Date:Mon, 23 Dec 2019 09:56:10 UTC

Content-Type: application/json

Content-Length: 46

[{"status": "Supplier info successfully updated"}]

エラーレスポンス

エラーレスポンスには、レスポンスのステータスに関する情報が含まれます。

エラーレスポンスには、JSON オブジェクトとエラーの説明が含まれます。

[

{

"status": "An error occurred while updating Supplier info",

"reason": "%REASON%"

}

]

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

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

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

エラーレスポンスの例

PUT suppliers/{supplier} エラーのレスポンス例は、次の通りです。

НТТР/1.1 404 Supplier doesn't exist

Date:Mon, 23 Dec 2019 09:56:10 UTC

Content-Type: application/json

Content-Length: 93

[{"status": "An error occurred while updating supplier info", "reason": "Supplier doesn't exist"}]

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

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

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