Get Address Objects

Gets a list of address objects in a specified address group.

HTTP Request

GET /api/sonar/address-groups/:guid/addresses
Request using cURL
curl -H "Authorization: Bearer <API_KEY>" \
     https://HOSTNAME/api/sonar/address-groups/8df64276-a16e-4bae-93cd-c207c8155159/addresses
Request Parameters
KeyRequiredTypeDescriptionNote
guidOStringAddress group GUID36 characters
offsetX32-bit integerNumber of records to skipDefault: 0
limitX32-bit integerMaximum number of records to loadDefault: 50
keywordsXStringKeywordsSearch available by ip, description

Success Response

{
  "total_count": 1,
  "addresses": [
    {
      "guid": "d4915ba2-763f-4ec0-a875-38b292a99a24",
      "ip": "20.214.237.145",
      "country": "US",
      "count": 1,
      "description": "Web app attack",
      "created": "2022-11-07 01:30:40+0900",
      "updated": "2022-11-07 01:30:40+0900"
    }
  ]
}
  • total_count (32-bit integer): Total number of addresses that match the search keywords
  • addresses (Array): Address list
    • guid (String): Address GUID
    • ip (String): IP address
    • country (String): Source country (ISO 2-digit country code)
    • count (32-bit integer): Hit count
    • description (String): Description
    • 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."
}