PUT tags/{tag}

2024年4月11日

ID 222791

指定したタグを更新します。

パス

api/%API_VERSION%/tags/{tag}

メソッド

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)です。

リクエストのパラメータ

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

リクエストのパラメータ

名前

パラメータタイプ

説明

tag

パス

タグの名前。

リクエストボディ

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

[

{

"name":"%TAG_NAME%",

"weight": TAG_WEIGHT

}

]

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

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

プロパティ

必須

説明

name

文字列

No

タグの名前。

タグ名の長さは 1 ~ 128 文字にする必要があります。タグ名には、ラテン文字、数字、ハイフン(-)、アンダースコア(_)を含めることができます。新しいタグに既存のタグの名前を使用することはできません。

タグ名を変更する場合、文字が大文字に変換されます。

weight

整数

No

タグの重要性(0(最も低い重要性)~ 5(最も高い重要性))。

リクエスト例

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

PUT https://192.0.2.57/api/1.1/tags/WIN-TROJAN

Accept: application/json

Content-Type: application/json

Authorization: Basic AWxhZGRpbjpvcGVuc2VzYW23

Content-Length: 150

[

{

"name": "TROJAN",

"weight": 4

}

]

レスポンスヘッダー

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

レスポンスヘッダー

名前

説明

Content-Type

application/json

レスポンスのコンテンツタイプ。

Content-Length

integer

レスポンスボディのサイズ(バイト)。

レスポンスボディ

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

[

{

"status": "Tag successfully updated"

}

]

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

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

プロパティ

説明

status

文字列

操作のステータス。

レスポンス例

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

НТТР/1.1 200 ОК

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

Content-Type: application/json

Content-Length: 150

[

{

"status": "Tag successfully updated"

}

]

エラーレスポンス

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

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

[

{

"status": "An error occurred while updating tag",

"reason": "%REASON%"

}

]

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

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

プロパティ

説明

status

文字列

エラーの説明。

reason

文字列

エラーの理由。

このプロパティは欠落している場合があります。

エラーレスポンスの例

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

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

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

Content-Type: application/json

Content-Length: 150

[

{

"status": "An error occurred while updating tag",

"reason": "Tag doesn't exist"

}

]

この記事はお役に立ちましたか?
改善できる点がありましたらお聞かせください。
フィードバックをいただき、ありがとうございました。改善に向けて取り組んでまいります。
フィードバックをいただき、ありがとうございました。改善に向けて取り組んでまいります。