Class: Files::SiemHttpDestination

Inherits:
Object
  • Object
show all
Defined in:
lib/files.com/models/siem_http_destination.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}, options = {}) ⇒ SiemHttpDestination

Returns a new instance of SiemHttpDestination.



7
8
9
10
 
# File 'lib/files.com/models/siem_http_destination.rb', line 7

def initialize(attributes = {}, options = {})
  @attributes = attributes || {}
  @options = options || {}
end

Instance Attribute Details

#attributes ⇒ Object (readonly)

Returns the value of attribute attributes.



5
6
7
 
# File 'lib/files.com/models/siem_http_destination.rb', line 5

def attributes
  @attributes
end

#options ⇒ Object (readonly)

Returns the value of attribute options.



5
6
7
 
# File 'lib/files.com/models/siem_http_destination.rb', line 5

def options
  @options
end

Class Method Details

.all(params = {}, options = {}) ⇒ Object 



671
672
673
 
# File 'lib/files.com/models/siem_http_destination.rb', line 671

def self.all(params = {}, options = {})
  list(params, options)
end

.create(params = {}, options = {}) ⇒ Object

Parameters:

name - string - Name for this Destination
additional_headers - object - Additional HTTP Headers included in calls to the destination URL
sending_active - boolean - Whether this SIEM HTTP Destination is currently being sent to or not
generic_payload_type - string - Applicable only for destination type: generic. Indicates the type of HTTP body. Can be json_newline or json_array. json_newline is multiple log entries as JSON separated by newlines. json_array is a single JSON array containing multiple log entries as JSON.
file_destination_path - string - Applicable only for destination type: file. Destination folder path on Files.com.
file_format - string - Applicable only for destination type: file. Generated file format.
file_interval_minutes - int64 - Applicable only for destination type: file. Interval, in minutes, between file deliveries. Valid values are 5, 10, 15, 20, 30, 60, 90, 180, 240, 360.
splunk_token - string - Applicable only for destination types: splunk, splunk_compatible. Authentication token for the destination.
crowdstrike_token - string - Applicable only for destination type: crowdstrike. Authentication token provided by Crowdstrike.
azure_dcr_immutable_id - string - Applicable only for destination types: azure, azure_legacy. Immutable ID of the Data Collection Rule.
azure_stream_name - string - Applicable only for destination type: azure. Name of the stream in the DCR that represents the destination table.
azure_oauth_client_credentials_tenant_id - string - Applicable only for destination types: azure, azure_legacy. Client Credentials OAuth Tenant ID.
azure_oauth_client_credentials_client_id - string - Applicable only for destination types: azure, azure_legacy. Client Credentials OAuth Client ID.
azure_oauth_client_credentials_client_secret - string - Applicable only for destination type: azure. Client Credentials OAuth Client Secret.
qradar_username - string - Applicable only for destination type: qradar. Basic auth username provided by QRadar.
qradar_password - string - Applicable only for destination type: qradar. Basic auth password provided by QRadar.
solar_winds_token - string - Applicable only for destination type: solar_winds. Authentication token provided by Solar Winds.
new_relic_api_key - string - Applicable only for destination type: new_relic. API key provided by New Relic.
datadog_api_key - string - Applicable only for destination type: datadog. API key provided by Datadog.
action_send_enabled - boolean - Whether or not sending is enabled for action logs.
sftp_action_send_enabled - boolean - Whether or not sending is enabled for sftp_action logs.
ftp_action_send_enabled - boolean - Whether or not sending is enabled for ftp_action logs.
web_dav_action_send_enabled - boolean - Whether or not sending is enabled for web_dav_action logs.
sync_send_enabled - boolean - Whether or not sending is enabled for sync logs.
outbound_connection_send_enabled - boolean - Whether or not sending is enabled for outbound_connection logs.
automation_send_enabled - boolean - Whether or not sending is enabled for automation logs.
api_request_send_enabled - boolean - Whether or not sending is enabled for api_request logs.
public_hosting_request_send_enabled - boolean - Whether or not sending is enabled for public_hosting_request logs.
email_send_enabled - boolean - Whether or not sending is enabled for email logs.
exavault_api_request_send_enabled - boolean - Whether or not sending is enabled for exavault_api_request logs.
settings_change_send_enabled - boolean - Whether or not sending is enabled for settings_change logs.
destination_type (required) - string - Destination Type
destination_url - string - Destination Url

Raises:



725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
 
# File 'lib/files.com/models/siem_http_destination.rb', line 725

def self.create(params = {}, options = {})
  raise InvalidParameterError.new("Bad parameter: name must be an String") if params[:name] and !params[:name].is_a?(String)
  raise InvalidParameterError.new("Bad parameter: additional_headers must be an Hash") if params[:additional_headers] and !params[:additional_headers].is_a?(Hash)
  raise InvalidParameterError.new("Bad parameter: generic_payload_type must be an String") if params[:generic_payload_type] and !params[:generic_payload_type].is_a?(String)
  raise InvalidParameterError.new("Bad parameter: file_destination_path must be an String") if params[:file_destination_path] and !params[:file_destination_path].is_a?(String)
  raise InvalidParameterError.new("Bad parameter: file_format must be an String") if params[:file_format] and !params[:file_format].is_a?(String)
  raise InvalidParameterError.new("Bad parameter: file_interval_minutes must be an Integer") if params[:file_interval_minutes] and !params[:file_interval_minutes].is_a?(Integer)
  raise InvalidParameterError.new("Bad parameter: splunk_token must be an String") if params[:splunk_token] and !params[:splunk_token].is_a?(String)
  raise InvalidParameterError.new("Bad parameter: crowdstrike_token must be an String") if params[:crowdstrike_token] and !params[:crowdstrike_token].is_a?(String)
  raise InvalidParameterError.new("Bad parameter: azure_dcr_immutable_id must be an String") if params[:azure_dcr_immutable_id] and !params[:azure_dcr_immutable_id].is_a?(String)
  raise InvalidParameterError.new("Bad parameter: azure_stream_name must be an String") if params[:azure_stream_name] and !params[:azure_stream_name].is_a?(String)
  raise InvalidParameterError.new("Bad parameter: azure_oauth_client_credentials_tenant_id must be an String") if params[:azure_oauth_client_credentials_tenant_id] and !params[:azure_oauth_client_credentials_tenant_id].is_a?(String)
  raise InvalidParameterError.new("Bad parameter: azure_oauth_client_credentials_client_id must be an String") if params[:azure_oauth_client_credentials_client_id] and !params[:azure_oauth_client_credentials_client_id].is_a?(String)
  raise InvalidParameterError.new("Bad parameter: azure_oauth_client_credentials_client_secret must be an String") if params[:azure_oauth_client_credentials_client_secret] and !params[:azure_oauth_client_credentials_client_secret].is_a?(String)
  raise InvalidParameterError.new("Bad parameter: qradar_username must be an String") if params[:qradar_username] and !params[:qradar_username].is_a?(String)
  raise InvalidParameterError.new("Bad parameter: qradar_password must be an String") if params[:qradar_password] and !params[:qradar_password].is_a?(String)
  raise InvalidParameterError.new("Bad parameter: solar_winds_token must be an String") if params[:solar_winds_token] and !params[:solar_winds_token].is_a?(String)
  raise InvalidParameterError.new("Bad parameter: new_relic_api_key must be an String") if params[:new_relic_api_key] and !params[:new_relic_api_key].is_a?(String)
  raise InvalidParameterError.new("Bad parameter: datadog_api_key must be an String") if params[:datadog_api_key] and !params[:datadog_api_key].is_a?(String)
  raise InvalidParameterError.new("Bad parameter: destination_type must be an String") if params[:destination_type] and !params[:destination_type].is_a?(String)
  raise InvalidParameterError.new("Bad parameter: destination_url must be an String") if params[:destination_url] and !params[:destination_url].is_a?(String)
  raise MissingParameterError.new("Parameter missing: destination_type") unless params[:destination_type]

  response, options = Api.send_request("/siem_http_destinations", :post, params, options)
  SiemHttpDestination.new(response.data, options)
end

.delete(id, params = {}, options = {}) ⇒ Object

Raises:



878
879
880
881
882
883
884
885
886
 
# File 'lib/files.com/models/siem_http_destination.rb', line 878

def self.delete(id, params = {}, options = {})
  params ||= {}
  params[:id] = id
  raise InvalidParameterError.new("Bad parameter: id must be an Integer") if params[:id] and !params[:id].is_a?(Integer)
  raise MissingParameterError.new("Parameter missing: id") unless params[:id]

  Api.send_request("/siem_http_destinations/#{params[:id]}", :delete, params, options)
  nil
end

.destroy(id, params = {}, options = {}) ⇒ Object 



888
889
890
891
 
# File 'lib/files.com/models/siem_http_destination.rb', line 888

def self.destroy(id, params = {}, options = {})
  delete(id, params, options)
  nil
end

.find(id, params = {}, options = {}) ⇒ Object

Parameters:

id (required) - int64 - Siem Http Destination ID.

Raises:



677
678
679
680
681
682
683
684
685
 
# File 'lib/files.com/models/siem_http_destination.rb', line 677

def self.find(id, params = {}, options = {})
  params ||= {}
  params[:id] = id
  raise InvalidParameterError.new("Bad parameter: id must be an Integer") if params[:id] and !params[:id].is_a?(Integer)
  raise MissingParameterError.new("Parameter missing: id") unless params[:id]

  response, options = Api.send_request("/siem_http_destinations/#{params[:id]}", :get, params, options)
  SiemHttpDestination.new(response.data, options)
end

.get(id, params = {}, options = {}) ⇒ Object 



687
688
689
 
# File 'lib/files.com/models/siem_http_destination.rb', line 687

def self.get(id, params = {}, options = {})
  find(id, params, options)
end

.list(params = {}, options = {}) ⇒ Object

Parameters:

cursor - string - Used for pagination.  When a list request has more records available, cursors are provided in the response headers `X-Files-Cursor-Next` and `X-Files-Cursor-Prev`.  Send one of those cursor value here to resume an existing list from the next available record.  Note: many of our SDKs have iterator methods that will automatically handle cursor-based pagination.
per_page - int64 - Number of records to show per page.  (Max: 10000, 1,000 or less is recommended).

Raises:



662
663
664
665
666
667
668
669
 
# File 'lib/files.com/models/siem_http_destination.rb', line 662

def self.list(params = {}, options = {})
  raise InvalidParameterError.new("Bad parameter: cursor must be an String") if params[:cursor] and !params[:cursor].is_a?(String)
  raise InvalidParameterError.new("Bad parameter: per_page must be an Integer") if params[:per_page] and !params[:per_page].is_a?(Integer)

  List.new(SiemHttpDestination, params) do
    Api.send_request("/siem_http_destinations", :get, params, options)
  end
end

.send_test_entry(params = {}, options = {}) ⇒ Object

Parameters:

siem_http_destination_id - int64 - SIEM HTTP Destination ID
destination_type - string - Destination Type
destination_url - string - Destination Url
name - string - Name for this Destination
additional_headers - object - Additional HTTP Headers included in calls to the destination URL
sending_active - boolean - Whether this SIEM HTTP Destination is currently being sent to or not
generic_payload_type - string - Applicable only for destination type: generic. Indicates the type of HTTP body. Can be json_newline or json_array. json_newline is multiple log entries as JSON separated by newlines. json_array is a single JSON array containing multiple log entries as JSON.
file_destination_path - string - Applicable only for destination type: file. Destination folder path on Files.com.
file_format - string - Applicable only for destination type: file. Generated file format.
file_interval_minutes - int64 - Applicable only for destination type: file. Interval, in minutes, between file deliveries. Valid values are 5, 10, 15, 20, 30, 60, 90, 180, 240, 360.
splunk_token - string - Applicable only for destination types: splunk, splunk_compatible. Authentication token for the destination.
crowdstrike_token - string - Applicable only for destination type: crowdstrike. Authentication token provided by Crowdstrike.
azure_dcr_immutable_id - string - Applicable only for destination types: azure, azure_legacy. Immutable ID of the Data Collection Rule.
azure_stream_name - string - Applicable only for destination type: azure. Name of the stream in the DCR that represents the destination table.
azure_oauth_client_credentials_tenant_id - string - Applicable only for destination types: azure, azure_legacy. Client Credentials OAuth Tenant ID.
azure_oauth_client_credentials_client_id - string - Applicable only for destination types: azure, azure_legacy. Client Credentials OAuth Client ID.
azure_oauth_client_credentials_client_secret - string - Applicable only for destination type: azure. Client Credentials OAuth Client Secret.
qradar_username - string - Applicable only for destination type: qradar. Basic auth username provided by QRadar.
qradar_password - string - Applicable only for destination type: qradar. Basic auth password provided by QRadar.
solar_winds_token - string - Applicable only for destination type: solar_winds. Authentication token provided by Solar Winds.
new_relic_api_key - string - Applicable only for destination type: new_relic. API key provided by New Relic.
datadog_api_key - string - Applicable only for destination type: datadog. API key provided by Datadog.
action_send_enabled - boolean - Whether or not sending is enabled for action logs.
sftp_action_send_enabled - boolean - Whether or not sending is enabled for sftp_action logs.
ftp_action_send_enabled - boolean - Whether or not sending is enabled for ftp_action logs.
web_dav_action_send_enabled - boolean - Whether or not sending is enabled for web_dav_action logs.
sync_send_enabled - boolean - Whether or not sending is enabled for sync logs.
outbound_connection_send_enabled - boolean - Whether or not sending is enabled for outbound_connection logs.
automation_send_enabled - boolean - Whether or not sending is enabled for automation logs.
api_request_send_enabled - boolean - Whether or not sending is enabled for api_request logs.
public_hosting_request_send_enabled - boolean - Whether or not sending is enabled for public_hosting_request logs.
email_send_enabled - boolean - Whether or not sending is enabled for email logs.
exavault_api_request_send_enabled - boolean - Whether or not sending is enabled for exavault_api_request logs.
settings_change_send_enabled - boolean - Whether or not sending is enabled for settings_change logs.

Raises:



787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
 
# File 'lib/files.com/models/siem_http_destination.rb', line 787

def self.send_test_entry(params = {}, options = {})
  raise InvalidParameterError.new("Bad parameter: siem_http_destination_id must be an Integer") if params[:siem_http_destination_id] and !params[:siem_http_destination_id].is_a?(Integer)
  raise InvalidParameterError.new("Bad parameter: destination_type must be an String") if params[:destination_type] and !params[:destination_type].is_a?(String)
  raise InvalidParameterError.new("Bad parameter: destination_url must be an String") if params[:destination_url] and !params[:destination_url].is_a?(String)
  raise InvalidParameterError.new("Bad parameter: name must be an String") if params[:name] and !params[:name].is_a?(String)
  raise InvalidParameterError.new("Bad parameter: additional_headers must be an Hash") if params[:additional_headers] and !params[:additional_headers].is_a?(Hash)
  raise InvalidParameterError.new("Bad parameter: generic_payload_type must be an String") if params[:generic_payload_type] and !params[:generic_payload_type].is_a?(String)
  raise InvalidParameterError.new("Bad parameter: file_destination_path must be an String") if params[:file_destination_path] and !params[:file_destination_path].is_a?(String)
  raise InvalidParameterError.new("Bad parameter: file_format must be an String") if params[:file_format] and !params[:file_format].is_a?(String)
  raise InvalidParameterError.new("Bad parameter: file_interval_minutes must be an Integer") if params[:file_interval_minutes] and !params[:file_interval_minutes].is_a?(Integer)
  raise InvalidParameterError.new("Bad parameter: splunk_token must be an String") if params[:splunk_token] and !params[:splunk_token].is_a?(String)
  raise InvalidParameterError.new("Bad parameter: crowdstrike_token must be an String") if params[:crowdstrike_token] and !params[:crowdstrike_token].is_a?(String)
  raise InvalidParameterError.new("Bad parameter: azure_dcr_immutable_id must be an String") if params[:azure_dcr_immutable_id] and !params[:azure_dcr_immutable_id].is_a?(String)
  raise InvalidParameterError.new("Bad parameter: azure_stream_name must be an String") if params[:azure_stream_name] and !params[:azure_stream_name].is_a?(String)
  raise InvalidParameterError.new("Bad parameter: azure_oauth_client_credentials_tenant_id must be an String") if params[:azure_oauth_client_credentials_tenant_id] and !params[:azure_oauth_client_credentials_tenant_id].is_a?(String)
  raise InvalidParameterError.new("Bad parameter: azure_oauth_client_credentials_client_id must be an String") if params[:azure_oauth_client_credentials_client_id] and !params[:azure_oauth_client_credentials_client_id].is_a?(String)
  raise InvalidParameterError.new("Bad parameter: azure_oauth_client_credentials_client_secret must be an String") if params[:azure_oauth_client_credentials_client_secret] and !params[:azure_oauth_client_credentials_client_secret].is_a?(String)
  raise InvalidParameterError.new("Bad parameter: qradar_username must be an String") if params[:qradar_username] and !params[:qradar_username].is_a?(String)
  raise InvalidParameterError.new("Bad parameter: qradar_password must be an String") if params[:qradar_password] and !params[:qradar_password].is_a?(String)
  raise InvalidParameterError.new("Bad parameter: solar_winds_token must be an String") if params[:solar_winds_token] and !params[:solar_winds_token].is_a?(String)
  raise InvalidParameterError.new("Bad parameter: new_relic_api_key must be an String") if params[:new_relic_api_key] and !params[:new_relic_api_key].is_a?(String)
  raise InvalidParameterError.new("Bad parameter: datadog_api_key must be an String") if params[:datadog_api_key] and !params[:datadog_api_key].is_a?(String)

  Api.send_request("/siem_http_destinations/send_test_entry", :post, params, options)
  nil
end

.update(id, params = {}, options = {}) ⇒ Object

Parameters:

name - string - Name for this Destination
additional_headers - object - Additional HTTP Headers included in calls to the destination URL
sending_active - boolean - Whether this SIEM HTTP Destination is currently being sent to or not
generic_payload_type - string - Applicable only for destination type: generic. Indicates the type of HTTP body. Can be json_newline or json_array. json_newline is multiple log entries as JSON separated by newlines. json_array is a single JSON array containing multiple log entries as JSON.
file_destination_path - string - Applicable only for destination type: file. Destination folder path on Files.com.
file_format - string - Applicable only for destination type: file. Generated file format.
file_interval_minutes - int64 - Applicable only for destination type: file. Interval, in minutes, between file deliveries. Valid values are 5, 10, 15, 20, 30, 60, 90, 180, 240, 360.
splunk_token - string - Applicable only for destination types: splunk, splunk_compatible. Authentication token for the destination.
crowdstrike_token - string - Applicable only for destination type: crowdstrike. Authentication token provided by Crowdstrike.
azure_dcr_immutable_id - string - Applicable only for destination types: azure, azure_legacy. Immutable ID of the Data Collection Rule.
azure_stream_name - string - Applicable only for destination type: azure. Name of the stream in the DCR that represents the destination table.
azure_oauth_client_credentials_tenant_id - string - Applicable only for destination types: azure, azure_legacy. Client Credentials OAuth Tenant ID.
azure_oauth_client_credentials_client_id - string - Applicable only for destination types: azure, azure_legacy. Client Credentials OAuth Client ID.
azure_oauth_client_credentials_client_secret - string - Applicable only for destination type: azure. Client Credentials OAuth Client Secret.
qradar_username - string - Applicable only for destination type: qradar. Basic auth username provided by QRadar.
qradar_password - string - Applicable only for destination type: qradar. Basic auth password provided by QRadar.
solar_winds_token - string - Applicable only for destination type: solar_winds. Authentication token provided by Solar Winds.
new_relic_api_key - string - Applicable only for destination type: new_relic. API key provided by New Relic.
datadog_api_key - string - Applicable only for destination type: datadog. API key provided by Datadog.
action_send_enabled - boolean - Whether or not sending is enabled for action logs.
sftp_action_send_enabled - boolean - Whether or not sending is enabled for sftp_action logs.
ftp_action_send_enabled - boolean - Whether or not sending is enabled for ftp_action logs.
web_dav_action_send_enabled - boolean - Whether or not sending is enabled for web_dav_action logs.
sync_send_enabled - boolean - Whether or not sending is enabled for sync logs.
outbound_connection_send_enabled - boolean - Whether or not sending is enabled for outbound_connection logs.
automation_send_enabled - boolean - Whether or not sending is enabled for automation logs.
api_request_send_enabled - boolean - Whether or not sending is enabled for api_request logs.
public_hosting_request_send_enabled - boolean - Whether or not sending is enabled for public_hosting_request logs.
email_send_enabled - boolean - Whether or not sending is enabled for email logs.
exavault_api_request_send_enabled - boolean - Whether or not sending is enabled for exavault_api_request logs.
settings_change_send_enabled - boolean - Whether or not sending is enabled for settings_change logs.
destination_type - string - Destination Type
destination_url - string - Destination Url

Raises:



848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
 
# File 'lib/files.com/models/siem_http_destination.rb', line 848

def self.update(id, params = {}, options = {})
  params ||= {}
  params[:id] = id
  raise InvalidParameterError.new("Bad parameter: id must be an Integer") if params[:id] and !params[:id].is_a?(Integer)
  raise InvalidParameterError.new("Bad parameter: name must be an String") if params[:name] and !params[:name].is_a?(String)
  raise InvalidParameterError.new("Bad parameter: additional_headers must be an Hash") if params[:additional_headers] and !params[:additional_headers].is_a?(Hash)
  raise InvalidParameterError.new("Bad parameter: generic_payload_type must be an String") if params[:generic_payload_type] and !params[:generic_payload_type].is_a?(String)
  raise InvalidParameterError.new("Bad parameter: file_destination_path must be an String") if params[:file_destination_path] and !params[:file_destination_path].is_a?(String)
  raise InvalidParameterError.new("Bad parameter: file_format must be an String") if params[:file_format] and !params[:file_format].is_a?(String)
  raise InvalidParameterError.new("Bad parameter: file_interval_minutes must be an Integer") if params[:file_interval_minutes] and !params[:file_interval_minutes].is_a?(Integer)
  raise InvalidParameterError.new("Bad parameter: splunk_token must be an String") if params[:splunk_token] and !params[:splunk_token].is_a?(String)
  raise InvalidParameterError.new("Bad parameter: crowdstrike_token must be an String") if params[:crowdstrike_token] and !params[:crowdstrike_token].is_a?(String)
  raise InvalidParameterError.new("Bad parameter: azure_dcr_immutable_id must be an String") if params[:azure_dcr_immutable_id] and !params[:azure_dcr_immutable_id].is_a?(String)
  raise InvalidParameterError.new("Bad parameter: azure_stream_name must be an String") if params[:azure_stream_name] and !params[:azure_stream_name].is_a?(String)
  raise InvalidParameterError.new("Bad parameter: azure_oauth_client_credentials_tenant_id must be an String") if params[:azure_oauth_client_credentials_tenant_id] and !params[:azure_oauth_client_credentials_tenant_id].is_a?(String)
  raise InvalidParameterError.new("Bad parameter: azure_oauth_client_credentials_client_id must be an String") if params[:azure_oauth_client_credentials_client_id] and !params[:azure_oauth_client_credentials_client_id].is_a?(String)
  raise InvalidParameterError.new("Bad parameter: azure_oauth_client_credentials_client_secret must be an String") if params[:azure_oauth_client_credentials_client_secret] and !params[:azure_oauth_client_credentials_client_secret].is_a?(String)
  raise InvalidParameterError.new("Bad parameter: qradar_username must be an String") if params[:qradar_username] and !params[:qradar_username].is_a?(String)
  raise InvalidParameterError.new("Bad parameter: qradar_password must be an String") if params[:qradar_password] and !params[:qradar_password].is_a?(String)
  raise InvalidParameterError.new("Bad parameter: solar_winds_token must be an String") if params[:solar_winds_token] and !params[:solar_winds_token].is_a?(String)
  raise InvalidParameterError.new("Bad parameter: new_relic_api_key must be an String") if params[:new_relic_api_key] and !params[:new_relic_api_key].is_a?(String)
  raise InvalidParameterError.new("Bad parameter: datadog_api_key must be an String") if params[:datadog_api_key] and !params[:datadog_api_key].is_a?(String)
  raise InvalidParameterError.new("Bad parameter: destination_type must be an String") if params[:destination_type] and !params[:destination_type].is_a?(String)
  raise InvalidParameterError.new("Bad parameter: destination_url must be an String") if params[:destination_url] and !params[:destination_url].is_a?(String)
  raise MissingParameterError.new("Parameter missing: id") unless params[:id]

  response, options = Api.send_request("/siem_http_destinations/#{params[:id]}", :patch, params, options)
  SiemHttpDestination.new(response.data, options)
end

Instance Method Details

#action_entries_sent ⇒ Object

int64 - Number of log entries sent for the lifetime of this destination.



220
221
222
 
# File 'lib/files.com/models/siem_http_destination.rb', line 220

def action_entries_sent
  @attributes[:action_entries_sent]
end

#action_entries_sent=(value) ⇒ Object 



224
225
226
 
# File 'lib/files.com/models/siem_http_destination.rb', line 224

def action_entries_sent=(value)
  @attributes[:action_entries_sent] = value
end

#action_send_enabled ⇒ Object

boolean - Whether or not sending is enabled for action logs.



211
212
213
 
# File 'lib/files.com/models/siem_http_destination.rb', line 211

def action_send_enabled
  @attributes[:action_send_enabled]
end

#action_send_enabled=(value) ⇒ Object 



215
216
217
 
# File 'lib/files.com/models/siem_http_destination.rb', line 215

def action_send_enabled=(value)
  @attributes[:action_send_enabled] = value
end

#additional_headers ⇒ Object

object - Additional HTTP Headers included in calls to the destination URL



76
77
78
 
# File 'lib/files.com/models/siem_http_destination.rb', line 76

def additional_headers
  @attributes[:additional_headers]
end

#additional_headers=(value) ⇒ Object 



80
81
82
 
# File 'lib/files.com/models/siem_http_destination.rb', line 80

def additional_headers=(value)
  @attributes[:additional_headers] = value
end

#api_request_entries_sent ⇒ Object

int64 - Number of log entries sent for the lifetime of this destination.



346
347
348
 
# File 'lib/files.com/models/siem_http_destination.rb', line 346

def api_request_entries_sent
  @attributes[:api_request_entries_sent]
end

#api_request_entries_sent=(value) ⇒ Object 



350
351
352
 
# File 'lib/files.com/models/siem_http_destination.rb', line 350

def api_request_entries_sent=(value)
  @attributes[:api_request_entries_sent] = value
end

#api_request_send_enabled ⇒ Object

boolean - Whether or not sending is enabled for api_request logs.



337
338
339
 
# File 'lib/files.com/models/siem_http_destination.rb', line 337

def api_request_send_enabled
  @attributes[:api_request_send_enabled]
end

#api_request_send_enabled=(value) ⇒ Object 



341
342
343
 
# File 'lib/files.com/models/siem_http_destination.rb', line 341

def api_request_send_enabled=(value)
  @attributes[:api_request_send_enabled] = value
end

#automation_entries_sent ⇒ Object

int64 - Number of log entries sent for the lifetime of this destination.



328
329
330
 
# File 'lib/files.com/models/siem_http_destination.rb', line 328

def automation_entries_sent
  @attributes[:automation_entries_sent]
end

#automation_entries_sent=(value) ⇒ Object 



332
333
334
 
# File 'lib/files.com/models/siem_http_destination.rb', line 332

def automation_entries_sent=(value)
  @attributes[:automation_entries_sent] = value
end

#automation_send_enabled ⇒ Object

boolean - Whether or not sending is enabled for automation logs.



319
320
321
 
# File 'lib/files.com/models/siem_http_destination.rb', line 319

def automation_send_enabled
  @attributes[:automation_send_enabled]
end

#automation_send_enabled=(value) ⇒ Object 



323
324
325
 
# File 'lib/files.com/models/siem_http_destination.rb', line 323

def automation_send_enabled=(value)
  @attributes[:automation_send_enabled] = value
end

#azure_dcr_immutable_id ⇒ Object

string - Applicable only for destination types: azure, azure_legacy. Immutable ID of the Data Collection Rule.



121
122
123
 
# File 'lib/files.com/models/siem_http_destination.rb', line 121

def azure_dcr_immutable_id
  @attributes[:azure_dcr_immutable_id]
end

#azure_dcr_immutable_id=(value) ⇒ Object 



125
126
127
 
# File 'lib/files.com/models/siem_http_destination.rb', line 125

def azure_dcr_immutable_id=(value)
  @attributes[:azure_dcr_immutable_id] = value
end

#azure_oauth_client_credentials_client_id ⇒ Object

string - Applicable only for destination types: azure, azure_legacy. Client Credentials OAuth Client ID.



148
149
150
 
# File 'lib/files.com/models/siem_http_destination.rb', line 148

def azure_oauth_client_credentials_client_id
  @attributes[:azure_oauth_client_credentials_client_id]
end

#azure_oauth_client_credentials_client_id=(value) ⇒ Object 



152
153
154
 
# File 'lib/files.com/models/siem_http_destination.rb', line 152

def azure_oauth_client_credentials_client_id=(value)
  @attributes[:azure_oauth_client_credentials_client_id] = value
end

#azure_oauth_client_credentials_client_secret ⇒ Object

string - Applicable only for destination type: azure. Client Credentials OAuth Client Secret.



526
527
528
 
# File 'lib/files.com/models/siem_http_destination.rb', line 526

def azure_oauth_client_credentials_client_secret
  @attributes[:azure_oauth_client_credentials_client_secret]
end

#azure_oauth_client_credentials_client_secret=(value) ⇒ Object 



530
531
532
 
# File 'lib/files.com/models/siem_http_destination.rb', line 530

def azure_oauth_client_credentials_client_secret=(value)
  @attributes[:azure_oauth_client_credentials_client_secret] = value
end

#azure_oauth_client_credentials_client_secret_masked ⇒ Object

string - Applicable only for destination types: azure, azure_legacy. Client Credentials OAuth Client Secret.



157
158
159
 
# File 'lib/files.com/models/siem_http_destination.rb', line 157

def azure_oauth_client_credentials_client_secret_masked
  @attributes[:azure_oauth_client_credentials_client_secret_masked]
end

#azure_oauth_client_credentials_client_secret_masked=(value) ⇒ Object 



161
162
163
 
# File 'lib/files.com/models/siem_http_destination.rb', line 161

def azure_oauth_client_credentials_client_secret_masked=(value)
  @attributes[:azure_oauth_client_credentials_client_secret_masked] = value
end

#azure_oauth_client_credentials_tenant_id ⇒ Object

string - Applicable only for destination types: azure, azure_legacy. Client Credentials OAuth Tenant ID.



139
140
141
 
# File 'lib/files.com/models/siem_http_destination.rb', line 139

def azure_oauth_client_credentials_tenant_id
  @attributes[:azure_oauth_client_credentials_tenant_id]
end

#azure_oauth_client_credentials_tenant_id=(value) ⇒ Object 



143
144
145
 
# File 'lib/files.com/models/siem_http_destination.rb', line 143

def azure_oauth_client_credentials_tenant_id=(value)
  @attributes[:azure_oauth_client_credentials_tenant_id] = value
end

#azure_stream_name ⇒ Object

string - Applicable only for destination type: azure. Name of the stream in the DCR that represents the destination table.



130
131
132
 
# File 'lib/files.com/models/siem_http_destination.rb', line 130

def azure_stream_name
  @attributes[:azure_stream_name]
end

#azure_stream_name=(value) ⇒ Object 



134
135
136
 
# File 'lib/files.com/models/siem_http_destination.rb', line 134

def azure_stream_name=(value)
  @attributes[:azure_stream_name] = value
end

#connection_test_entry ⇒ Object

string - Connection Test Entry



499
500
501
 
# File 'lib/files.com/models/siem_http_destination.rb', line 499

def connection_test_entry
  @attributes[:connection_test_entry]
end

#connection_test_entry=(value) ⇒ Object 



503
504
505
 
# File 'lib/files.com/models/siem_http_destination.rb', line 503

def connection_test_entry=(value)
  @attributes[:connection_test_entry] = value
end

#crowdstrike_token ⇒ Object

string - Applicable only for destination type: crowdstrike. Authentication token provided by Crowdstrike.



517
518
519
 
# File 'lib/files.com/models/siem_http_destination.rb', line 517

def crowdstrike_token
  @attributes[:crowdstrike_token]
end

#crowdstrike_token=(value) ⇒ Object 



521
522
523
 
# File 'lib/files.com/models/siem_http_destination.rb', line 521

def crowdstrike_token=(value)
  @attributes[:crowdstrike_token] = value
end

#crowdstrike_token_masked ⇒ Object

string - Applicable only for destination type: crowdstrike. Authentication token provided by Crowdstrike.



112
113
114
 
# File 'lib/files.com/models/siem_http_destination.rb', line 112

def crowdstrike_token_masked
  @attributes[:crowdstrike_token_masked]
end

#crowdstrike_token_masked=(value) ⇒ Object 



116
117
118
 
# File 'lib/files.com/models/siem_http_destination.rb', line 116

def crowdstrike_token_masked=(value)
  @attributes[:crowdstrike_token_masked] = value
end

#datadog_api_key ⇒ Object

string - Applicable only for destination type: datadog. API key provided by Datadog.



562
563
564
 
# File 'lib/files.com/models/siem_http_destination.rb', line 562

def datadog_api_key
  @attributes[:datadog_api_key]
end

#datadog_api_key=(value) ⇒ Object 



566
567
568
 
# File 'lib/files.com/models/siem_http_destination.rb', line 566

def datadog_api_key=(value)
  @attributes[:datadog_api_key] = value
end

#datadog_api_key_masked ⇒ Object

string - Applicable only for destination type: datadog. API key provided by Datadog.



202
203
204
 
# File 'lib/files.com/models/siem_http_destination.rb', line 202

def datadog_api_key_masked
  @attributes[:datadog_api_key_masked]
end

#datadog_api_key_masked=(value) ⇒ Object 



206
207
208
 
# File 'lib/files.com/models/siem_http_destination.rb', line 206

def datadog_api_key_masked=(value)
  @attributes[:datadog_api_key_masked] = value
end

#delete(params = {}) ⇒ Object

Raises:



633
634
635
636
637
638
639
640
641
 
# File 'lib/files.com/models/siem_http_destination.rb', line 633

def delete(params = {})
  params ||= {}
  params[:id] = @attributes[:id]
  raise MissingParameterError.new("Current object doesn't have a id") unless @attributes[:id]
  raise InvalidParameterError.new("Bad parameter: id must be an Integer") if params[:id] and !params[:id].is_a?(Integer)
  raise MissingParameterError.new("Parameter missing: id") unless params[:id]

  Api.send_request("/siem_http_destinations/#{@attributes[:id]}", :delete, params, @options)
end

#destination_type ⇒ Object

string - Destination Type



31
32
33
 
# File 'lib/files.com/models/siem_http_destination.rb', line 31

def destination_type
  @attributes[:destination_type]
end

#destination_type=(value) ⇒ Object 



35
36
37
 
# File 'lib/files.com/models/siem_http_destination.rb', line 35

def destination_type=(value)
  @attributes[:destination_type] = value
end

#destination_url ⇒ Object

string - Destination Url



40
41
42
 
# File 'lib/files.com/models/siem_http_destination.rb', line 40

def destination_url
  @attributes[:destination_url]
end

#destination_url=(value) ⇒ Object 



44
45
46
 
# File 'lib/files.com/models/siem_http_destination.rb', line 44

def destination_url=(value)
  @attributes[:destination_url] = value
end

#destroy(params = {}) ⇒ Object 



643
644
645
646
 
# File 'lib/files.com/models/siem_http_destination.rb', line 643

def destroy(params = {})
  delete(params)
  nil
end

#email_entries_sent ⇒ Object

int64 - Number of log entries sent for the lifetime of this destination.



382
383
384
 
# File 'lib/files.com/models/siem_http_destination.rb', line 382

def email_entries_sent
  @attributes[:email_entries_sent]
end

#email_entries_sent=(value) ⇒ Object 



386
387
388
 
# File 'lib/files.com/models/siem_http_destination.rb', line 386

def email_entries_sent=(value)
  @attributes[:email_entries_sent] = value
end

#email_send_enabled ⇒ Object

boolean - Whether or not sending is enabled for email logs.



373
374
375
 
# File 'lib/files.com/models/siem_http_destination.rb', line 373

def email_send_enabled
  @attributes[:email_send_enabled]
end

#email_send_enabled=(value) ⇒ Object 



377
378
379
 
# File 'lib/files.com/models/siem_http_destination.rb', line 377

def email_send_enabled=(value)
  @attributes[:email_send_enabled] = value
end

#exavault_api_request_entries_sent ⇒ Object

int64 - Number of log entries sent for the lifetime of this destination.



400
401
402
 
# File 'lib/files.com/models/siem_http_destination.rb', line 400

def exavault_api_request_entries_sent
  @attributes[:exavault_api_request_entries_sent]
end

#exavault_api_request_entries_sent=(value) ⇒ Object 



404
405
406
 
# File 'lib/files.com/models/siem_http_destination.rb', line 404

def exavault_api_request_entries_sent=(value)
  @attributes[:exavault_api_request_entries_sent] = value
end

#exavault_api_request_send_enabled ⇒ Object

boolean - Whether or not sending is enabled for exavault_api_request logs.



391
392
393
 
# File 'lib/files.com/models/siem_http_destination.rb', line 391

def exavault_api_request_send_enabled
  @attributes[:exavault_api_request_send_enabled]
end

#exavault_api_request_send_enabled=(value) ⇒ Object 



395
396
397
 
# File 'lib/files.com/models/siem_http_destination.rb', line 395

def exavault_api_request_send_enabled=(value)
  @attributes[:exavault_api_request_send_enabled] = value
end

#file_destination_path ⇒ Object

string - Applicable only for destination type: file. Destination folder path on Files.com.



49
50
51
 
# File 'lib/files.com/models/siem_http_destination.rb', line 49

def file_destination_path
  @attributes[:file_destination_path]
end

#file_destination_path=(value) ⇒ Object 



53
54
55
 
# File 'lib/files.com/models/siem_http_destination.rb', line 53

def file_destination_path=(value)
  @attributes[:file_destination_path] = value
end

#file_format ⇒ Object

string - Applicable only for destination type: file. Generated file format.



58
59
60
 
# File 'lib/files.com/models/siem_http_destination.rb', line 58

def file_format
  @attributes[:file_format]
end

#file_format=(value) ⇒ Object 



62
63
64
 
# File 'lib/files.com/models/siem_http_destination.rb', line 62

def file_format=(value)
  @attributes[:file_format] = value
end

#file_interval_minutes ⇒ Object

int64 - Applicable only for destination type: file. Interval, in minutes, between file deliveries.



67
68
69
 
# File 'lib/files.com/models/siem_http_destination.rb', line 67

def file_interval_minutes
  @attributes[:file_interval_minutes]
end

#file_interval_minutes=(value) ⇒ Object 



71
72
73
 
# File 'lib/files.com/models/siem_http_destination.rb', line 71

def file_interval_minutes=(value)
  @attributes[:file_interval_minutes] = value
end

#ftp_action_entries_sent ⇒ Object

int64 - Number of log entries sent for the lifetime of this destination.



256
257
258
 
# File 'lib/files.com/models/siem_http_destination.rb', line 256

def ftp_action_entries_sent
  @attributes[:ftp_action_entries_sent]
end

#ftp_action_entries_sent=(value) ⇒ Object 



260
261
262
 
# File 'lib/files.com/models/siem_http_destination.rb', line 260

def ftp_action_entries_sent=(value)
  @attributes[:ftp_action_entries_sent] = value
end

#ftp_action_send_enabled ⇒ Object

boolean - Whether or not sending is enabled for ftp_action logs.



247
248
249
 
# File 'lib/files.com/models/siem_http_destination.rb', line 247

def ftp_action_send_enabled
  @attributes[:ftp_action_send_enabled]
end

#ftp_action_send_enabled=(value) ⇒ Object 



251
252
253
 
# File 'lib/files.com/models/siem_http_destination.rb', line 251

def ftp_action_send_enabled=(value)
  @attributes[:ftp_action_send_enabled] = value
end

#generic_payload_type ⇒ Object

string - Applicable only for destination type: generic. Indicates the type of HTTP body. Can be json_newline or json_array. json_newline is multiple log entries as JSON separated by newlines. json_array is a single JSON array containing multiple log entries as JSON.



94
95
96
 
# File 'lib/files.com/models/siem_http_destination.rb', line 94

def generic_payload_type
  @attributes[:generic_payload_type]
end

#generic_payload_type=(value) ⇒ Object 



98
99
100
 
# File 'lib/files.com/models/siem_http_destination.rb', line 98

def generic_payload_type=(value)
  @attributes[:generic_payload_type] = value
end

#id ⇒ Object

int64 - SIEM HTTP Destination ID



13
14
15
 
# File 'lib/files.com/models/siem_http_destination.rb', line 13

def id
  @attributes[:id]
end

#id=(value) ⇒ Object 



17
18
19
 
# File 'lib/files.com/models/siem_http_destination.rb', line 17

def id=(value)
  @attributes[:id] = value
end

#last_http_call_duration_ms ⇒ Object

int64 - Duration of the last HTTP Call in milliseconds



481
482
483
 
# File 'lib/files.com/models/siem_http_destination.rb', line 481

def last_http_call_duration_ms
  @attributes[:last_http_call_duration_ms]
end

#last_http_call_duration_ms=(value) ⇒ Object 



485
486
487
 
# File 'lib/files.com/models/siem_http_destination.rb', line 485

def last_http_call_duration_ms=(value)
  @attributes[:last_http_call_duration_ms] = value
end

#last_http_call_error_message ⇒ Object

string - Last HTTP Call Error Message if applicable



463
464
465
 
# File 'lib/files.com/models/siem_http_destination.rb', line 463

def last_http_call_error_message
  @attributes[:last_http_call_error_message]
end

#last_http_call_error_message=(value) ⇒ Object 



467
468
469
 
# File 'lib/files.com/models/siem_http_destination.rb', line 467

def last_http_call_error_message=(value)
  @attributes[:last_http_call_error_message] = value
end

#last_http_call_response_body ⇒ Object

string - Last HTTP Call Response Body. Large responses are truncated.



454
455
456
 
# File 'lib/files.com/models/siem_http_destination.rb', line 454

def last_http_call_response_body
  @attributes[:last_http_call_response_body]
end

#last_http_call_response_body=(value) ⇒ Object 



458
459
460
 
# File 'lib/files.com/models/siem_http_destination.rb', line 458

def last_http_call_response_body=(value)
  @attributes[:last_http_call_response_body] = value
end

#last_http_call_response_code ⇒ Object

int64 - Last HTTP Call Response Code



445
446
447
 
# File 'lib/files.com/models/siem_http_destination.rb', line 445

def last_http_call_response_code
  @attributes[:last_http_call_response_code]
end

#last_http_call_response_code=(value) ⇒ Object 



449
450
451
 
# File 'lib/files.com/models/siem_http_destination.rb', line 449

def last_http_call_response_code=(value)
  @attributes[:last_http_call_response_code] = value
end

#last_http_call_success ⇒ Object

boolean - Was the last HTTP call made successful?



436
437
438
 
# File 'lib/files.com/models/siem_http_destination.rb', line 436

def last_http_call_success
  @attributes[:last_http_call_success]
end

#last_http_call_success=(value) ⇒ Object 



440
441
442
 
# File 'lib/files.com/models/siem_http_destination.rb', line 440

def last_http_call_success=(value)
  @attributes[:last_http_call_success] = value
end

#last_http_call_target_type ⇒ Object

string - Type of URL that was last called. Can be ‘destination_url` or `azure_oauth_client_credentials_url`



427
428
429
 
# File 'lib/files.com/models/siem_http_destination.rb', line 427

def last_http_call_target_type
  @attributes[:last_http_call_target_type]
end

#last_http_call_target_type=(value) ⇒ Object 



431
432
433
 
# File 'lib/files.com/models/siem_http_destination.rb', line 431

def last_http_call_target_type=(value)
  @attributes[:last_http_call_target_type] = value
end

#last_http_call_time ⇒ Object

string - Time of Last HTTP Call



472
473
474
 
# File 'lib/files.com/models/siem_http_destination.rb', line 472

def last_http_call_time
  @attributes[:last_http_call_time]
end

#last_http_call_time=(value) ⇒ Object 



476
477
478
 
# File 'lib/files.com/models/siem_http_destination.rb', line 476

def last_http_call_time=(value)
  @attributes[:last_http_call_time] = value
end

#most_recent_http_call_success_time ⇒ Object

string - Time of Most Recent Successful HTTP Call



490
491
492
 
# File 'lib/files.com/models/siem_http_destination.rb', line 490

def most_recent_http_call_success_time
  @attributes[:most_recent_http_call_success_time]
end

#most_recent_http_call_success_time=(value) ⇒ Object 



494
495
496
 
# File 'lib/files.com/models/siem_http_destination.rb', line 494

def most_recent_http_call_success_time=(value)
  @attributes[:most_recent_http_call_success_time] = value
end

#name ⇒ Object

string - Name for this Destination



22
23
24
 
# File 'lib/files.com/models/siem_http_destination.rb', line 22

def name
  @attributes[:name]
end

#name=(value) ⇒ Object 



26
27
28
 
# File 'lib/files.com/models/siem_http_destination.rb', line 26

def name=(value)
  @attributes[:name] = value
end

#new_relic_api_key ⇒ Object

string - Applicable only for destination type: new_relic. API key provided by New Relic.



553
554
555
 
# File 'lib/files.com/models/siem_http_destination.rb', line 553

def new_relic_api_key
  @attributes[:new_relic_api_key]
end

#new_relic_api_key=(value) ⇒ Object 



557
558
559
 
# File 'lib/files.com/models/siem_http_destination.rb', line 557

def new_relic_api_key=(value)
  @attributes[:new_relic_api_key] = value
end

#new_relic_api_key_masked ⇒ Object

string - Applicable only for destination type: new_relic. API key provided by New Relic.



193
194
195
 
# File 'lib/files.com/models/siem_http_destination.rb', line 193

def new_relic_api_key_masked
  @attributes[:new_relic_api_key_masked]
end

#new_relic_api_key_masked=(value) ⇒ Object 



197
198
199
 
# File 'lib/files.com/models/siem_http_destination.rb', line 197

def new_relic_api_key_masked=(value)
  @attributes[:new_relic_api_key_masked] = value
end

#outbound_connection_entries_sent ⇒ Object

int64 - Number of log entries sent for the lifetime of this destination.



310
311
312
 
# File 'lib/files.com/models/siem_http_destination.rb', line 310

def outbound_connection_entries_sent
  @attributes[:outbound_connection_entries_sent]
end

#outbound_connection_entries_sent=(value) ⇒ Object 



314
315
316
 
# File 'lib/files.com/models/siem_http_destination.rb', line 314

def outbound_connection_entries_sent=(value)
  @attributes[:outbound_connection_entries_sent] = value
end

#outbound_connection_send_enabled ⇒ Object

boolean - Whether or not sending is enabled for outbound_connection logs.



301
302
303
 
# File 'lib/files.com/models/siem_http_destination.rb', line 301

def outbound_connection_send_enabled
  @attributes[:outbound_connection_send_enabled]
end

#outbound_connection_send_enabled=(value) ⇒ Object 



305
306
307
 
# File 'lib/files.com/models/siem_http_destination.rb', line 305

def outbound_connection_send_enabled=(value)
  @attributes[:outbound_connection_send_enabled] = value
end

#public_hosting_request_entries_sent ⇒ Object

int64 - Number of log entries sent for the lifetime of this destination.



364
365
366
 
# File 'lib/files.com/models/siem_http_destination.rb', line 364

def public_hosting_request_entries_sent
  @attributes[:public_hosting_request_entries_sent]
end

#public_hosting_request_entries_sent=(value) ⇒ Object 



368
369
370
 
# File 'lib/files.com/models/siem_http_destination.rb', line 368

def public_hosting_request_entries_sent=(value)
  @attributes[:public_hosting_request_entries_sent] = value
end

#public_hosting_request_send_enabled ⇒ Object

boolean - Whether or not sending is enabled for public_hosting_request logs.



355
356
357
 
# File 'lib/files.com/models/siem_http_destination.rb', line 355

def public_hosting_request_send_enabled
  @attributes[:public_hosting_request_send_enabled]
end

#public_hosting_request_send_enabled=(value) ⇒ Object 



359
360
361
 
# File 'lib/files.com/models/siem_http_destination.rb', line 359

def public_hosting_request_send_enabled=(value)
  @attributes[:public_hosting_request_send_enabled] = value
end

#qradar_password ⇒ Object

string - Applicable only for destination type: qradar. Basic auth password provided by QRadar.



535
536
537
 
# File 'lib/files.com/models/siem_http_destination.rb', line 535

def qradar_password
  @attributes[:qradar_password]
end

#qradar_password=(value) ⇒ Object 



539
540
541
 
# File 'lib/files.com/models/siem_http_destination.rb', line 539

def qradar_password=(value)
  @attributes[:qradar_password] = value
end

#qradar_password_masked ⇒ Object

string - Applicable only for destination type: qradar. Basic auth password provided by QRadar.



175
176
177
 
# File 'lib/files.com/models/siem_http_destination.rb', line 175

def qradar_password_masked
  @attributes[:qradar_password_masked]
end

#qradar_password_masked=(value) ⇒ Object 



179
180
181
 
# File 'lib/files.com/models/siem_http_destination.rb', line 179

def qradar_password_masked=(value)
  @attributes[:qradar_password_masked] = value
end

#qradar_username ⇒ Object

string - Applicable only for destination type: qradar. Basic auth username provided by QRadar.



166
167
168
 
# File 'lib/files.com/models/siem_http_destination.rb', line 166

def qradar_username
  @attributes[:qradar_username]
end

#qradar_username=(value) ⇒ Object 



170
171
172
 
# File 'lib/files.com/models/siem_http_destination.rb', line 170

def qradar_username=(value)
  @attributes[:qradar_username] = value
end

#save ⇒ Object 



648
649
650
651
652
653
654
655
656
657
 
# File 'lib/files.com/models/siem_http_destination.rb', line 648

def save
  if @attributes[:id]
    new_obj = update(@attributes)
  else
    new_obj = SiemHttpDestination.create(@attributes, @options)
  end

  @attributes = new_obj.attributes
  true
end

#sending_active ⇒ Object

boolean - Whether this SIEM HTTP Destination is currently being sent to or not



85
86
87
 
# File 'lib/files.com/models/siem_http_destination.rb', line 85

def sending_active
  @attributes[:sending_active]
end

#sending_active=(value) ⇒ Object 



89
90
91
 
# File 'lib/files.com/models/siem_http_destination.rb', line 89

def sending_active=(value)
  @attributes[:sending_active] = value
end

#settings_change_entries_sent ⇒ Object

int64 - Number of log entries sent for the lifetime of this destination.



418
419
420
 
# File 'lib/files.com/models/siem_http_destination.rb', line 418

def settings_change_entries_sent
  @attributes[:settings_change_entries_sent]
end

#settings_change_entries_sent=(value) ⇒ Object 



422
423
424
 
# File 'lib/files.com/models/siem_http_destination.rb', line 422

def settings_change_entries_sent=(value)
  @attributes[:settings_change_entries_sent] = value
end

#settings_change_send_enabled ⇒ Object

boolean - Whether or not sending is enabled for settings_change logs.



409
410
411
 
# File 'lib/files.com/models/siem_http_destination.rb', line 409

def settings_change_send_enabled
  @attributes[:settings_change_send_enabled]
end

#settings_change_send_enabled=(value) ⇒ Object 



413
414
415
 
# File 'lib/files.com/models/siem_http_destination.rb', line 413

def settings_change_send_enabled=(value)
  @attributes[:settings_change_send_enabled] = value
end

#sftp_action_entries_sent ⇒ Object

int64 - Number of log entries sent for the lifetime of this destination.



238
239
240
 
# File 'lib/files.com/models/siem_http_destination.rb', line 238

def sftp_action_entries_sent
  @attributes[:sftp_action_entries_sent]
end

#sftp_action_entries_sent=(value) ⇒ Object 



242
243
244
 
# File 'lib/files.com/models/siem_http_destination.rb', line 242

def sftp_action_entries_sent=(value)
  @attributes[:sftp_action_entries_sent] = value
end

#sftp_action_send_enabled ⇒ Object

boolean - Whether or not sending is enabled for sftp_action logs.



229
230
231
 
# File 'lib/files.com/models/siem_http_destination.rb', line 229

def sftp_action_send_enabled
  @attributes[:sftp_action_send_enabled]
end

#sftp_action_send_enabled=(value) ⇒ Object 



233
234
235
 
# File 'lib/files.com/models/siem_http_destination.rb', line 233

def sftp_action_send_enabled=(value)
  @attributes[:sftp_action_send_enabled] = value
end

#solar_winds_token ⇒ Object

string - Applicable only for destination type: solar_winds. Authentication token provided by Solar Winds.



544
545
546
 
# File 'lib/files.com/models/siem_http_destination.rb', line 544

def solar_winds_token
  @attributes[:solar_winds_token]
end

#solar_winds_token=(value) ⇒ Object 



548
549
550
 
# File 'lib/files.com/models/siem_http_destination.rb', line 548

def solar_winds_token=(value)
  @attributes[:solar_winds_token] = value
end

#solar_winds_token_masked ⇒ Object

string - Applicable only for destination type: solar_winds. Authentication token provided by Solar Winds.



184
185
186
 
# File 'lib/files.com/models/siem_http_destination.rb', line 184

def solar_winds_token_masked
  @attributes[:solar_winds_token_masked]
end

#solar_winds_token_masked=(value) ⇒ Object 



188
189
190
 
# File 'lib/files.com/models/siem_http_destination.rb', line 188

def solar_winds_token_masked=(value)
  @attributes[:solar_winds_token_masked] = value
end

#splunk_token ⇒ Object

string - Applicable only for destination types: splunk, splunk_compatible. Authentication token for the destination.



508
509
510
 
# File 'lib/files.com/models/siem_http_destination.rb', line 508

def splunk_token
  @attributes[:splunk_token]
end

#splunk_token=(value) ⇒ Object 



512
513
514
 
# File 'lib/files.com/models/siem_http_destination.rb', line 512

def splunk_token=(value)
  @attributes[:splunk_token] = value
end

#splunk_token_masked ⇒ Object

string - Applicable only for destination types: splunk, splunk_compatible. Authentication token for the destination.



103
104
105
 
# File 'lib/files.com/models/siem_http_destination.rb', line 103

def splunk_token_masked
  @attributes[:splunk_token_masked]
end

#splunk_token_masked=(value) ⇒ Object 



107
108
109
 
# File 'lib/files.com/models/siem_http_destination.rb', line 107

def splunk_token_masked=(value)
  @attributes[:splunk_token_masked] = value
end

#sync_entries_sent ⇒ Object

int64 - Number of log entries sent for the lifetime of this destination.



292
293
294
 
# File 'lib/files.com/models/siem_http_destination.rb', line 292

def sync_entries_sent
  @attributes[:sync_entries_sent]
end

#sync_entries_sent=(value) ⇒ Object 



296
297
298
 
# File 'lib/files.com/models/siem_http_destination.rb', line 296

def sync_entries_sent=(value)
  @attributes[:sync_entries_sent] = value
end

#sync_send_enabled ⇒ Object

boolean - Whether or not sending is enabled for sync logs.



283
284
285
 
# File 'lib/files.com/models/siem_http_destination.rb', line 283

def sync_send_enabled
  @attributes[:sync_send_enabled]
end

#sync_send_enabled=(value) ⇒ Object 



287
288
289
 
# File 'lib/files.com/models/siem_http_destination.rb', line 287

def sync_send_enabled=(value)
  @attributes[:sync_send_enabled] = value
end

#update(params = {}) ⇒ Object

Parameters:

name - string - Name for this Destination
additional_headers - object - Additional HTTP Headers included in calls to the destination URL
sending_active - boolean - Whether this SIEM HTTP Destination is currently being sent to or not
generic_payload_type - string - Applicable only for destination type: generic. Indicates the type of HTTP body. Can be json_newline or json_array. json_newline is multiple log entries as JSON separated by newlines. json_array is a single JSON array containing multiple log entries as JSON.
file_destination_path - string - Applicable only for destination type: file. Destination folder path on Files.com.
file_format - string - Applicable only for destination type: file. Generated file format.
file_interval_minutes - int64 - Applicable only for destination type: file. Interval, in minutes, between file deliveries. Valid values are 5, 10, 15, 20, 30, 60, 90, 180, 240, 360.
splunk_token - string - Applicable only for destination types: splunk, splunk_compatible. Authentication token for the destination.
crowdstrike_token - string - Applicable only for destination type: crowdstrike. Authentication token provided by Crowdstrike.
azure_dcr_immutable_id - string - Applicable only for destination types: azure, azure_legacy. Immutable ID of the Data Collection Rule.
azure_stream_name - string - Applicable only for destination type: azure. Name of the stream in the DCR that represents the destination table.
azure_oauth_client_credentials_tenant_id - string - Applicable only for destination types: azure, azure_legacy. Client Credentials OAuth Tenant ID.
azure_oauth_client_credentials_client_id - string - Applicable only for destination types: azure, azure_legacy. Client Credentials OAuth Client ID.
azure_oauth_client_credentials_client_secret - string - Applicable only for destination type: azure. Client Credentials OAuth Client Secret.
qradar_username - string - Applicable only for destination type: qradar. Basic auth username provided by QRadar.
qradar_password - string - Applicable only for destination type: qradar. Basic auth password provided by QRadar.
solar_winds_token - string - Applicable only for destination type: solar_winds. Authentication token provided by Solar Winds.
new_relic_api_key - string - Applicable only for destination type: new_relic. API key provided by New Relic.
datadog_api_key - string - Applicable only for destination type: datadog. API key provided by Datadog.
action_send_enabled - boolean - Whether or not sending is enabled for action logs.
sftp_action_send_enabled - boolean - Whether or not sending is enabled for sftp_action logs.
ftp_action_send_enabled - boolean - Whether or not sending is enabled for ftp_action logs.
web_dav_action_send_enabled - boolean - Whether or not sending is enabled for web_dav_action logs.
sync_send_enabled - boolean - Whether or not sending is enabled for sync logs.
outbound_connection_send_enabled - boolean - Whether or not sending is enabled for outbound_connection logs.
automation_send_enabled - boolean - Whether or not sending is enabled for automation logs.
api_request_send_enabled - boolean - Whether or not sending is enabled for api_request logs.
public_hosting_request_send_enabled - boolean - Whether or not sending is enabled for public_hosting_request logs.
email_send_enabled - boolean - Whether or not sending is enabled for email logs.
exavault_api_request_send_enabled - boolean - Whether or not sending is enabled for exavault_api_request logs.
settings_change_send_enabled - boolean - Whether or not sending is enabled for settings_change logs.
destination_type - string - Destination Type
destination_url - string - Destination Url

Raises:



604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
 
# File 'lib/files.com/models/siem_http_destination.rb', line 604

def update(params = {})
  params ||= {}
  params[:id] = @attributes[:id]
  raise MissingParameterError.new("Current object doesn't have a id") unless @attributes[:id]
  raise InvalidParameterError.new("Bad parameter: id must be an Integer") if params[:id] and !params[:id].is_a?(Integer)
  raise InvalidParameterError.new("Bad parameter: name must be an String") if params[:name] and !params[:name].is_a?(String)
  raise InvalidParameterError.new("Bad parameter: generic_payload_type must be an String") if params[:generic_payload_type] and !params[:generic_payload_type].is_a?(String)
  raise InvalidParameterError.new("Bad parameter: file_destination_path must be an String") if params[:file_destination_path] and !params[:file_destination_path].is_a?(String)
  raise InvalidParameterError.new("Bad parameter: file_format must be an String") if params[:file_format] and !params[:file_format].is_a?(String)
  raise InvalidParameterError.new("Bad parameter: file_interval_minutes must be an Integer") if params[:file_interval_minutes] and !params[:file_interval_minutes].is_a?(Integer)
  raise InvalidParameterError.new("Bad parameter: splunk_token must be an String") if params[:splunk_token] and !params[:splunk_token].is_a?(String)
  raise InvalidParameterError.new("Bad parameter: crowdstrike_token must be an String") if params[:crowdstrike_token] and !params[:crowdstrike_token].is_a?(String)
  raise InvalidParameterError.new("Bad parameter: azure_dcr_immutable_id must be an String") if params[:azure_dcr_immutable_id] and !params[:azure_dcr_immutable_id].is_a?(String)
  raise InvalidParameterError.new("Bad parameter: azure_stream_name must be an String") if params[:azure_stream_name] and !params[:azure_stream_name].is_a?(String)
  raise InvalidParameterError.new("Bad parameter: azure_oauth_client_credentials_tenant_id must be an String") if params[:azure_oauth_client_credentials_tenant_id] and !params[:azure_oauth_client_credentials_tenant_id].is_a?(String)
  raise InvalidParameterError.new("Bad parameter: azure_oauth_client_credentials_client_id must be an String") if params[:azure_oauth_client_credentials_client_id] and !params[:azure_oauth_client_credentials_client_id].is_a?(String)
  raise InvalidParameterError.new("Bad parameter: azure_oauth_client_credentials_client_secret must be an String") if params[:azure_oauth_client_credentials_client_secret] and !params[:azure_oauth_client_credentials_client_secret].is_a?(String)
  raise InvalidParameterError.new("Bad parameter: qradar_username must be an String") if params[:qradar_username] and !params[:qradar_username].is_a?(String)
  raise InvalidParameterError.new("Bad parameter: qradar_password must be an String") if params[:qradar_password] and !params[:qradar_password].is_a?(String)
  raise InvalidParameterError.new("Bad parameter: solar_winds_token must be an String") if params[:solar_winds_token] and !params[:solar_winds_token].is_a?(String)
  raise InvalidParameterError.new("Bad parameter: new_relic_api_key must be an String") if params[:new_relic_api_key] and !params[:new_relic_api_key].is_a?(String)
  raise InvalidParameterError.new("Bad parameter: datadog_api_key must be an String") if params[:datadog_api_key] and !params[:datadog_api_key].is_a?(String)
  raise InvalidParameterError.new("Bad parameter: destination_type must be an String") if params[:destination_type] and !params[:destination_type].is_a?(String)
  raise InvalidParameterError.new("Bad parameter: destination_url must be an String") if params[:destination_url] and !params[:destination_url].is_a?(String)
  raise MissingParameterError.new("Parameter missing: id") unless params[:id]

  Api.send_request("/siem_http_destinations/#{@attributes[:id]}", :patch, params, @options)
end

#web_dav_action_entries_sent ⇒ Object

int64 - Number of log entries sent for the lifetime of this destination.



274
275
276
 
# File 'lib/files.com/models/siem_http_destination.rb', line 274

def web_dav_action_entries_sent
  @attributes[:web_dav_action_entries_sent]
end

#web_dav_action_entries_sent=(value) ⇒ Object 



278
279
280
 
# File 'lib/files.com/models/siem_http_destination.rb', line 278

def web_dav_action_entries_sent=(value)
  @attributes[:web_dav_action_entries_sent] = value
end

#web_dav_action_send_enabled ⇒ Object

boolean - Whether or not sending is enabled for web_dav_action logs.



265
266
267
 
# File 'lib/files.com/models/siem_http_destination.rb', line 265

def web_dav_action_send_enabled
  @attributes[:web_dav_action_send_enabled]
end

#web_dav_action_send_enabled=(value) ⇒ Object 



269
270
271
 
# File 'lib/files.com/models/siem_http_destination.rb', line 269

def web_dav_action_send_enabled=(value)
  @attributes[:web_dav_action_send_enabled] = value
end