Help us improve your experience.

Let us know what you think.

Do you have time for a two-minute survey?

 
 

GET /siem/local_destination_addresses/{local_ destination_address_id}

Retrieve an offense local destination address.

Retrieve an offense local destination address.

Table 1: GET /siem/local_destination_addresses/{local_destination_address_id} Resource Details

MIME Type

application/json

Table 2: GET /siem/local_destination_addresses/{local_destination_address_id} Request Parameter Details

Parameter

Type

Optionality

Data Type

MIME Type

Description

local_

destination_

address_id

path

Required

Number (Integer)

text/plain

Required - The ID of the local destination address to retrieve.

fields

query

Optional

String

text/plain

Optional - Use this parameter to specify which fields you would like to get back in the response. Fields that are not named are excluded. Specify subfields in brackets and multiple fields in the same object are separated by commas.

Table 3: GET /siem/local_destination_addresses/{local_destination_address_id} Response Codes

HTTP Response Code

Unique Code

Description

200

 

The local destination was retrieved.

404

1002

No local destination address was found for the provided local_destination_address_id.

422

1005

A request parameter is not valid.

500

1020

An error occurred while the local destination address was being retrieved.

Response Description

A local destination address object. A local destination address object contains the following fields:

  • id - Number - The ID of the destination address.

  • local_destination_ip - String - The IP address.

  • magnitude - Number - The magnitude of the destination address.

  • network - String - The network of the destination address.

  • offense_ids - Array of Numbers - List of offense IDs the destination address is part of.

  • source_address_ids - Array of Numbers - List of source address IDs associated with the destination address.

  • event_flow_count - Number - The number of events and flows that are associated with the destination address.

  • first_event_flow_seen - Number - The number of milliseconds since epoch when the first event or flow was seen.

  • last_event_flow_seen - Number - The number of milliseconds since epoch when the last event or flow was seen.

  • domain_id - Number - The ID of associated domain.

Response Sample