Class: DatadogAPIClient::V2::AgentlessScanningAPI

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

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

Returns a new instance of AgentlessScanningAPI.



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

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

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



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

def api_client
  @api_client
end

Instance Method Details

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

Post an AWS on demand task.

See Also:



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

def create_aws_on_demand_task(body, opts = {})
  data, _status_code, _headers = create_aws_on_demand_task_with_http_info(body, opts)
  data
end

#create_aws_on_demand_task_with_http_info(body, opts = {}) ⇒ Array<(AwsOnDemandResponse, Integer, Hash)>

Post an AWS on demand task.

Trigger the scan of an AWS resource with a high priority. Agentless scanning must be activated for the AWS account containing the resource to scan.

Parameters:

  • body (AwsOnDemandCreateRequest) —

    The definition of the on demand task.

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

    the optional parameters

Returns:

  • (Array<(AwsOnDemandResponse, Integer, Hash)>) —

    AwsOnDemandResponse data, response status code and response headers



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/agentless_scanning_api.rb', line 41

def create_aws_on_demand_task_with_http_info(body, opts = {})

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AgentlessScanningAPI.create_aws_on_demand_task ...'
  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 AgentlessScanningAPI.create_aws_on_demand_task"
  end
  # resource path
  local_var_path = '/api/v2/agentless_scanning/ondemand/aws'

  # 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] || 'AwsOnDemandResponse'

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

  new_options = opts.merge(
    :operation => :create_aws_on_demand_task,
    :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: AgentlessScanningAPI#create_aws_on_demand_task\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

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

Post AWS Scan Options.

See Also:



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

def create_aws_scan_options(body, opts = {})
  data, _status_code, _headers = create_aws_scan_options_with_http_info(body, opts)
  data
end

#create_aws_scan_options_with_http_info(body, opts = {}) ⇒ Array<(AwsScanOptionsResponse, Integer, Hash)>

Post AWS Scan Options.

Activate Agentless scan options for an AWS account.

Parameters:

  • body (AwsScanOptionsCreateRequest) —

    The definition of the new scan options.

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

    the optional parameters

Returns:

  • (Array<(AwsScanOptionsResponse, Integer, Hash)>) —

    AwsScanOptionsResponse data, response status code and response headers



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/agentless_scanning_api.rb', line 108

def create_aws_scan_options_with_http_info(body, opts = {})

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AgentlessScanningAPI.create_aws_scan_options ...'
  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 AgentlessScanningAPI.create_aws_scan_options"
  end
  # resource path
  local_var_path = '/api/v2/agentless_scanning/accounts/aws'

  # 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] || 'AwsScanOptionsResponse'

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

  new_options = opts.merge(
    :operation => :create_aws_scan_options,
    :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: AgentlessScanningAPI#create_aws_scan_options\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_aws_scan_options(account_id, opts = {}) ⇒ Object

Delete AWS Scan Options.

See Also:



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

def delete_aws_scan_options(, opts = {})
  delete_aws_scan_options_with_http_info(, opts)
  nil
end

#delete_aws_scan_options_with_http_info(account_id, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Delete AWS Scan Options.

Delete Agentless scan options for an AWS account.

Parameters:

  • account_id (String) —

    The ID of an AWS account.

  • 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/agentless_scanning_api.rb', line 175

def delete_aws_scan_options_with_http_info(, opts = {})

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AgentlessScanningAPI.delete_aws_scan_options ...'
  end
  # verify the required parameter 'account_id' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'account_id' when calling AgentlessScanningAPI.delete_aws_scan_options"
  end
  # resource path
  local_var_path = '/api/v2/agentless_scanning/accounts/aws/{account_id}'.sub('{account_id}', CGI.escape(.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_aws_scan_options,
    :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: AgentlessScanningAPI#delete_aws_scan_options\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_aws_on_demand_task(task_id, opts = {}) ⇒ Object

Get AWS On Demand task by id.

See Also:



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

def get_aws_on_demand_task(task_id, opts = {})
  data, _status_code, _headers = get_aws_on_demand_task_with_http_info(task_id, opts)
  data
end

#get_aws_on_demand_task_with_http_info(task_id, opts = {}) ⇒ Array<(AwsOnDemandResponse, Integer, Hash)>

Get AWS On Demand task by id.

Fetch the data of a specific on demand task.

Parameters:

  • task_id (String) —

    The UUID of the task.

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

    the optional parameters

Returns:

  • (Array<(AwsOnDemandResponse, Integer, Hash)>) —

    AwsOnDemandResponse data, 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/agentless_scanning_api.rb', line 240

def get_aws_on_demand_task_with_http_info(task_id, opts = {})

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AgentlessScanningAPI.get_aws_on_demand_task ...'
  end
  # verify the required parameter 'task_id' is set
  if @api_client.config.client_side_validation && task_id.nil?
    fail ArgumentError, "Missing the required parameter 'task_id' when calling AgentlessScanningAPI.get_aws_on_demand_task"
  end
  # resource path
  local_var_path = '/api/v2/agentless_scanning/ondemand/aws/{task_id}'.sub('{task_id}', CGI.escape(task_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] || 'AwsOnDemandResponse'

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

  new_options = opts.merge(
    :operation => :get_aws_on_demand_task,
    :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: AgentlessScanningAPI#get_aws_on_demand_task\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#list_aws_on_demand_tasks(opts = {}) ⇒ Object

Get AWS On Demand tasks.

See Also:



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

def list_aws_on_demand_tasks(opts = {})
  data, _status_code, _headers = list_aws_on_demand_tasks_with_http_info(opts)
  data
end

#list_aws_on_demand_tasks_with_http_info(opts = {}) ⇒ Array<(AwsOnDemandListResponse, Integer, Hash)>

Get AWS On Demand tasks.

Fetches the most recent 1000 AWS on demand tasks.

Parameters:

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

    the optional parameters

Returns:

  • (Array<(AwsOnDemandListResponse, Integer, Hash)>) —

    AwsOnDemandListResponse data, response status code and response headers



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

def list_aws_on_demand_tasks_with_http_info(opts = {})

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AgentlessScanningAPI.list_aws_on_demand_tasks ...'
  end
  # resource path
  local_var_path = '/api/v2/agentless_scanning/ondemand/aws'

  # 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] || 'AwsOnDemandListResponse'

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

  new_options = opts.merge(
    :operation => :list_aws_on_demand_tasks,
    :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: AgentlessScanningAPI#list_aws_on_demand_tasks\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#list_aws_scan_options(opts = {}) ⇒ Object

Get AWS Scan Options.

See Also:



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

def list_aws_scan_options(opts = {})
  data, _status_code, _headers = list_aws_scan_options_with_http_info(opts)
  data
end

#list_aws_scan_options_with_http_info(opts = {}) ⇒ Array<(AwsScanOptionsListResponse, Integer, Hash)>

Get AWS Scan Options.

Fetches the scan options configured for AWS accounts.

Parameters:

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

    the optional parameters

Returns:

  • (Array<(AwsScanOptionsListResponse, Integer, Hash)>) —

    AwsScanOptionsListResponse data, response status code and response headers



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

def list_aws_scan_options_with_http_info(opts = {})

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AgentlessScanningAPI.list_aws_scan_options ...'
  end
  # resource path
  local_var_path = '/api/v2/agentless_scanning/accounts/aws'

  # 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] || 'AwsScanOptionsResponse'

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

  new_options = opts.merge(
    :operation => :list_aws_scan_options,
    :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: AgentlessScanningAPI#list_aws_scan_options\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_aws_scan_options(account_id, body, opts = {}) ⇒ Object

Patch AWS Scan Options.

See Also:



413
414
415
416
 
# File 'lib/datadog_api_client/v2/api/agentless_scanning_api.rb', line 413

def update_aws_scan_options(, body, opts = {})
  update_aws_scan_options_with_http_info(, body, opts)
  nil
end

#update_aws_scan_options_with_http_info(account_id, body, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Patch AWS Scan Options.

Update the Agentless scan options for an activated account.

Parameters:

  • account_id (String) —

    The ID of an AWS account.

  • body (AwsScanOptionsUpdateRequest) —

    New definition of the scan options.

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



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

def update_aws_scan_options_with_http_info(, body, opts = {})

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AgentlessScanningAPI.update_aws_scan_options ...'
  end
  # verify the required parameter 'account_id' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'account_id' when calling AgentlessScanningAPI.update_aws_scan_options"
  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 AgentlessScanningAPI.update_aws_scan_options"
  end
  # resource path
  local_var_path = '/api/v2/agentless_scanning/accounts/aws/{account_id}'.sub('{account_id}', CGI.escape(.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(['*/*'])
  # 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]

  new_options = opts.merge(
    :operation => :update_aws_scan_options,
    :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: AgentlessScanningAPI#update_aws_scan_options\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end