GET tags

2024年4月11日

ID 222773

タグのリストを取得します。

パス

/api/%API_VERSION%/tags

メソッド

GET

リクエストヘッダー

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

リクエストヘッダー

名前

説明

Authorization

string (base 64)

認証文字列

Accept

application/json

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

リクエストボディ

このリクエストには、空のボディがあります。

リクエスト例

GET tags リクエストの例は、次の通りです。

GET https://192.0.2.57/api/1.1/tags

Accept: application/json

Authorization: Basic AWxhZGRpbjpvcGVuc2VzYW23

レスポンスヘッダー

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

レスポンスヘッダー

名前

説明

Content-Type

application/json

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

Content-Length

integer

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

レスポンスボディ

レスポンスボディには、タグオブジェクトが含まれる JSON 配列が含まれます。

[

{

"name": "%TAG_NAME_1%",

"weight": %TAG_WEIGHT_1%

},

...

{

"name": "%TAG_NAME_N%",

"weight": %TAG_WEIGHT_N%

}

]

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

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

プロパティ

説明

name

文字列

タグの名前。

weight

整数

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

レスポンス例

GET tags リクエストのレスポンスの例は、次の通りです。

НТТР/1.1 200 ОК

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

Content-Type: application/json

Content-Length: 150

[

{

"name": "WIN-TROJAN",

"weight": 5

},

{

"name": "KASPERSKY",

"weight": 5

},

{

"name": "OSINT",

"weight": 2

}

]

エラーレスポンス

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

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

[

{

"status": "An error occurred while getting tags list";

"reason": "%REASON%"

}

]

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

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

プロパティ

説明

status

文字列

エラーの説明。

reason

文字列

エラーの理由。

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

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