Get Address Groups

Gets a list of available address groups.

Required Permissions

Requires the MEMBER role or higher.

HTTP Request

cURL Example

curl -H "Authorization: Bearer <API_KEY>" \
     "https://HOSTNAME/api/sonar/address-groups?offset=0&limit=20"

Request Parameters

Success Response

{
  "total_count": 1,
  "address_groups": [
    {
      "guid": "4dc14f3d-ebf8-4032-8a7a-ef9ec6cd3dd2",
      "name": "방화벽 차단 IP",
      "description": "차단 연동용 IP 블랙리스트",
      "count": 1,
      "version": 7,
      "created": "2022-10-05 15:34:59+0900",
      "updated": "2022-10-06 00:46:35+0900"
    }
  ]
}

• total_count (32-bit integer): Total number of address groups that match the search keyword
• address_groups (Array): Paged list of address groups that match the search keyword
  • guid (String): Address group GUID
  • name (String): Address group name
  • description (String): Address group description
  • count (32-bit integer): Number of 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)

Error Responses

offset or limit value is not an integer

HTTP status code 400

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

offset or limit value is negative

HTTP status code 400

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