Get Address Group

Retrieves information of a specified address group.

HTTP Request

GET /api/sonar/address-groups/:guid
Request using cURL
curl -H "Authorization: Bearer <API_KEY>" \
     https://HOSTNAME/api/sonar/address-groups/4dc14f3d-ebf8-4032-8a7a-ef9ec6cd3dd2
Request Parameter
KeyRequiredTypeDescriptionNote
guidOStringAddress group GUID36 characters

Success Response

{
  "address_group": {
    "guid": "4dc14f3d-ebf8-4032-8a7a-ef9ec6cd3dd2",
    "company_guid": "6fbe27b7-f1ae-4d7a-a1a5-76d8fa9aa311",
    "company_name": "로그프레소",
    "name": "방화벽 차단 IP",
    "description": "차단 연동용 IP 블랙리스트",
    "count": 1,
    "version": 7,
    "created": "2022-10-05 15:34:59+0900",
    "updated": "2022-10-06 00:46:35+0900"
  }
}
  • address_group (Map): Specified address group
    • guid (String): Address group GUID
    • company_guid (String): GUID of the company to which the address group belongs
    • company_name (String): Name of the company to which the address group belongs
    • name (String): Address group name
    • description (String): Address group description
    • count (32-bit integer): Number of IP addresses in the address group
    • version (32-bit integer): Monotonically increasing version number
    • created (String): Date and time of creation (yyyy-MM-dd HH:mm:ssZ)
    • updated (String): Date and time of last modification (yyyy-MM-dd HH:mm:ssZ)
Address group is not found

HTTP status code 200

{
  "address_group": null
}
Identifier is not in valid GUID format
{
  "error_code": "invalid-param-type",
  "error_msg": "guid should be guid type."
}