Class: DatadogAPIClient::V1::SecurityMonitoringAPI
- Inherits:
-
Object
- Object
- DatadogAPIClient::V1::SecurityMonitoringAPI
- Defined in:
- lib/datadog_api_client/v1/api/security_monitoring_api.rb
Instance Attribute Summary collapse
-
#api_client ⇒ Object
Returns the value of attribute api_client.
Instance Method Summary collapse
-
#add_security_monitoring_signal_to_incident(signal_id, body, opts = {}) ⇒ Object
Add a security signal to an incident.
-
#add_security_monitoring_signal_to_incident_with_http_info(signal_id, body, opts = {}) ⇒ Array<(SuccessfulSignalUpdateResponse, Integer, Hash)>
Add a security signal to an incident.
-
#edit_security_monitoring_signal_assignee(signal_id, body, opts = {}) ⇒ Object
Modify the triage assignee of a security signal.
-
#edit_security_monitoring_signal_assignee_with_http_info(signal_id, body, opts = {}) ⇒ Array<(SuccessfulSignalUpdateResponse, Integer, Hash)>
Modify the triage assignee of a security signal.
-
#edit_security_monitoring_signal_state(signal_id, body, opts = {}) ⇒ Object
Change the triage state of a security signal.
-
#edit_security_monitoring_signal_state_with_http_info(signal_id, body, opts = {}) ⇒ Array<(SuccessfulSignalUpdateResponse, Integer, Hash)>
Change the triage state of a security signal.
-
#initialize(api_client = DatadogAPIClient::APIClient.default) ⇒ SecurityMonitoringAPI
constructor
A new instance of SecurityMonitoringAPI.
Constructor Details
#initialize(api_client = DatadogAPIClient::APIClient.default) ⇒ SecurityMonitoringAPI
Returns a new instance of SecurityMonitoringAPI.
22 23 24 |
# File 'lib/datadog_api_client/v1/api/security_monitoring_api.rb', line 22 def initialize(api_client = DatadogAPIClient::APIClient.default) @api_client = api_client end |
Instance Attribute Details
#api_client ⇒ Object
Returns the value of attribute api_client.
20 21 22 |
# File 'lib/datadog_api_client/v1/api/security_monitoring_api.rb', line 20 def api_client @api_client end |
Instance Method Details
#add_security_monitoring_signal_to_incident(signal_id, body, opts = {}) ⇒ Object
Add a security signal to an incident.
29 30 31 32 |
# File 'lib/datadog_api_client/v1/api/security_monitoring_api.rb', line 29 def add_security_monitoring_signal_to_incident(signal_id, body, opts = {}) data, _status_code, _headers = add_security_monitoring_signal_to_incident_with_http_info(signal_id, body, opts) data end |
#add_security_monitoring_signal_to_incident_with_http_info(signal_id, body, opts = {}) ⇒ Array<(SuccessfulSignalUpdateResponse, Integer, Hash)>
Add a security signal to an incident.
Add a security signal to an incident. This makes it possible to search for signals by incident within the signal explorer and to view the signals on the incident timeline.
42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 |
# File 'lib/datadog_api_client/v1/api/security_monitoring_api.rb', line 42 def add_security_monitoring_signal_to_incident_with_http_info(signal_id, body, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: SecurityMonitoringAPI.add_security_monitoring_signal_to_incident ...' end # verify the required parameter 'signal_id' is set if @api_client.config.client_side_validation && signal_id.nil? fail ArgumentError, "Missing the required parameter 'signal_id' when calling SecurityMonitoringAPI.add_security_monitoring_signal_to_incident" end # verify the required parameter 'body' is set if @api_client.config.client_side_validation && body.nil? fail ArgumentError, "Missing the required parameter 'body' when calling SecurityMonitoringAPI.add_security_monitoring_signal_to_incident" end # resource path local_var_path = '/api/v1/security_analytics/signals/{signal_id}/add_to_incident'.sub('{signal_id}', CGI.escape(signal_id.to_s).gsub('%2F', '/')) # query parameters query_params = opts[:query_params] || {} # header parameters header_params = opts[:header_params] || {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # HTTP header 'Content-Type' header_params['Content-Type'] = @api_client.select_header_content_type(['application/json']) # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:debug_body] || @api_client.object_to_http_body(body) # return_type return_type = opts[:debug_return_type] || 'SuccessfulSignalUpdateResponse' # auth_names auth_names = opts[:debug_auth_names] || [:apiKeyAuth, :appKeyAuth] = opts.merge( :operation => :add_security_monitoring_signal_to_incident, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => return_type, :api_version => "V1" ) data, status_code, headers = @api_client.call_api(Net::HTTP::Patch, local_var_path, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: SecurityMonitoringAPI#add_security_monitoring_signal_to_incident\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#edit_security_monitoring_signal_assignee(signal_id, body, opts = {}) ⇒ Object
Modify the triage assignee of a security signal.
101 102 103 104 |
# File 'lib/datadog_api_client/v1/api/security_monitoring_api.rb', line 101 def edit_security_monitoring_signal_assignee(signal_id, body, opts = {}) data, _status_code, _headers = edit_security_monitoring_signal_assignee_with_http_info(signal_id, body, opts) data end |
#edit_security_monitoring_signal_assignee_with_http_info(signal_id, body, opts = {}) ⇒ Array<(SuccessfulSignalUpdateResponse, Integer, Hash)>
Modify the triage assignee of a security signal.
Modify the triage assignee of a security signal.
114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 |
# File 'lib/datadog_api_client/v1/api/security_monitoring_api.rb', line 114 def edit_security_monitoring_signal_assignee_with_http_info(signal_id, body, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: SecurityMonitoringAPI.edit_security_monitoring_signal_assignee ...' end # verify the required parameter 'signal_id' is set if @api_client.config.client_side_validation && signal_id.nil? fail ArgumentError, "Missing the required parameter 'signal_id' when calling SecurityMonitoringAPI.edit_security_monitoring_signal_assignee" end # verify the required parameter 'body' is set if @api_client.config.client_side_validation && body.nil? fail ArgumentError, "Missing the required parameter 'body' when calling SecurityMonitoringAPI.edit_security_monitoring_signal_assignee" end # resource path local_var_path = '/api/v1/security_analytics/signals/{signal_id}/assignee'.sub('{signal_id}', CGI.escape(signal_id.to_s).gsub('%2F', '/')) # query parameters query_params = opts[:query_params] || {} # header parameters header_params = opts[:header_params] || {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # HTTP header 'Content-Type' header_params['Content-Type'] = @api_client.select_header_content_type(['application/json']) # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:debug_body] || @api_client.object_to_http_body(body) # return_type return_type = opts[:debug_return_type] || 'SuccessfulSignalUpdateResponse' # auth_names auth_names = opts[:debug_auth_names] || [:apiKeyAuth, :appKeyAuth] = opts.merge( :operation => :edit_security_monitoring_signal_assignee, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => return_type, :api_version => "V1" ) data, status_code, headers = @api_client.call_api(Net::HTTP::Patch, local_var_path, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: SecurityMonitoringAPI#edit_security_monitoring_signal_assignee\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#edit_security_monitoring_signal_state(signal_id, body, opts = {}) ⇒ Object
Change the triage state of a security signal.
173 174 175 176 |
# File 'lib/datadog_api_client/v1/api/security_monitoring_api.rb', line 173 def edit_security_monitoring_signal_state(signal_id, body, opts = {}) data, _status_code, _headers = edit_security_monitoring_signal_state_with_http_info(signal_id, body, opts) data end |
#edit_security_monitoring_signal_state_with_http_info(signal_id, body, opts = {}) ⇒ Array<(SuccessfulSignalUpdateResponse, Integer, Hash)>
Change the triage state of a security signal.
Change the triage state of a security signal.
186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 |
# File 'lib/datadog_api_client/v1/api/security_monitoring_api.rb', line 186 def edit_security_monitoring_signal_state_with_http_info(signal_id, body, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: SecurityMonitoringAPI.edit_security_monitoring_signal_state ...' end # verify the required parameter 'signal_id' is set if @api_client.config.client_side_validation && signal_id.nil? fail ArgumentError, "Missing the required parameter 'signal_id' when calling SecurityMonitoringAPI.edit_security_monitoring_signal_state" end # verify the required parameter 'body' is set if @api_client.config.client_side_validation && body.nil? fail ArgumentError, "Missing the required parameter 'body' when calling SecurityMonitoringAPI.edit_security_monitoring_signal_state" end # resource path local_var_path = '/api/v1/security_analytics/signals/{signal_id}/state'.sub('{signal_id}', CGI.escape(signal_id.to_s).gsub('%2F', '/')) # query parameters query_params = opts[:query_params] || {} # header parameters header_params = opts[:header_params] || {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # HTTP header 'Content-Type' header_params['Content-Type'] = @api_client.select_header_content_type(['application/json']) # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:debug_body] || @api_client.object_to_http_body(body) # return_type return_type = opts[:debug_return_type] || 'SuccessfulSignalUpdateResponse' # auth_names auth_names = opts[:debug_auth_names] || [:apiKeyAuth, :appKeyAuth] = opts.merge( :operation => :edit_security_monitoring_signal_state, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => return_type, :api_version => "V1" ) data, status_code, headers = @api_client.call_api(Net::HTTP::Patch, local_var_path, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: SecurityMonitoringAPI#edit_security_monitoring_signal_state\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |