Class: DatadogAPIClient::V2::SecurityMonitoringAPI
- Inherits:
-
Object
- Object
- DatadogAPIClient::V2::SecurityMonitoringAPI
- Defined in:
- lib/datadog_api_client/v2/api/security_monitoring_api.rb
Instance Attribute Summary collapse
-
#api_client ⇒ Object
Returns the value of attribute api_client.
Instance Method Summary collapse
-
#create_security_filter(body, opts = {}) ⇒ Object
Create a security filter.
-
#create_security_filter_with_http_info(body, opts = {}) ⇒ Array<(SecurityFilterResponse, Integer, Hash)>
Create a security filter.
-
#create_security_monitoring_rule(body, opts = {}) ⇒ Object
Create a detection rule.
-
#create_security_monitoring_rule_with_http_info(body, opts = {}) ⇒ Array<(SecurityMonitoringRuleResponse, Integer, Hash)>
Create a detection rule.
-
#create_security_monitoring_suppression(body, opts = {}) ⇒ Object
Create a suppression rule.
-
#create_security_monitoring_suppression_with_http_info(body, opts = {}) ⇒ Array<(SecurityMonitoringSuppressionResponse, Integer, Hash)>
Create a suppression rule.
-
#delete_security_filter(security_filter_id, opts = {}) ⇒ Object
Delete a security filter.
-
#delete_security_filter_with_http_info(security_filter_id, opts = {}) ⇒ Array<(nil, Integer, Hash)>
Delete a security filter.
-
#delete_security_monitoring_rule(rule_id, opts = {}) ⇒ Object
Delete an existing rule.
-
#delete_security_monitoring_rule_with_http_info(rule_id, opts = {}) ⇒ Array<(nil, Integer, Hash)>
Delete an existing rule.
-
#delete_security_monitoring_suppression(suppression_id, opts = {}) ⇒ Object
Delete a suppression rule.
-
#delete_security_monitoring_suppression_with_http_info(suppression_id, opts = {}) ⇒ Array<(nil, Integer, Hash)>
Delete a suppression rule.
-
#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<(SecurityMonitoringSignalTriageUpdateResponse, Integer, Hash)>
Modify the triage assignee of a security signal.
-
#edit_security_monitoring_signal_incidents(signal_id, body, opts = {}) ⇒ Object
Change the related incidents of a security signal.
-
#edit_security_monitoring_signal_incidents_with_http_info(signal_id, body, opts = {}) ⇒ Array<(SecurityMonitoringSignalTriageUpdateResponse, Integer, Hash)>
Change the related incidents 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<(SecurityMonitoringSignalTriageUpdateResponse, Integer, Hash)>
Change the triage state of a security signal.
-
#get_finding(finding_id, opts = {}) ⇒ Object
Get a finding.
-
#get_finding_with_http_info(finding_id, opts = {}) ⇒ Array<(GetFindingResponse, Integer, Hash)>
Get a finding.
-
#get_security_filter(security_filter_id, opts = {}) ⇒ Object
Get a security filter.
-
#get_security_filter_with_http_info(security_filter_id, opts = {}) ⇒ Array<(SecurityFilterResponse, Integer, Hash)>
Get a security filter.
-
#get_security_monitoring_rule(rule_id, opts = {}) ⇒ Object
Get a rule's details.
-
#get_security_monitoring_rule_with_http_info(rule_id, opts = {}) ⇒ Array<(SecurityMonitoringRuleResponse, Integer, Hash)>
Get a rule's details.
-
#get_security_monitoring_signal(signal_id, opts = {}) ⇒ Object
Get a signal's details.
-
#get_security_monitoring_signal_with_http_info(signal_id, opts = {}) ⇒ Array<(SecurityMonitoringSignalResponse, Integer, Hash)>
Get a signal's details.
-
#get_security_monitoring_suppression(suppression_id, opts = {}) ⇒ Object
Get a suppression rule.
-
#get_security_monitoring_suppression_with_http_info(suppression_id, opts = {}) ⇒ Array<(SecurityMonitoringSuppressionResponse, Integer, Hash)>
Get a suppression rule.
-
#initialize(api_client = DatadogAPIClient::APIClient.default) ⇒ SecurityMonitoringAPI
constructor
A new instance of SecurityMonitoringAPI.
-
#list_findings(opts = {}) ⇒ Object
List findings.
-
#list_findings_with_http_info(opts = {}) ⇒ Array<(ListFindingsResponse, Integer, Hash)>
List findings.
-
#list_findings_with_pagination(opts = {}) {|Finding| ... } ⇒ Object
List findings.
-
#list_security_filters(opts = {}) ⇒ Object
Get all security filters.
-
#list_security_filters_with_http_info(opts = {}) ⇒ Array<(SecurityFiltersResponse, Integer, Hash)>
Get all security filters.
-
#list_security_monitoring_rules(opts = {}) ⇒ Object
List rules.
-
#list_security_monitoring_rules_with_http_info(opts = {}) ⇒ Array<(SecurityMonitoringListRulesResponse, Integer, Hash)>
List rules.
-
#list_security_monitoring_signals(opts = {}) ⇒ Object
Get a quick list of security signals.
-
#list_security_monitoring_signals_with_http_info(opts = {}) ⇒ Array<(SecurityMonitoringSignalsListResponse, Integer, Hash)>
Get a quick list of security signals.
-
#list_security_monitoring_signals_with_pagination(opts = {}) {|SecurityMonitoringSignal| ... } ⇒ Object
Get a quick list of security signals.
-
#list_security_monitoring_suppressions(opts = {}) ⇒ Object
Get all suppression rules.
-
#list_security_monitoring_suppressions_with_http_info(opts = {}) ⇒ Array<(SecurityMonitoringSuppressionsResponse, Integer, Hash)>
Get all suppression rules.
-
#mute_findings(body, opts = {}) ⇒ Object
Mute or unmute a batch of findings.
-
#mute_findings_with_http_info(body, opts = {}) ⇒ Array<(BulkMuteFindingsResponse, Integer, Hash)>
Mute or unmute a batch of findings.
-
#search_security_monitoring_signals(opts = {}) ⇒ Object
Get a list of security signals.
-
#search_security_monitoring_signals_with_http_info(opts = {}) ⇒ Array<(SecurityMonitoringSignalsListResponse, Integer, Hash)>
Get a list of security signals.
-
#search_security_monitoring_signals_with_pagination(opts = {}) {|SecurityMonitoringSignal| ... } ⇒ Object
Get a list of security signals.
-
#update_security_filter(security_filter_id, body, opts = {}) ⇒ Object
Update a security filter.
-
#update_security_filter_with_http_info(security_filter_id, body, opts = {}) ⇒ Array<(SecurityFilterResponse, Integer, Hash)>
Update a security filter.
-
#update_security_monitoring_rule(rule_id, body, opts = {}) ⇒ Object
Update an existing rule.
-
#update_security_monitoring_rule_with_http_info(rule_id, body, opts = {}) ⇒ Array<(SecurityMonitoringRuleResponse, Integer, Hash)>
Update an existing rule.
-
#update_security_monitoring_suppression(suppression_id, body, opts = {}) ⇒ Object
Update a suppression rule.
-
#update_security_monitoring_suppression_with_http_info(suppression_id, body, opts = {}) ⇒ Array<(SecurityMonitoringSuppressionResponse, Integer, Hash)>
Update a suppression rule.
-
#validate_security_monitoring_rule(body, opts = {}) ⇒ Object
Validate a detection rule.
-
#validate_security_monitoring_rule_with_http_info(body, opts = {}) ⇒ Array<(nil, Integer, Hash)>
Validate a detection rule.
Constructor Details
#initialize(api_client = DatadogAPIClient::APIClient.default) ⇒ SecurityMonitoringAPI
Returns a new instance of SecurityMonitoringAPI.
22 23 24 |
# File 'lib/datadog_api_client/v2/api/security_monitoring_api.rb', line 22 def initialize(api_client = 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/v2/api/security_monitoring_api.rb', line 20 def api_client @api_client end |
Instance Method Details
#create_security_filter(body, opts = {}) ⇒ Object
Create a security filter.
30 31 32 33 |
# File 'lib/datadog_api_client/v2/api/security_monitoring_api.rb', line 30 def create_security_filter(body, opts = {}) data, _status_code, _headers = create_security_filter_with_http_info(body, opts) data end |
#create_security_filter_with_http_info(body, opts = {}) ⇒ Array<(SecurityFilterResponse, Integer, Hash)>
Create a security filter.
Create a security filter.
See the security filter guide for more examples.
40 41 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 97 98 |
# File 'lib/datadog_api_client/v2/api/security_monitoring_api.rb', line 40 def create_security_filter_with_http_info(body, opts = {}) if @api_client.config.unstable_operations.has_key?(:create_security_filter) unstable_enabled = @api_client.config.unstable_operations[:create_security_filter] if unstable_enabled @api_client.config.logger.warn format("Using unstable operation '%s'", "create_security_filter") else raise APIError.new(message: format("Unstable operation '%s' is disabled", "create_security_filter")) end end if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: SecurityMonitoringAPI.create_security_filter ...' 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.create_security_filter" end # resource path local_var_path = '/api/v2/security_monitoring/configuration/security_filters' # 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] || 'SecurityFilterResponse' # auth_names auth_names = opts[:debug_auth_names] || [:AuthZ, :apiKeyAuth, :appKeyAuth] = opts.merge( :operation => :create_security_filter, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => return_type ) data, status_code, headers = @api_client.call_api(:POST, local_var_path, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: SecurityMonitoringAPI#create_security_filter\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#create_security_monitoring_rule(body, opts = {}) ⇒ Object
Create a detection rule.
105 106 107 108 |
# File 'lib/datadog_api_client/v2/api/security_monitoring_api.rb', line 105 def create_security_monitoring_rule(body, opts = {}) data, _status_code, _headers = create_security_monitoring_rule_with_http_info(body, opts) data end |
#create_security_monitoring_rule_with_http_info(body, opts = {}) ⇒ Array<(SecurityMonitoringRuleResponse, Integer, Hash)>
Create a detection rule.
Create a detection rule.
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 169 170 171 172 173 |
# File 'lib/datadog_api_client/v2/api/security_monitoring_api.rb', line 115 def create_security_monitoring_rule_with_http_info(body, opts = {}) if @api_client.config.unstable_operations.has_key?(:create_security_monitoring_rule) unstable_enabled = @api_client.config.unstable_operations[:create_security_monitoring_rule] if unstable_enabled @api_client.config.logger.warn format("Using unstable operation '%s'", "create_security_monitoring_rule") else raise APIError.new(message: format("Unstable operation '%s' is disabled", "create_security_monitoring_rule")) end end if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: SecurityMonitoringAPI.create_security_monitoring_rule ...' 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.create_security_monitoring_rule" end # resource path local_var_path = '/api/v2/security_monitoring/rules' # 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] || 'SecurityMonitoringRuleResponse' # auth_names auth_names = opts[:debug_auth_names] || [:AuthZ, :apiKeyAuth, :appKeyAuth] = opts.merge( :operation => :create_security_monitoring_rule, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => return_type ) data, status_code, headers = @api_client.call_api(:POST, local_var_path, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: SecurityMonitoringAPI#create_security_monitoring_rule\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#create_security_monitoring_suppression(body, opts = {}) ⇒ Object
Create a suppression rule.
166 167 168 169 |
# File 'lib/datadog_api_client/v2/api/security_monitoring_api.rb', line 166 def create_security_monitoring_suppression(body, opts = {}) data, _status_code, _headers = create_security_monitoring_suppression_with_http_info(body, opts) data end |
#create_security_monitoring_suppression_with_http_info(body, opts = {}) ⇒ Array<(SecurityMonitoringSuppressionResponse, Integer, Hash)>
Create a suppression rule.
Create a new suppression rule.
178 179 180 181 182 183 184 185 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 |
# File 'lib/datadog_api_client/v2/api/security_monitoring_api.rb', line 178 def create_security_monitoring_suppression_with_http_info(body, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: SecurityMonitoringAPI.create_security_monitoring_suppression ...' 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.create_security_monitoring_suppression" end # resource path local_var_path = '/api/v2/security_monitoring/configuration/suppressions' # 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] || 'SecurityMonitoringSuppressionResponse' # auth_names auth_names = opts[:debug_auth_names] || [:apiKeyAuth, :appKeyAuth, :AuthZ] = opts.merge( :operation => :create_security_monitoring_suppression, :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 => "V2" ) data, status_code, headers = @api_client.call_api(Net::HTTP::Post, local_var_path, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: SecurityMonitoringAPI#create_security_monitoring_suppression\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#delete_security_filter(security_filter_id, opts = {}) ⇒ Object
Delete a security filter.
180 181 182 183 |
# File 'lib/datadog_api_client/v2/api/security_monitoring_api.rb', line 180 def delete_security_filter(security_filter_id, opts = {}) delete_security_filter_with_http_info(security_filter_id, opts) nil end |
#delete_security_filter_with_http_info(security_filter_id, opts = {}) ⇒ Array<(nil, Integer, Hash)>
Delete a security filter.
Delete a specific security filter.
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 241 242 243 244 245 246 |
# File 'lib/datadog_api_client/v2/api/security_monitoring_api.rb', line 190 def delete_security_filter_with_http_info(security_filter_id, opts = {}) if @api_client.config.unstable_operations.has_key?(:delete_security_filter) unstable_enabled = @api_client.config.unstable_operations[:delete_security_filter] if unstable_enabled @api_client.config.logger.warn format("Using unstable operation '%s'", "delete_security_filter") else raise APIError.new(message: format("Unstable operation '%s' is disabled", "delete_security_filter")) end end if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: SecurityMonitoringAPI.delete_security_filter ...' end # verify the required parameter 'security_filter_id' is set if @api_client.config.client_side_validation && security_filter_id.nil? fail ArgumentError, "Missing the required parameter 'security_filter_id' when calling SecurityMonitoringAPI.delete_security_filter" end # resource path local_var_path = '/api/v2/security_monitoring/configuration/security_filters/{security_filter_id}'.sub('{' + 'security_filter_id' + '}', CGI.escape(security_filter_id.to_s)) # 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']) # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:debug_body] # return_type return_type = opts[:debug_return_type] # auth_names auth_names = opts[:debug_auth_names] || [:AuthZ, :apiKeyAuth, :appKeyAuth] = opts.merge( :operation => :delete_security_filter, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => return_type ) data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: SecurityMonitoringAPI#delete_security_filter\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#delete_security_monitoring_rule(rule_id, opts = {}) ⇒ Object
Delete an existing rule.
253 254 255 256 |
# File 'lib/datadog_api_client/v2/api/security_monitoring_api.rb', line 253 def delete_security_monitoring_rule(rule_id, opts = {}) delete_security_monitoring_rule_with_http_info(rule_id, opts) nil end |
#delete_security_monitoring_rule_with_http_info(rule_id, opts = {}) ⇒ Array<(nil, Integer, Hash)>
Delete an existing rule.
Delete an existing rule. Default rules cannot be deleted.
263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 |
# File 'lib/datadog_api_client/v2/api/security_monitoring_api.rb', line 263 def delete_security_monitoring_rule_with_http_info(rule_id, opts = {}) if @api_client.config.unstable_operations.has_key?(:delete_security_monitoring_rule) unstable_enabled = @api_client.config.unstable_operations[:delete_security_monitoring_rule] if unstable_enabled @api_client.config.logger.warn format("Using unstable operation '%s'", "delete_security_monitoring_rule") else raise APIError.new(message: format("Unstable operation '%s' is disabled", "delete_security_monitoring_rule")) end end if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: SecurityMonitoringAPI.delete_security_monitoring_rule ...' end # verify the required parameter 'rule_id' is set if @api_client.config.client_side_validation && rule_id.nil? fail ArgumentError, "Missing the required parameter 'rule_id' when calling SecurityMonitoringAPI.delete_security_monitoring_rule" end # resource path local_var_path = '/api/v2/security_monitoring/rules/{rule_id}'.sub('{' + 'rule_id' + '}', CGI.escape(rule_id.to_s)) # 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']) # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:debug_body] # return_type return_type = opts[:debug_return_type] # auth_names auth_names = opts[:debug_auth_names] || [:AuthZ, :apiKeyAuth, :appKeyAuth] = opts.merge( :operation => :delete_security_monitoring_rule, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => return_type ) data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: SecurityMonitoringAPI#delete_security_monitoring_rule\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#delete_security_monitoring_suppression(suppression_id, opts = {}) ⇒ Object
Delete a suppression rule.
363 364 365 366 |
# File 'lib/datadog_api_client/v2/api/security_monitoring_api.rb', line 363 def delete_security_monitoring_suppression(suppression_id, opts = {}) delete_security_monitoring_suppression_with_http_info(suppression_id, opts) nil end |
#delete_security_monitoring_suppression_with_http_info(suppression_id, opts = {}) ⇒ Array<(nil, Integer, Hash)>
Delete a suppression rule.
Delete a specific suppression rule.
375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 |
# File 'lib/datadog_api_client/v2/api/security_monitoring_api.rb', line 375 def delete_security_monitoring_suppression_with_http_info(suppression_id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: SecurityMonitoringAPI.delete_security_monitoring_suppression ...' end # verify the required parameter 'suppression_id' is set if @api_client.config.client_side_validation && suppression_id.nil? fail ArgumentError, "Missing the required parameter 'suppression_id' when calling SecurityMonitoringAPI.delete_security_monitoring_suppression" end # resource path local_var_path = '/api/v2/security_monitoring/configuration/suppressions/{suppression_id}'.sub('{suppression_id}', CGI.escape(suppression_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(['*/*']) # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:debug_body] # return_type return_type = opts[:debug_return_type] # auth_names auth_names = opts[:debug_auth_names] || [:apiKeyAuth, :appKeyAuth, :AuthZ] = opts.merge( :operation => :delete_security_monitoring_suppression, :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 => "V2" ) data, status_code, headers = @api_client.call_api(Net::HTTP::Delete, local_var_path, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: SecurityMonitoringAPI#delete_security_monitoring_suppression\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.
428 429 430 431 |
# File 'lib/datadog_api_client/v2/api/security_monitoring_api.rb', line 428 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<(SecurityMonitoringSignalTriageUpdateResponse, Integer, Hash)>
Modify the triage assignee of a security signal.
Modify the triage assignee of a security signal.
441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 |
# File 'lib/datadog_api_client/v2/api/security_monitoring_api.rb', line 441 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/v2/security_monitoring/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] || 'SecurityMonitoringSignalTriageUpdateResponse' # 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 => "V2" ) 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_incidents(signal_id, body, opts = {}) ⇒ Object
Change the related incidents of a security signal.
500 501 502 503 |
# File 'lib/datadog_api_client/v2/api/security_monitoring_api.rb', line 500 def edit_security_monitoring_signal_incidents(signal_id, body, opts = {}) data, _status_code, _headers = edit_security_monitoring_signal_incidents_with_http_info(signal_id, body, opts) data end |
#edit_security_monitoring_signal_incidents_with_http_info(signal_id, body, opts = {}) ⇒ Array<(SecurityMonitoringSignalTriageUpdateResponse, Integer, Hash)>
Change the related incidents of a security signal.
Change the related incidents for a security signal.
513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 |
# File 'lib/datadog_api_client/v2/api/security_monitoring_api.rb', line 513 def edit_security_monitoring_signal_incidents_with_http_info(signal_id, body, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: SecurityMonitoringAPI.edit_security_monitoring_signal_incidents ...' 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_incidents" 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_incidents" end # resource path local_var_path = '/api/v2/security_monitoring/signals/{signal_id}/incidents'.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] || 'SecurityMonitoringSignalTriageUpdateResponse' # auth_names auth_names = opts[:debug_auth_names] || [:apiKeyAuth, :appKeyAuth] = opts.merge( :operation => :edit_security_monitoring_signal_incidents, :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 => "V2" ) 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_incidents\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.
572 573 574 575 |
# File 'lib/datadog_api_client/v2/api/security_monitoring_api.rb', line 572 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<(SecurityMonitoringSignalTriageUpdateResponse, Integer, Hash)>
Change the triage state of a security signal.
Change the triage state of a security signal.
585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 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 632 633 634 635 636 637 638 639 |
# File 'lib/datadog_api_client/v2/api/security_monitoring_api.rb', line 585 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/v2/security_monitoring/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] || 'SecurityMonitoringSignalTriageUpdateResponse' # 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 => "V2" ) 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 |
#get_finding(finding_id, opts = {}) ⇒ Object
Get a finding.
644 645 646 647 |
# File 'lib/datadog_api_client/v2/api/security_monitoring_api.rb', line 644 def get_finding(finding_id, opts = {}) data, _status_code, _headers = get_finding_with_http_info(finding_id, opts) data end |
#get_finding_with_http_info(finding_id, opts = {}) ⇒ Array<(GetFindingResponse, Integer, Hash)>
Get a finding.
Returns a single finding with message and resource configuration.
657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 |
# File 'lib/datadog_api_client/v2/api/security_monitoring_api.rb', line 657 def get_finding_with_http_info(finding_id, opts = {}) unstable_enabled = @api_client.config.unstable_operations["v2.get_finding".to_sym] if unstable_enabled @api_client.config.logger.warn format("Using unstable operation '%s'", "v2.get_finding") else raise DatadogAPIClient::APIError.new(message: format("Unstable operation '%s' is disabled", "v2.get_finding")) end if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: SecurityMonitoringAPI.get_finding ...' end # verify the required parameter 'finding_id' is set if @api_client.config.client_side_validation && finding_id.nil? fail ArgumentError, "Missing the required parameter 'finding_id' when calling SecurityMonitoringAPI.get_finding" end if @api_client.config.client_side_validation && !opts[:'snapshot_timestamp'].nil? && opts[:'snapshot_timestamp'] < 1 fail ArgumentError, 'invalid value for "opts[:"snapshot_timestamp"]" when calling SecurityMonitoringAPI.get_finding, must be greater than or equal to 1.' end # resource path local_var_path = '/api/v2/posture_management/findings/{finding_id}'.sub('{finding_id}', CGI.escape(finding_id.to_s).gsub('%2F', '/')) # query parameters query_params = opts[:query_params] || {} query_params[:'snapshot_timestamp'] = opts[:'snapshot_timestamp'] if !opts[:'snapshot_timestamp'].nil? # header parameters header_params = opts[:header_params] || {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:debug_body] # return_type return_type = opts[:debug_return_type] || 'GetFindingResponse' # auth_names auth_names = opts[:debug_auth_names] || [:apiKeyAuth, :appKeyAuth, :AuthZ] = opts.merge( :operation => :get_finding, :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 => "V2" ) data, status_code, headers = @api_client.call_api(Net::HTTP::Get, local_var_path, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: SecurityMonitoringAPI#get_finding\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#get_security_filter(security_filter_id, opts = {}) ⇒ Object
Get a security filter.
326 327 328 329 |
# File 'lib/datadog_api_client/v2/api/security_monitoring_api.rb', line 326 def get_security_filter(security_filter_id, opts = {}) data, _status_code, _headers = get_security_filter_with_http_info(security_filter_id, opts) data end |
#get_security_filter_with_http_info(security_filter_id, opts = {}) ⇒ Array<(SecurityFilterResponse, Integer, Hash)>
Get a security filter.
Get the details of a specific security filter.
See the security filter guide for more examples.
336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 |
# File 'lib/datadog_api_client/v2/api/security_monitoring_api.rb', line 336 def get_security_filter_with_http_info(security_filter_id, opts = {}) if @api_client.config.unstable_operations.has_key?(:get_security_filter) unstable_enabled = @api_client.config.unstable_operations[:get_security_filter] if unstable_enabled @api_client.config.logger.warn format("Using unstable operation '%s'", "get_security_filter") else raise APIError.new(message: format("Unstable operation '%s' is disabled", "get_security_filter")) end end if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: SecurityMonitoringAPI.get_security_filter ...' end # verify the required parameter 'security_filter_id' is set if @api_client.config.client_side_validation && security_filter_id.nil? fail ArgumentError, "Missing the required parameter 'security_filter_id' when calling SecurityMonitoringAPI.get_security_filter" end # resource path local_var_path = '/api/v2/security_monitoring/configuration/security_filters/{security_filter_id}'.sub('{' + 'security_filter_id' + '}', CGI.escape(security_filter_id.to_s)) # 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']) # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:debug_body] # return_type return_type = opts[:debug_return_type] || 'SecurityFilterResponse' # auth_names auth_names = opts[:debug_auth_names] || [:AuthZ, :apiKeyAuth, :appKeyAuth] = opts.merge( :operation => :get_security_filter, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => return_type ) data, status_code, headers = @api_client.call_api(:GET, local_var_path, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: SecurityMonitoringAPI#get_security_filter\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#get_security_monitoring_rule(rule_id, opts = {}) ⇒ Object
Get a rule's details.
399 400 401 402 |
# File 'lib/datadog_api_client/v2/api/security_monitoring_api.rb', line 399 def get_security_monitoring_rule(rule_id, opts = {}) data, _status_code, _headers = get_security_monitoring_rule_with_http_info(rule_id, opts) data end |
#get_security_monitoring_rule_with_http_info(rule_id, opts = {}) ⇒ Array<(SecurityMonitoringRuleResponse, Integer, Hash)>
Get a rule's details.
Get a rule's details.
409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 |
# File 'lib/datadog_api_client/v2/api/security_monitoring_api.rb', line 409 def get_security_monitoring_rule_with_http_info(rule_id, opts = {}) if @api_client.config.unstable_operations.has_key?(:get_security_monitoring_rule) unstable_enabled = @api_client.config.unstable_operations[:get_security_monitoring_rule] if unstable_enabled @api_client.config.logger.warn format("Using unstable operation '%s'", "get_security_monitoring_rule") else raise APIError.new(message: format("Unstable operation '%s' is disabled", "get_security_monitoring_rule")) end end if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: SecurityMonitoringAPI.get_security_monitoring_rule ...' end # verify the required parameter 'rule_id' is set if @api_client.config.client_side_validation && rule_id.nil? fail ArgumentError, "Missing the required parameter 'rule_id' when calling SecurityMonitoringAPI.get_security_monitoring_rule" end # resource path local_var_path = '/api/v2/security_monitoring/rules/{rule_id}'.sub('{' + 'rule_id' + '}', CGI.escape(rule_id.to_s)) # 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']) # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:debug_body] # return_type return_type = opts[:debug_return_type] || 'SecurityMonitoringRuleResponse' # auth_names auth_names = opts[:debug_auth_names] || [:AuthZ, :apiKeyAuth, :appKeyAuth] = opts.merge( :operation => :get_security_monitoring_rule, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => return_type ) data, status_code, headers = @api_client.call_api(:GET, local_var_path, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: SecurityMonitoringAPI#get_security_monitoring_rule\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#get_security_monitoring_signal(signal_id, opts = {}) ⇒ Object
Get a signal's details.
853 854 855 856 |
# File 'lib/datadog_api_client/v2/api/security_monitoring_api.rb', line 853 def get_security_monitoring_signal(signal_id, opts = {}) data, _status_code, _headers = get_security_monitoring_signal_with_http_info(signal_id, opts) data end |
#get_security_monitoring_signal_with_http_info(signal_id, opts = {}) ⇒ Array<(SecurityMonitoringSignalResponse, Integer, Hash)>
Get a signal's details.
Get a signal's details.
865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 |
# File 'lib/datadog_api_client/v2/api/security_monitoring_api.rb', line 865 def get_security_monitoring_signal_with_http_info(signal_id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: SecurityMonitoringAPI.get_security_monitoring_signal ...' 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.get_security_monitoring_signal" end # resource path local_var_path = '/api/v2/security_monitoring/signals/{signal_id}'.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']) # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:debug_body] # return_type return_type = opts[:debug_return_type] || 'SecurityMonitoringSignalResponse' # auth_names auth_names = opts[:debug_auth_names] || [:apiKeyAuth, :appKeyAuth, :AuthZ] = opts.merge( :operation => :get_security_monitoring_signal, :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 => "V2" ) data, status_code, headers = @api_client.call_api(Net::HTTP::Get, local_var_path, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: SecurityMonitoringAPI#get_security_monitoring_signal\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#get_security_monitoring_suppression(suppression_id, opts = {}) ⇒ Object
Get a suppression rule.
918 919 920 921 |
# File 'lib/datadog_api_client/v2/api/security_monitoring_api.rb', line 918 def get_security_monitoring_suppression(suppression_id, opts = {}) data, _status_code, _headers = get_security_monitoring_suppression_with_http_info(suppression_id, opts) data end |
#get_security_monitoring_suppression_with_http_info(suppression_id, opts = {}) ⇒ Array<(SecurityMonitoringSuppressionResponse, Integer, Hash)>
Get a suppression rule.
Get the details of a specific suppression rule.
930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 |
# File 'lib/datadog_api_client/v2/api/security_monitoring_api.rb', line 930 def get_security_monitoring_suppression_with_http_info(suppression_id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: SecurityMonitoringAPI.get_security_monitoring_suppression ...' end # verify the required parameter 'suppression_id' is set if @api_client.config.client_side_validation && suppression_id.nil? fail ArgumentError, "Missing the required parameter 'suppression_id' when calling SecurityMonitoringAPI.get_security_monitoring_suppression" end # resource path local_var_path = '/api/v2/security_monitoring/configuration/suppressions/{suppression_id}'.sub('{suppression_id}', CGI.escape(suppression_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']) # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:debug_body] # return_type return_type = opts[:debug_return_type] || 'SecurityMonitoringSuppressionResponse' # auth_names auth_names = opts[:debug_auth_names] || [:apiKeyAuth, :appKeyAuth, :AuthZ] = opts.merge( :operation => :get_security_monitoring_suppression, :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 => "V2" ) data, status_code, headers = @api_client.call_api(Net::HTTP::Get, local_var_path, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: SecurityMonitoringAPI#get_security_monitoring_suppression\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#list_findings(opts = {}) ⇒ Object
List findings.
983 984 985 986 |
# File 'lib/datadog_api_client/v2/api/security_monitoring_api.rb', line 983 def list_findings(opts = {}) data, _status_code, _headers = list_findings_with_http_info(opts) data end |
#list_findings_with_http_info(opts = {}) ⇒ Array<(ListFindingsResponse, Integer, Hash)>
List findings.
Get a list of CSPM findings.
Filtering
Filters can be applied by appending query parameters to the URL.
- Using a single filter:
?filter[attribute_key]=attribute_value
- Chaining filters:
?filter[attribute_key]=attribute_value&filter[attribute_key]=attribute_value...
- Filtering on tags:
?filter[tags]=tag_key:tag_value&filter[tags]=tag_key_2:tag_value_2
Here, attribute_key
can be any of the filter keys described further below.
Query parameters of type integer
support comparison operators (>
, >=
, <
, <=
). This is particularly useful when filtering by evaluation_changed_at
or resource_discovery_timestamp
. For example: ?filter[evaluation_changed_at]=>20123123121
.
You can also use the negation operator on strings. For example, use filter[resource_type]=-aws*
to filter for any non-AWS resources.
The operator must come after the equal sign. For example, to filter with the >=
operator, add the operator after the equal sign: filter[evaluation_changed_at]=>=1678809373257
.
Query parameters must be only among the documented ones and with values of correct types. Duplicated query parameters (e.g. filter[status]=low&filter[status]=info
) are not allowed.
Response
The response includes an array of finding objects, pagination metadata, and a count of items that match the query.
Each finding object contains the following:
- The finding ID that can be used in a
GetFinding
request to retrieve the full finding details. - Core attributes, including status, evaluation, high-level resource details, muted state, and rule details.
evaluation_changed_at
andresource_discovery_date
time stamps.- An array of associated tags.
1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 |
# File 'lib/datadog_api_client/v2/api/security_monitoring_api.rb', line 1036 def list_findings_with_http_info(opts = {}) unstable_enabled = @api_client.config.unstable_operations["v2.list_findings".to_sym] if unstable_enabled @api_client.config.logger.warn format("Using unstable operation '%s'", "v2.list_findings") else raise DatadogAPIClient::APIError.new(message: format("Unstable operation '%s' is disabled", "v2.list_findings")) end if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: SecurityMonitoringAPI.list_findings ...' end if @api_client.config.client_side_validation && !opts[:'page_limit'].nil? && opts[:'page_limit'] > 1000 fail ArgumentError, 'invalid value for "opts[:"page_limit"]" when calling SecurityMonitoringAPI.list_findings, must be smaller than or equal to 1000.' end if @api_client.config.client_side_validation && !opts[:'page_limit'].nil? && opts[:'page_limit'] < 1 fail ArgumentError, 'invalid value for "opts[:"page_limit"]" when calling SecurityMonitoringAPI.list_findings, must be greater than or equal to 1.' end if @api_client.config.client_side_validation && !opts[:'snapshot_timestamp'].nil? && opts[:'snapshot_timestamp'] < 1 fail ArgumentError, 'invalid value for "opts[:"snapshot_timestamp"]" when calling SecurityMonitoringAPI.list_findings, must be greater than or equal to 1.' end allowable_values = ['pass', 'fail'] if @api_client.config.client_side_validation && opts[:'filter_evaluation'] && !allowable_values.include?(opts[:'filter_evaluation']) fail ArgumentError, "invalid value for \"filter_evaluation\", must be one of #{allowable_values}" end allowable_values = ['critical', 'high', 'medium', 'low', 'info'] if @api_client.config.client_side_validation && opts[:'filter_status'] && !allowable_values.include?(opts[:'filter_status']) fail ArgumentError, "invalid value for \"filter_status\", must be one of #{allowable_values}" end # resource path local_var_path = '/api/v2/posture_management/findings' # query parameters query_params = opts[:query_params] || {} query_params[:'page[limit]'] = opts[:'page_limit'] if !opts[:'page_limit'].nil? query_params[:'snapshot_timestamp'] = opts[:'snapshot_timestamp'] if !opts[:'snapshot_timestamp'].nil? query_params[:'page[cursor]'] = opts[:'page_cursor'] if !opts[:'page_cursor'].nil? query_params[:'filter[tags]'] = opts[:'filter_tags'] if !opts[:'filter_tags'].nil? query_params[:'filter[evaluation_changed_at]'] = opts[:'filter_evaluation_changed_at'] if !opts[:'filter_evaluation_changed_at'].nil? query_params[:'filter[muted]'] = opts[:'filter_muted'] if !opts[:'filter_muted'].nil? query_params[:'filter[rule_id]'] = opts[:'filter_rule_id'] if !opts[:'filter_rule_id'].nil? query_params[:'filter[rule_name]'] = opts[:'filter_rule_name'] if !opts[:'filter_rule_name'].nil? query_params[:'filter[resource_type]'] = opts[:'filter_resource_type'] if !opts[:'filter_resource_type'].nil? query_params[:'filter[discovery_timestamp]'] = opts[:'filter_discovery_timestamp'] if !opts[:'filter_discovery_timestamp'].nil? query_params[:'filter[evaluation]'] = opts[:'filter_evaluation'] if !opts[:'filter_evaluation'].nil? query_params[:'filter[status]'] = opts[:'filter_status'] if !opts[:'filter_status'].nil? # header parameters header_params = opts[:header_params] || {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:debug_body] # return_type return_type = opts[:debug_return_type] || 'ListFindingsResponse' # auth_names auth_names = opts[:debug_auth_names] || [:apiKeyAuth, :appKeyAuth, :AuthZ] = opts.merge( :operation => :list_findings, :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 => "V2" ) data, status_code, headers = @api_client.call_api(Net::HTTP::Get, local_var_path, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: SecurityMonitoringAPI#list_findings\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#list_findings_with_pagination(opts = {}) {|Finding| ... } ⇒ Object
List findings.
Provide a paginated version of #list_findings, returning all items.
To use it you need to use a block: list_findings_with_pagination { |item| p item }
1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 |
# File 'lib/datadog_api_client/v2/api/security_monitoring_api.rb', line 1124 def list_findings_with_pagination(opts = {}) api_version = "V2" page_size = @api_client.get_attribute_from_path(opts, "page_limit", 100) @api_client.set_attribute_from_path(api_version, opts, "page_limit", Integer, page_size) while true do response = list_findings(opts) @api_client.get_attribute_from_path(response, "data").each { |item| yield(item) } if @api_client.get_attribute_from_path(response, "data").length < page_size break end @api_client.set_attribute_from_path(api_version, opts, "page_cursor", String, @api_client.get_attribute_from_path(response, "meta.page.cursor")) end end |
#list_security_filters(opts = {}) ⇒ Object
Get all security filters.
471 472 473 474 |
# File 'lib/datadog_api_client/v2/api/security_monitoring_api.rb', line 471 def list_security_filters(opts = {}) data, _status_code, _headers = list_security_filters_with_http_info(opts) data end |
#list_security_filters_with_http_info(opts = {}) ⇒ Array<(SecurityFiltersResponse, Integer, Hash)>
Get all security filters.
Get the list of configured security filters with their definitions.
480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 |
# File 'lib/datadog_api_client/v2/api/security_monitoring_api.rb', line 480 def list_security_filters_with_http_info(opts = {}) if @api_client.config.unstable_operations.has_key?(:list_security_filters) unstable_enabled = @api_client.config.unstable_operations[:list_security_filters] if unstable_enabled @api_client.config.logger.warn format("Using unstable operation '%s'", "list_security_filters") else raise APIError.new(message: format("Unstable operation '%s' is disabled", "list_security_filters")) end end if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: SecurityMonitoringAPI.list_security_filters ...' end # resource path local_var_path = '/api/v2/security_monitoring/configuration/security_filters' # 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']) # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:debug_body] # return_type return_type = opts[:debug_return_type] || 'SecurityFiltersResponse' # auth_names auth_names = opts[:debug_auth_names] || [:AuthZ, :apiKeyAuth, :appKeyAuth] = opts.merge( :operation => :list_security_filters, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => return_type ) data, status_code, headers = @api_client.call_api(:GET, local_var_path, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: SecurityMonitoringAPI#list_security_filters\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#list_security_monitoring_rules(opts = {}) ⇒ Object
List rules.
540 541 542 543 |
# File 'lib/datadog_api_client/v2/api/security_monitoring_api.rb', line 540 def list_security_monitoring_rules(opts = {}) data, _status_code, _headers = list_security_monitoring_rules_with_http_info(opts) data end |
#list_security_monitoring_rules_with_http_info(opts = {}) ⇒ Array<(SecurityMonitoringListRulesResponse, Integer, Hash)>
List rules.
List rules.
551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 |
# File 'lib/datadog_api_client/v2/api/security_monitoring_api.rb', line 551 def list_security_monitoring_rules_with_http_info(opts = {}) if @api_client.config.unstable_operations.has_key?(:list_security_monitoring_rules) unstable_enabled = @api_client.config.unstable_operations[:list_security_monitoring_rules] if unstable_enabled @api_client.config.logger.warn format("Using unstable operation '%s'", "list_security_monitoring_rules") else raise APIError.new(message: format("Unstable operation '%s' is disabled", "list_security_monitoring_rules")) end end if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: SecurityMonitoringAPI.list_security_monitoring_rules ...' end # resource path local_var_path = '/api/v2/security_monitoring/rules' # query parameters query_params = opts[:query_params] || {} query_params[:'page[size]'] = opts[:'page_size'] if !opts[:'page_size'].nil? query_params[:'page[number]'] = opts[:'page_number'] if !opts[:'page_number'].nil? # header parameters header_params = opts[:header_params] || {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:debug_body] # return_type return_type = opts[:debug_return_type] || 'SecurityMonitoringListRulesResponse' # auth_names auth_names = opts[:debug_auth_names] || [:AuthZ, :apiKeyAuth, :appKeyAuth] = opts.merge( :operation => :list_security_monitoring_rules, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => return_type ) data, status_code, headers = @api_client.call_api(:GET, local_var_path, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: SecurityMonitoringAPI#list_security_monitoring_rules\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#list_security_monitoring_signals(opts = {}) ⇒ Object
Get a quick list of security signals.
617 618 619 620 |
# File 'lib/datadog_api_client/v2/api/security_monitoring_api.rb', line 617 def list_security_monitoring_signals(opts = {}) data, _status_code, _headers = list_security_monitoring_signals_with_http_info(opts) data end |
#list_security_monitoring_signals_with_http_info(opts = {}) ⇒ Array<(SecurityMonitoringSignalsListResponse, Integer, Hash)>
Get a quick list of security signals.
The list endpoint returns security signals that match a search query. Both this endpoint and the POST endpoint can be used interchangeably when listing security signals.
632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 |
# File 'lib/datadog_api_client/v2/api/security_monitoring_api.rb', line 632 def list_security_monitoring_signals_with_http_info(opts = {}) if @api_client.config.unstable_operations.has_key?(:list_security_monitoring_signals) unstable_enabled = @api_client.config.unstable_operations[:list_security_monitoring_signals] if unstable_enabled @api_client.config.logger.warn format("Using unstable operation '%s'", "list_security_monitoring_signals") else raise APIError.new(message: format("Unstable operation '%s' is disabled", "list_security_monitoring_signals")) end end if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: SecurityMonitoringAPI.list_security_monitoring_signals ...' end if @api_client.config.client_side_validation && !opts[:'page_limit'].nil? && opts[:'page_limit'] > 1000 fail ArgumentError, 'invalid value for "opts[:"page_limit"]" when calling SecurityMonitoringAPI.list_security_monitoring_signals, must be smaller than or equal to 1000.' end # resource path local_var_path = '/api/v2/security_monitoring/signals' # query parameters query_params = opts[:query_params] || {} query_params[:'filter[query]'] = opts[:'filter_query'] if !opts[:'filter_query'].nil? query_params[:'filter[from]'] = opts[:'filter_from'] if !opts[:'filter_from'].nil? query_params[:'filter[to]'] = opts[:'filter_to'] if !opts[:'filter_to'].nil? query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil? query_params[:'page[cursor]'] = opts[:'page_cursor'] if !opts[:'page_cursor'].nil? query_params[:'page[limit]'] = opts[:'page_limit'] if !opts[:'page_limit'].nil? # header parameters header_params = opts[:header_params] || {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:debug_body] # return_type return_type = opts[:debug_return_type] || 'SecurityMonitoringSignalsListResponse' # auth_names auth_names = opts[:debug_auth_names] || [:AuthZ, :apiKeyAuth, :appKeyAuth] = opts.merge( :operation => :list_security_monitoring_signals, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => return_type ) data, status_code, headers = @api_client.call_api(:GET, local_var_path, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: SecurityMonitoringAPI#list_security_monitoring_signals\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#list_security_monitoring_signals_with_pagination(opts = {}) {|SecurityMonitoringSignal| ... } ⇒ Object
Get a quick list of security signals.
Provide a paginated version of #list_security_monitoring_signals, returning all items.
To use it you need to use a block: list_security_monitoring_signals_with_pagination { |item| p item }
1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 |
# File 'lib/datadog_api_client/v2/api/security_monitoring_api.rb', line 1350 def list_security_monitoring_signals_with_pagination(opts = {}) api_version = "V2" page_size = @api_client.get_attribute_from_path(opts, "page_limit", 10) @api_client.set_attribute_from_path(api_version, opts, "page_limit", Integer, page_size) while true do response = list_security_monitoring_signals(opts) @api_client.get_attribute_from_path(response, "data").each { |item| yield(item) } if @api_client.get_attribute_from_path(response, "data").length < page_size break end @api_client.set_attribute_from_path(api_version, opts, "page_cursor", String, @api_client.get_attribute_from_path(response, "meta.page.after")) end end |
#list_security_monitoring_suppressions(opts = {}) ⇒ Object
Get all suppression rules.
1367 1368 1369 1370 |
# File 'lib/datadog_api_client/v2/api/security_monitoring_api.rb', line 1367 def list_security_monitoring_suppressions(opts = {}) data, _status_code, _headers = list_security_monitoring_suppressions_with_http_info(opts) data end |
#list_security_monitoring_suppressions_with_http_info(opts = {}) ⇒ Array<(SecurityMonitoringSuppressionsResponse, Integer, Hash)>
Get all suppression rules.
Get the list of all suppression rules.
1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 |
# File 'lib/datadog_api_client/v2/api/security_monitoring_api.rb', line 1378 def list_security_monitoring_suppressions_with_http_info(opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: SecurityMonitoringAPI.list_security_monitoring_suppressions ...' end # resource path local_var_path = '/api/v2/security_monitoring/configuration/suppressions' # 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']) # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:debug_body] # return_type return_type = opts[:debug_return_type] || 'SecurityMonitoringSuppressionsResponse' # auth_names auth_names = opts[:debug_auth_names] || [:apiKeyAuth, :appKeyAuth, :AuthZ] = opts.merge( :operation => :list_security_monitoring_suppressions, :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 => "V2" ) data, status_code, headers = @api_client.call_api(Net::HTTP::Get, local_var_path, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: SecurityMonitoringAPI#list_security_monitoring_suppressions\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#mute_findings(body, opts = {}) ⇒ Object
Mute or unmute a batch of findings.
1427 1428 1429 1430 |
# File 'lib/datadog_api_client/v2/api/security_monitoring_api.rb', line 1427 def mute_findings(body, opts = {}) data, _status_code, _headers = mute_findings_with_http_info(body, opts) data end |
#mute_findings_with_http_info(body, opts = {}) ⇒ Array<(BulkMuteFindingsResponse, Integer, Hash)>
Mute or unmute a batch of findings.
Mute or unmute findings.
1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 |
# File 'lib/datadog_api_client/v2/api/security_monitoring_api.rb', line 1439 def mute_findings_with_http_info(body, opts = {}) unstable_enabled = @api_client.config.unstable_operations["v2.mute_findings".to_sym] if unstable_enabled @api_client.config.logger.warn format("Using unstable operation '%s'", "v2.mute_findings") else raise DatadogAPIClient::APIError.new(message: format("Unstable operation '%s' is disabled", "v2.mute_findings")) end if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: SecurityMonitoringAPI.mute_findings ...' 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.mute_findings" end # resource path local_var_path = '/api/v2/posture_management/findings' # 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] || 'BulkMuteFindingsResponse' # auth_names auth_names = opts[:debug_auth_names] || [:apiKeyAuth, :appKeyAuth] = opts.merge( :operation => :mute_findings, :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 => "V2" ) 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#mute_findings\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#search_security_monitoring_signals(opts = {}) ⇒ Object
Get a list of security signals.
701 702 703 704 |
# File 'lib/datadog_api_client/v2/api/security_monitoring_api.rb', line 701 def search_security_monitoring_signals(opts = {}) data, _status_code, _headers = search_security_monitoring_signals_with_http_info(opts) data end |
#search_security_monitoring_signals_with_http_info(opts = {}) ⇒ Array<(SecurityMonitoringSignalsListResponse, Integer, Hash)>
Get a list of security signals.
Returns security signals that match a search query. Both this endpoint and the GET endpoint can be used interchangeably for listing security signals.
711 712 713 714 715 716 717 718 719 720 721 722 723 724 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 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 |
# File 'lib/datadog_api_client/v2/api/security_monitoring_api.rb', line 711 def search_security_monitoring_signals_with_http_info(opts = {}) if @api_client.config.unstable_operations.has_key?(:search_security_monitoring_signals) unstable_enabled = @api_client.config.unstable_operations[:search_security_monitoring_signals] if unstable_enabled @api_client.config.logger.warn format("Using unstable operation '%s'", "search_security_monitoring_signals") else raise APIError.new(message: format("Unstable operation '%s' is disabled", "search_security_monitoring_signals")) end end if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: SecurityMonitoringAPI.search_security_monitoring_signals ...' end # resource path local_var_path = '/api/v2/security_monitoring/signals/search' # 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(opts[:'body']) # return_type return_type = opts[:debug_return_type] || 'SecurityMonitoringSignalsListResponse' # auth_names auth_names = opts[:debug_auth_names] || [:AuthZ, :apiKeyAuth, :appKeyAuth] = opts.merge( :operation => :search_security_monitoring_signals, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => return_type ) data, status_code, headers = @api_client.call_api(:POST, local_var_path, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: SecurityMonitoringAPI#search_security_monitoring_signals\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#search_security_monitoring_signals_with_pagination(opts = {}) {|SecurityMonitoringSignal| ... } ⇒ Object
Get a list of security signals.
Provide a paginated version of #search_security_monitoring_signals, returning all items.
To use it you need to use a block: search_security_monitoring_signals_with_pagination { |item| p item }
1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 |
# File 'lib/datadog_api_client/v2/api/security_monitoring_api.rb', line 1569 def search_security_monitoring_signals_with_pagination(opts = {}) api_version = "V2" page_size = @api_client.get_attribute_from_path(opts, "body.page.limit", 10) @api_client.set_attribute_from_path(api_version, opts, "body.page.limit", SecurityMonitoringSignalListRequest, page_size) while true do response = search_security_monitoring_signals(opts) @api_client.get_attribute_from_path(response, "data").each { |item| yield(item) } if @api_client.get_attribute_from_path(response, "data").length < page_size break end @api_client.set_attribute_from_path(api_version, opts, "body.page.cursor", SecurityMonitoringSignalListRequest, @api_client.get_attribute_from_path(response, "meta.page.after")) end end |
#update_security_filter(security_filter_id, body, opts = {}) ⇒ Object
Update a security filter.
773 774 775 776 |
# File 'lib/datadog_api_client/v2/api/security_monitoring_api.rb', line 773 def update_security_filter(security_filter_id, body, opts = {}) data, _status_code, _headers = update_security_filter_with_http_info(security_filter_id, body, opts) data end |
#update_security_filter_with_http_info(security_filter_id, body, opts = {}) ⇒ Array<(SecurityFilterResponse, Integer, Hash)>
Update a security filter.
Update a specific security filter. Returns the security filter object when the request is successful.
784 785 786 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 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 |
# File 'lib/datadog_api_client/v2/api/security_monitoring_api.rb', line 784 def update_security_filter_with_http_info(security_filter_id, body, opts = {}) if @api_client.config.unstable_operations.has_key?(:update_security_filter) unstable_enabled = @api_client.config.unstable_operations[:update_security_filter] if unstable_enabled @api_client.config.logger.warn format("Using unstable operation '%s'", "update_security_filter") else raise APIError.new(message: format("Unstable operation '%s' is disabled", "update_security_filter")) end end if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: SecurityMonitoringAPI.update_security_filter ...' end # verify the required parameter 'security_filter_id' is set if @api_client.config.client_side_validation && security_filter_id.nil? fail ArgumentError, "Missing the required parameter 'security_filter_id' when calling SecurityMonitoringAPI.update_security_filter" 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.update_security_filter" end # resource path local_var_path = '/api/v2/security_monitoring/configuration/security_filters/{security_filter_id}'.sub('{' + 'security_filter_id' + '}', CGI.escape(security_filter_id.to_s)) # 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] || 'SecurityFilterResponse' # auth_names auth_names = opts[:debug_auth_names] || [:AuthZ, :apiKeyAuth, :appKeyAuth] = opts.merge( :operation => :update_security_filter, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => return_type ) data, status_code, headers = @api_client.call_api(:PATCH, local_var_path, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: SecurityMonitoringAPI#update_security_filter\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#update_security_monitoring_rule(rule_id, body, opts = {}) ⇒ Object
Update an existing rule.
854 855 856 857 |
# File 'lib/datadog_api_client/v2/api/security_monitoring_api.rb', line 854 def update_security_monitoring_rule(rule_id, body, opts = {}) data, _status_code, _headers = update_security_monitoring_rule_with_http_info(rule_id, body, opts) data end |
#update_security_monitoring_rule_with_http_info(rule_id, body, opts = {}) ⇒ Array<(SecurityMonitoringRuleResponse, Integer, Hash)>
Update an existing rule.
Update an existing rule. When updating cases
, queries
or options
, the whole field
must be included. For example, when modifying a query all queries must be included.
Default rules can only be updated to be enabled, to change notifications, or to update
the tags (default tags cannot be removed).
865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 |
# File 'lib/datadog_api_client/v2/api/security_monitoring_api.rb', line 865 def update_security_monitoring_rule_with_http_info(rule_id, body, opts = {}) if @api_client.config.unstable_operations.has_key?(:update_security_monitoring_rule) unstable_enabled = @api_client.config.unstable_operations[:update_security_monitoring_rule] if unstable_enabled @api_client.config.logger.warn format("Using unstable operation '%s'", "update_security_monitoring_rule") else raise APIError.new(message: format("Unstable operation '%s' is disabled", "update_security_monitoring_rule")) end end if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: SecurityMonitoringAPI.update_security_monitoring_rule ...' end # verify the required parameter 'rule_id' is set if @api_client.config.client_side_validation && rule_id.nil? fail ArgumentError, "Missing the required parameter 'rule_id' when calling SecurityMonitoringAPI.update_security_monitoring_rule" 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.update_security_monitoring_rule" end # resource path local_var_path = '/api/v2/security_monitoring/rules/{rule_id}'.sub('{' + 'rule_id' + '}', CGI.escape(rule_id.to_s)) # 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] || 'SecurityMonitoringRuleResponse' # auth_names auth_names = opts[:debug_auth_names] || [:AuthZ, :apiKeyAuth, :appKeyAuth] = opts.merge( :operation => :update_security_monitoring_rule, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => return_type ) data, status_code, headers = @api_client.call_api(:PUT, local_var_path, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: SecurityMonitoringAPI#update_security_monitoring_rule\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#update_security_monitoring_suppression(suppression_id, body, opts = {}) ⇒ Object
Update a suppression rule.
1734 1735 1736 1737 |
# File 'lib/datadog_api_client/v2/api/security_monitoring_api.rb', line 1734 def update_security_monitoring_suppression(suppression_id, body, opts = {}) data, _status_code, _headers = update_security_monitoring_suppression_with_http_info(suppression_id, body, opts) data end |
#update_security_monitoring_suppression_with_http_info(suppression_id, body, opts = {}) ⇒ Array<(SecurityMonitoringSuppressionResponse, Integer, Hash)>
Update a suppression rule.
Update a specific suppression rule.
1747 1748 1749 1750 1751 1752 1753 1754 1755 1756 1757 1758 1759 1760 1761 1762 1763 1764 1765 1766 1767 1768 1769 1770 1771 1772 1773 1774 1775 1776 1777 1778 1779 1780 1781 1782 1783 1784 1785 1786 1787 1788 1789 1790 1791 1792 1793 1794 1795 1796 1797 1798 1799 1800 1801 |
# File 'lib/datadog_api_client/v2/api/security_monitoring_api.rb', line 1747 def update_security_monitoring_suppression_with_http_info(suppression_id, body, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: SecurityMonitoringAPI.update_security_monitoring_suppression ...' end # verify the required parameter 'suppression_id' is set if @api_client.config.client_side_validation && suppression_id.nil? fail ArgumentError, "Missing the required parameter 'suppression_id' when calling SecurityMonitoringAPI.update_security_monitoring_suppression" 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.update_security_monitoring_suppression" end # resource path local_var_path = '/api/v2/security_monitoring/configuration/suppressions/{suppression_id}'.sub('{suppression_id}', CGI.escape(suppression_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] || 'SecurityMonitoringSuppressionResponse' # auth_names auth_names = opts[:debug_auth_names] || [:apiKeyAuth, :appKeyAuth, :AuthZ] = opts.merge( :operation => :update_security_monitoring_suppression, :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 => "V2" ) 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#update_security_monitoring_suppression\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#validate_security_monitoring_rule(body, opts = {}) ⇒ Object
Validate a detection rule.
1806 1807 1808 1809 |
# File 'lib/datadog_api_client/v2/api/security_monitoring_api.rb', line 1806 def validate_security_monitoring_rule(body, opts = {}) validate_security_monitoring_rule_with_http_info(body, opts) nil end |
#validate_security_monitoring_rule_with_http_info(body, opts = {}) ⇒ Array<(nil, Integer, Hash)>
Validate a detection rule.
Validate a detection rule.
1818 1819 1820 1821 1822 1823 1824 1825 1826 1827 1828 1829 1830 1831 1832 1833 1834 1835 1836 1837 1838 1839 1840 1841 1842 1843 1844 1845 1846 1847 1848 1849 1850 1851 1852 1853 1854 1855 1856 1857 1858 1859 1860 1861 1862 1863 1864 1865 1866 1867 1868 |
# File 'lib/datadog_api_client/v2/api/security_monitoring_api.rb', line 1818 def validate_security_monitoring_rule_with_http_info(body, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: SecurityMonitoringAPI.validate_security_monitoring_rule ...' 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.validate_security_monitoring_rule" end # resource path local_var_path = '/api/v2/security_monitoring/rules/validation' # 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(['*/*']) # 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] # auth_names auth_names = opts[:debug_auth_names] || [:apiKeyAuth, :appKeyAuth, :AuthZ] = opts.merge( :operation => :validate_security_monitoring_rule, :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 => "V2" ) data, status_code, headers = @api_client.call_api(Net::HTTP::Post, local_var_path, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: SecurityMonitoringAPI#validate_security_monitoring_rule\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |