Class: DatadogAPIClient::V2::CSMThreatsAPI

Inherits:
Object
  • Object
show all
Defined in:
lib/datadog_api_client/v2/api/csm_threats_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = DatadogAPIClient::APIClient.default) ⇒ CSMThreatsAPI

Returns a new instance of CSMThreatsAPI.



22
23
24
# File 'lib/datadog_api_client/v2/api/csm_threats_api.rb', line 22

def initialize(api_client = DatadogAPIClient::APIClient.default)
  @api_client = api_client
end

Instance Attribute Details

#api_clientObject

Returns the value of attribute api_client.



20
21
22
# File 'lib/datadog_api_client/v2/api/csm_threats_api.rb', line 20

def api_client
  @api_client
end

Instance Method Details

#create_cloud_workload_security_agent_rule(body, opts = {}) ⇒ Object

Create a Cloud Workload Security Agent rule.



29
30
31
32
# File 'lib/datadog_api_client/v2/api/csm_threats_api.rb', line 29

def create_cloud_workload_security_agent_rule(body, opts = {})
  data, _status_code, _headers = create_cloud_workload_security_agent_rule_with_http_info(body, opts)
  data
end

#create_cloud_workload_security_agent_rule_with_http_info(body, opts = {}) ⇒ Array<(CloudWorkloadSecurityAgentRuleResponse, Integer, Hash)>

Create a Cloud Workload Security Agent rule.

Create a new Agent rule with the given parameters.

Parameters:

Returns:



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
# File 'lib/datadog_api_client/v2/api/csm_threats_api.rb', line 41

def create_cloud_workload_security_agent_rule_with_http_info(body, opts = {})

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CSMThreatsAPI.create_cloud_workload_security_agent_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 CSMThreatsAPI.create_cloud_workload_security_agent_rule"
  end
  # resource path
  local_var_path = '/api/v2/security_monitoring/cloud_workload_security/agent_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] || 'CloudWorkloadSecurityAgentRuleResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || [:apiKeyAuth, :appKeyAuth]

  new_options = opts.merge(
    :operation => :create_cloud_workload_security_agent_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, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CSMThreatsAPI#create_cloud_workload_security_agent_rule\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#create_csm_threats_agent_rule(body, opts = {}) ⇒ Object

Create a CSM Threats Agent rule.



96
97
98
99
# File 'lib/datadog_api_client/v2/api/csm_threats_api.rb', line 96

def create_csm_threats_agent_rule(body, opts = {})
  data, _status_code, _headers = create_csm_threats_agent_rule_with_http_info(body, opts)
  data
end

#create_csm_threats_agent_rule_with_http_info(body, opts = {}) ⇒ Array<(CloudWorkloadSecurityAgentRuleResponse, Integer, Hash)>

Create a CSM Threats Agent rule.

Create a new Cloud Security Management Threats Agent rule with the given parameters.

Parameters:

Returns:



108
109
110
111
112
113
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
# File 'lib/datadog_api_client/v2/api/csm_threats_api.rb', line 108

def create_csm_threats_agent_rule_with_http_info(body, opts = {})

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CSMThreatsAPI.create_csm_threats_agent_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 CSMThreatsAPI.create_csm_threats_agent_rule"
  end
  # resource path
  local_var_path = '/api/v2/remote_config/products/cws/agent_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] || 'CloudWorkloadSecurityAgentRuleResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || [:apiKeyAuth, :appKeyAuth]

  new_options = opts.merge(
    :operation => :create_csm_threats_agent_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, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CSMThreatsAPI#create_csm_threats_agent_rule\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_cloud_workload_security_agent_rule(agent_rule_id, opts = {}) ⇒ Object

Delete a Cloud Workload Security Agent rule.



163
164
165
166
# File 'lib/datadog_api_client/v2/api/csm_threats_api.rb', line 163

def delete_cloud_workload_security_agent_rule(agent_rule_id, opts = {})
  delete_cloud_workload_security_agent_rule_with_http_info(agent_rule_id, opts)
  nil
end

#delete_cloud_workload_security_agent_rule_with_http_info(agent_rule_id, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Delete a Cloud Workload Security Agent rule.

Delete a specific Agent rule.

Parameters:

  • agent_rule_id (String)

    The ID of the Agent rule.

  • opts (Hash) (defaults to: {})

    the optional parameters

Returns:

  • (Array<(nil, Integer, Hash)>)

    nil, response status code and response headers



175
176
177
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
# File 'lib/datadog_api_client/v2/api/csm_threats_api.rb', line 175

def delete_cloud_workload_security_agent_rule_with_http_info(agent_rule_id, opts = {})

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CSMThreatsAPI.delete_cloud_workload_security_agent_rule ...'
  end
  # verify the required parameter 'agent_rule_id' is set
  if @api_client.config.client_side_validation && agent_rule_id.nil?
    fail ArgumentError, "Missing the required parameter 'agent_rule_id' when calling CSMThreatsAPI.delete_cloud_workload_security_agent_rule"
  end
  # resource path
  local_var_path = '/api/v2/security_monitoring/cloud_workload_security/agent_rules/{agent_rule_id}'.sub('{agent_rule_id}', CGI.escape(agent_rule_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]

  new_options = opts.merge(
    :operation => :delete_cloud_workload_security_agent_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::Delete, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CSMThreatsAPI#delete_cloud_workload_security_agent_rule\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_csm_threats_agent_rule(agent_rule_id, opts = {}) ⇒ Object

Delete a CSM Threats Agent rule.



228
229
230
231
# File 'lib/datadog_api_client/v2/api/csm_threats_api.rb', line 228

def delete_csm_threats_agent_rule(agent_rule_id, opts = {})
  delete_csm_threats_agent_rule_with_http_info(agent_rule_id, opts)
  nil
end

#delete_csm_threats_agent_rule_with_http_info(agent_rule_id, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Delete a CSM Threats Agent rule.

Delete a specific Cloud Security Management Threats Agent rule.

Parameters:

  • agent_rule_id (String)

    The ID of the Agent rule.

  • opts (Hash) (defaults to: {})

    the optional parameters

Returns:

  • (Array<(nil, Integer, Hash)>)

    nil, response status code and response headers



240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
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
# File 'lib/datadog_api_client/v2/api/csm_threats_api.rb', line 240

def delete_csm_threats_agent_rule_with_http_info(agent_rule_id, opts = {})

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CSMThreatsAPI.delete_csm_threats_agent_rule ...'
  end
  # verify the required parameter 'agent_rule_id' is set
  if @api_client.config.client_side_validation && agent_rule_id.nil?
    fail ArgumentError, "Missing the required parameter 'agent_rule_id' when calling CSMThreatsAPI.delete_csm_threats_agent_rule"
  end
  # resource path
  local_var_path = '/api/v2/remote_config/products/cws/agent_rules/{agent_rule_id}'.sub('{agent_rule_id}', CGI.escape(agent_rule_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]

  new_options = opts.merge(
    :operation => :delete_csm_threats_agent_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::Delete, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CSMThreatsAPI#delete_csm_threats_agent_rule\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#download_cloud_workload_policy_file(opts = {}) ⇒ Object

Get the latest Cloud Workload Security policy.



293
294
295
296
# File 'lib/datadog_api_client/v2/api/csm_threats_api.rb', line 293

def download_cloud_workload_policy_file(opts = {})
  data, _status_code, _headers = download_cloud_workload_policy_file_with_http_info(opts)
  data
end

#download_cloud_workload_policy_file_with_http_info(opts = {}) ⇒ Array<(File, Integer, Hash)>

Get the latest Cloud Workload Security policy.

The download endpoint generates a Cloud Workload Security policy file from your currently active Cloud Workload Security rules, and downloads them as a .policy file. This file can then be deployed to your Agents to update the policy running in your environment.

Parameters:

  • opts (Hash) (defaults to: {})

    the optional parameters

Returns:

  • (Array<(File, Integer, Hash)>)

    File data, response status code and response headers



306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
# File 'lib/datadog_api_client/v2/api/csm_threats_api.rb', line 306

def download_cloud_workload_policy_file_with_http_info(opts = {})

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CSMThreatsAPI.download_cloud_workload_policy_file ...'
  end
  # resource path
  local_var_path = '/api/v2/security/cloud_workload/policy/download'

  # 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/yaml', '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] || 'File'

  # auth_names
  auth_names = opts[:debug_auth_names] || [:apiKeyAuth, :appKeyAuth]

  new_options = opts.merge(
    :operation => :download_cloud_workload_policy_file,
    :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, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CSMThreatsAPI#download_cloud_workload_policy_file\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#download_csm_threats_policy(opts = {}) ⇒ Object

Get the latest CSM Threats policy.



355
356
357
358
# File 'lib/datadog_api_client/v2/api/csm_threats_api.rb', line 355

def download_csm_threats_policy(opts = {})
  data, _status_code, _headers = download_csm_threats_policy_with_http_info(opts)
  data
end

#download_csm_threats_policy_with_http_info(opts = {}) ⇒ Array<(File, Integer, Hash)>

Get the latest CSM Threats policy.

The download endpoint generates a CSM Threats policy file from your currently active CSM Threats rules, and downloads them as a ‘.policy` file. This file can then be deployed to your Agents to update the policy running in your environment.

Parameters:

  • opts (Hash) (defaults to: {})

    the optional parameters

Returns:

  • (Array<(File, Integer, Hash)>)

    File data, response status code and response headers



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
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
# File 'lib/datadog_api_client/v2/api/csm_threats_api.rb', line 368

def download_csm_threats_policy_with_http_info(opts = {})

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CSMThreatsAPI.download_csm_threats_policy ...'
  end
  # resource path
  local_var_path = '/api/v2/remote_config/products/cws/policy/download'

  # 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/zip', '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] || 'File'

  # auth_names
  auth_names = opts[:debug_auth_names] || [:apiKeyAuth, :appKeyAuth]

  new_options = opts.merge(
    :operation => :download_csm_threats_policy,
    :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, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CSMThreatsAPI#download_csm_threats_policy\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_cloud_workload_security_agent_rule(agent_rule_id, opts = {}) ⇒ Object

Get a Cloud Workload Security Agent rule.



417
418
419
420
# File 'lib/datadog_api_client/v2/api/csm_threats_api.rb', line 417

def get_cloud_workload_security_agent_rule(agent_rule_id, opts = {})
  data, _status_code, _headers = get_cloud_workload_security_agent_rule_with_http_info(agent_rule_id, opts)
  data
end

#get_cloud_workload_security_agent_rule_with_http_info(agent_rule_id, opts = {}) ⇒ Array<(CloudWorkloadSecurityAgentRuleResponse, Integer, Hash)>

Get a Cloud Workload Security Agent rule.

Get the details of a specific Agent rule.

Parameters:

  • agent_rule_id (String)

    The ID of the Agent rule.

  • opts (Hash) (defaults to: {})

    the optional parameters

Returns:



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
466
467
468
469
470
471
472
473
474
475
476
477
# File 'lib/datadog_api_client/v2/api/csm_threats_api.rb', line 429

def get_cloud_workload_security_agent_rule_with_http_info(agent_rule_id, opts = {})

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CSMThreatsAPI.get_cloud_workload_security_agent_rule ...'
  end
  # verify the required parameter 'agent_rule_id' is set
  if @api_client.config.client_side_validation && agent_rule_id.nil?
    fail ArgumentError, "Missing the required parameter 'agent_rule_id' when calling CSMThreatsAPI.get_cloud_workload_security_agent_rule"
  end
  # resource path
  local_var_path = '/api/v2/security_monitoring/cloud_workload_security/agent_rules/{agent_rule_id}'.sub('{agent_rule_id}', CGI.escape(agent_rule_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] || 'CloudWorkloadSecurityAgentRuleResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || [:apiKeyAuth, :appKeyAuth]

  new_options = opts.merge(
    :operation => :get_cloud_workload_security_agent_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::Get, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CSMThreatsAPI#get_cloud_workload_security_agent_rule\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_csm_threats_agent_rule(agent_rule_id, opts = {}) ⇒ Object

Get a CSM Threats Agent rule.



482
483
484
485
# File 'lib/datadog_api_client/v2/api/csm_threats_api.rb', line 482

def get_csm_threats_agent_rule(agent_rule_id, opts = {})
  data, _status_code, _headers = get_csm_threats_agent_rule_with_http_info(agent_rule_id, opts)
  data
end

#get_csm_threats_agent_rule_with_http_info(agent_rule_id, opts = {}) ⇒ Array<(CloudWorkloadSecurityAgentRuleResponse, Integer, Hash)>

Get a CSM Threats Agent rule.

Get the details of a specific Cloud Security Management Threats Agent rule.

Parameters:

  • agent_rule_id (String)

    The ID of the Agent rule.

  • opts (Hash) (defaults to: {})

    the optional parameters

Returns:



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
533
534
535
536
537
538
539
540
541
542
# File 'lib/datadog_api_client/v2/api/csm_threats_api.rb', line 494

def get_csm_threats_agent_rule_with_http_info(agent_rule_id, opts = {})

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CSMThreatsAPI.get_csm_threats_agent_rule ...'
  end
  # verify the required parameter 'agent_rule_id' is set
  if @api_client.config.client_side_validation && agent_rule_id.nil?
    fail ArgumentError, "Missing the required parameter 'agent_rule_id' when calling CSMThreatsAPI.get_csm_threats_agent_rule"
  end
  # resource path
  local_var_path = '/api/v2/remote_config/products/cws/agent_rules/{agent_rule_id}'.sub('{agent_rule_id}', CGI.escape(agent_rule_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] || 'CloudWorkloadSecurityAgentRuleResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || [:apiKeyAuth, :appKeyAuth]

  new_options = opts.merge(
    :operation => :get_csm_threats_agent_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::Get, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CSMThreatsAPI#get_csm_threats_agent_rule\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#list_cloud_workload_security_agent_rules(opts = {}) ⇒ Object

Get all Cloud Workload Security Agent rules.



547
548
549
550
# File 'lib/datadog_api_client/v2/api/csm_threats_api.rb', line 547

def list_cloud_workload_security_agent_rules(opts = {})
  data, _status_code, _headers = list_cloud_workload_security_agent_rules_with_http_info(opts)
  data
end

#list_cloud_workload_security_agent_rules_with_http_info(opts = {}) ⇒ Array<(CloudWorkloadSecurityAgentRulesListResponse, Integer, Hash)>

Get all Cloud Workload Security Agent rules.

Get the list of Agent rules.

Parameters:

  • opts (Hash) (defaults to: {})

    the optional parameters

Returns:



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
# File 'lib/datadog_api_client/v2/api/csm_threats_api.rb', line 558

def list_cloud_workload_security_agent_rules_with_http_info(opts = {})

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CSMThreatsAPI.list_cloud_workload_security_agent_rules ...'
  end
  # resource path
  local_var_path = '/api/v2/security_monitoring/cloud_workload_security/agent_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'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'CloudWorkloadSecurityAgentRulesListResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || [:apiKeyAuth, :appKeyAuth]

  new_options = opts.merge(
    :operation => :list_cloud_workload_security_agent_rules,
    :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, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CSMThreatsAPI#list_cloud_workload_security_agent_rules\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#list_csm_threats_agent_rules(opts = {}) ⇒ Object

Get all CSM Threats Agent rules.



607
608
609
610
# File 'lib/datadog_api_client/v2/api/csm_threats_api.rb', line 607

def list_csm_threats_agent_rules(opts = {})
  data, _status_code, _headers = list_csm_threats_agent_rules_with_http_info(opts)
  data
end

#list_csm_threats_agent_rules_with_http_info(opts = {}) ⇒ Array<(CloudWorkloadSecurityAgentRulesListResponse, Integer, Hash)>

Get all CSM Threats Agent rules.

Get the list of Cloud Security Management Threats Agent rules.

Parameters:

  • opts (Hash) (defaults to: {})

    the optional parameters

Returns:



618
619
620
621
622
623
624
625
626
627
628
629
630
631
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
# File 'lib/datadog_api_client/v2/api/csm_threats_api.rb', line 618

def list_csm_threats_agent_rules_with_http_info(opts = {})

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CSMThreatsAPI.list_csm_threats_agent_rules ...'
  end
  # resource path
  local_var_path = '/api/v2/remote_config/products/cws/agent_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'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'CloudWorkloadSecurityAgentRulesListResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || [:apiKeyAuth, :appKeyAuth]

  new_options = opts.merge(
    :operation => :list_csm_threats_agent_rules,
    :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, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CSMThreatsAPI#list_csm_threats_agent_rules\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_cloud_workload_security_agent_rule(agent_rule_id, body, opts = {}) ⇒ Object

Update a Cloud Workload Security Agent rule.



667
668
669
670
# File 'lib/datadog_api_client/v2/api/csm_threats_api.rb', line 667

def update_cloud_workload_security_agent_rule(agent_rule_id, body, opts = {})
  data, _status_code, _headers = update_cloud_workload_security_agent_rule_with_http_info(agent_rule_id, body, opts)
  data
end

#update_cloud_workload_security_agent_rule_with_http_info(agent_rule_id, body, opts = {}) ⇒ Array<(CloudWorkloadSecurityAgentRuleResponse, Integer, Hash)>

Update a Cloud Workload Security Agent rule.

Update a specific Agent rule. Returns the Agent rule object when the request is successful.

Parameters:

Returns:



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
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
# File 'lib/datadog_api_client/v2/api/csm_threats_api.rb', line 681

def update_cloud_workload_security_agent_rule_with_http_info(agent_rule_id, body, opts = {})

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CSMThreatsAPI.update_cloud_workload_security_agent_rule ...'
  end
  # verify the required parameter 'agent_rule_id' is set
  if @api_client.config.client_side_validation && agent_rule_id.nil?
    fail ArgumentError, "Missing the required parameter 'agent_rule_id' when calling CSMThreatsAPI.update_cloud_workload_security_agent_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 CSMThreatsAPI.update_cloud_workload_security_agent_rule"
  end
  # resource path
  local_var_path = '/api/v2/security_monitoring/cloud_workload_security/agent_rules/{agent_rule_id}'.sub('{agent_rule_id}', CGI.escape(agent_rule_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] || 'CloudWorkloadSecurityAgentRuleResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || [:apiKeyAuth, :appKeyAuth]

  new_options = opts.merge(
    :operation => :update_cloud_workload_security_agent_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::Patch, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CSMThreatsAPI#update_cloud_workload_security_agent_rule\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_csm_threats_agent_rule(agent_rule_id, body, opts = {}) ⇒ Object

Update a CSM Threats Agent rule.



740
741
742
743
# File 'lib/datadog_api_client/v2/api/csm_threats_api.rb', line 740

def update_csm_threats_agent_rule(agent_rule_id, body, opts = {})
  data, _status_code, _headers = update_csm_threats_agent_rule_with_http_info(agent_rule_id, body, opts)
  data
end

#update_csm_threats_agent_rule_with_http_info(agent_rule_id, body, opts = {}) ⇒ Array<(CloudWorkloadSecurityAgentRuleResponse, Integer, Hash)>

Update a CSM Threats Agent rule.

Update a specific Cloud Security Management Threats Agent rule. Returns the Agent rule object when the request is successful.

Parameters:

Returns:



754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
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
# File 'lib/datadog_api_client/v2/api/csm_threats_api.rb', line 754

def update_csm_threats_agent_rule_with_http_info(agent_rule_id, body, opts = {})

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CSMThreatsAPI.update_csm_threats_agent_rule ...'
  end
  # verify the required parameter 'agent_rule_id' is set
  if @api_client.config.client_side_validation && agent_rule_id.nil?
    fail ArgumentError, "Missing the required parameter 'agent_rule_id' when calling CSMThreatsAPI.update_csm_threats_agent_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 CSMThreatsAPI.update_csm_threats_agent_rule"
  end
  # resource path
  local_var_path = '/api/v2/remote_config/products/cws/agent_rules/{agent_rule_id}'.sub('{agent_rule_id}', CGI.escape(agent_rule_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] || 'CloudWorkloadSecurityAgentRuleResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || [:apiKeyAuth, :appKeyAuth]

  new_options = opts.merge(
    :operation => :update_csm_threats_agent_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::Patch, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CSMThreatsAPI#update_csm_threats_agent_rule\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end