SIEM HTTP Destination Events

A SiemHttpDestinationEvent is a log record for SIEM publishing failures and recoveries.

List SIEM HTTP Destination Events

SDK Method

Files::SiemHttpDestinationEvent.list

Return Object

List<SiemHttpDestinationEvent>

Authorization Requirement

Requires either a Site-Wide API key or User API key or session from a User with Site Admin permissions.

Additional Arguments

Example Request

begin
  siem_http_destination_events = Files::SiemHttpDestinationEvent.list
  siem_http_destination_events.auto_paging_each do |siem_http_destination_event|
    # Operate on siem_http_destination_event
  end
rescue Files::NotAuthenticatedError => e
  puts "Authentication Error Occurred (#{e.class.to_s}): " + e.message
rescue Files::Error => e
  puts "Unknown Error Occurred (#{e.class.to_s}): " + e.message
end

Show SIEM HTTP Destination Event

SDK Method

Files::SiemHttpDestinationEvent.find

Return Object

SiemHttpDestinationEvent

Authorization Requirement

Requires either a Site-Wide API key or User API key or session from a User with Site Admin permissions.

Method Arguments

ArgumentDescription
id
int64
Required		Siem Http Destination Event ID.

Example Request

begin
  siem_http_destination_event = Files::SiemHttpDestinationEvent.find(id)
  # Operate on siem_http_destination_event
rescue Files::NotAuthenticatedError => e
  puts "Authentication Error Occurred (#{e.class.to_s}): " + e.message
rescue Files::Error => e
  puts "Unknown Error Occurred (#{e.class.to_s}): " + e.message
end

The SiemHttpDestinationEvent Object

Some of the methods above return a SiemHttpDestinationEvent object. The attributes of this object are listed below.

AttributeDescription
id
int64		Event ID
event_type
string		Type of SIEM event being recorded.
status
string		Status of event.
Possible values: success, failure, partial_failure, in_progress, skipped
body
string		Event body.
event_errors
array(string)		Event errors.
created_at
date-time		Event create date/time.
body_url
string		Link to log file.
siem_http_destination_id
int64		SIEM ID.