資産IP一覧取得

資産IPの一覧を取得します。

必要な権限

MEMBER以上のロールが必要です。

HTTPリクエスト

cURL例

curl -H "Authorization: Bearer <API_KEY>" \
     "https://HOSTNAME/api/sonar/ip-addresses?keywords=192.168.10.100&priorities=3&limit=100"

リクエストパラメータ

正常応答

{
  "addresses": [
    {
      "guid": "56654243-bd42-4b67-b21d-3cb21a86c09e",
      "ip": "192.1.1.1",
      "category_name": null,
      "category_guid": null,
      "hostname": "",
      "workgroup": "",
      "description": "重要度低",
      "priority": "low",
      "confidentiality": "low",
      "integrity": "low",
      "availability": "low",
      "emp_name": "山田太郎",
      "emp_name2": null,
      "emp_guid": "8d352716-cc2e-4e9b-8e00-4cc707ef78fe",
      "emp_guid2": null,
      "emp_key": "00001",
      "emp_key2": null,
      "dept_name": "開発2チーム",
      "dept_name2": null,
      "os_name": "",
      "os_ver": "",
      "created": "2025-08-13 21:31:55+0900",
      "updated": "2025-08-14 10:16:57+0900",
      "mac": "",
      "location": "",
      "installed": null,
      "site_guid": null,
      "site_name": null,
      "ext0": null,
      "ext1": null,
      "ext2": null,
      "ext3": null,
      "ext4": null,
      "ext5": null,
      "ext6": null,
      "ext7": null,
      "ext8": null,
      "ext9": null
    }
  ],
  "total": 11
}

• total（64ビット整数）：検索条件に一致するIPアドレスの総数
• addresses（配列）：IPアドレス一覧
  • guid（文字列）：IPアドレス一意識別子
  • ip（文字列）：IPアドレス
  • category_name（文字列）：分類名
  • category_guid（文字列）：分類GUID
  • hostname（文字列）：ホスト名
  • workgroup（文字列）：ワークグループ
  • description（文字列）：説明
  • priority（文字列）：重要度（low、medium、high）
  • confidentiality（文字列）：機密性（low、medium、high）
  • integrity（文字列）：完全性（low、medium、high）
  • availability（文字列）：可用性（low、medium、high）
  • emp_name（文字列）：担当者名（正）
  • emp_name2（文字列）：担当者名（副）
  • emp_guid（文字列）：担当者GUID（正）
  • emp_guid2（文字列）：担当者GUID（副）
  • emp_key（文字列）：担当者キー（正）
  • emp_key2（文字列）：担当者キー（副）
  • dept_name（文字列）：部署名（正）
  • dept_name2（文字列）：部署名（副）
  • os_name（文字列）：OS名
  • os_ver（文字列）：OSバージョン
  • created（文字列）：作成日時（yyyy-MM-dd HH:mm:ssZ形式）
  • updated（文字列）：更新日時（yyyy-MM-dd HH:mm:ssZ形式）
  • mac（文字列）：MACアドレス
  • location（文字列）：設置場所
  • installed（文字列）：設置日時（yyyy-MM-dd HH:mm:ssZ形式）
  • site_guid（文字列）：サイトGUID
  • site_name（文字列）：サイト名
  • ext0〜ext9（文字列）：拡張フィールド（全10個）

エラー応答

offset、limitの値が整数ではない場合

HTTPステータスコード 400

{
  "error_code": "invalid-argument",
  "error_msg": "'offset' parameter should be int type"
}

offset、limitの値が負の場合

HTTPステータスコード 400

{
  "error_code": "invalid-argument",
  "error_msg": "'offset' must be greater than or equal to 0."
}

prioritiesの値が無効な場合

HTTPステータスコード 400

{
  "error_code": "invalid-argument",
  "error_msg": "'priority' should be one of 'low', 'medium', 'high'."
}

識別子がGUID形式ではない場合

HTTPステータスコード 400

{
  "error_code": "invalid-param-type",
  "error_msg": "guid should be guid type."
}

権限がない場合

HTTPステータスコード 500

{
  "error_code": "illegal-state",
  "error_msg": "no-permission"
}