Class: DatadogAPIClient::V2::SyntheticsAPI

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

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

Returns a new instance of SyntheticsAPI.



22
23
24
 
# File 'lib/datadog_api_client/v2/api/synthetics_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/synthetics_api.rb', line 20

def api_client
  @api_client
end

Instance Method Details

#abort_test_file_multipart_upload(public_id, body, opts = {}) ⇒ Object

Abort a multipart upload of a test file.

See Also:



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

def abort_test_file_multipart_upload(public_id, body, opts = {})
  abort_test_file_multipart_upload_with_http_info(public_id, body, opts)
  nil
end

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

Abort a multipart upload of a test file.

Abort an in-progress multipart file upload for a Synthetic test. This cancels the upload and releases any storage used by already-uploaded parts.

Parameters:

Returns:

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

    nil, response status code and response headers



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

def abort_test_file_multipart_upload_with_http_info(public_id, body, opts = {})

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SyntheticsAPI.abort_test_file_multipart_upload ...'
  end
  # verify the required parameter 'public_id' is set
  if @api_client.config.client_side_validation && public_id.nil?
    fail ArgumentError, "Missing the required parameter 'public_id' when calling SyntheticsAPI.abort_test_file_multipart_upload"
  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 SyntheticsAPI.abort_test_file_multipart_upload"
  end
  # resource path
  local_var_path = '/api/v2/synthetics/tests/{public_id}/files/multipart-upload-abort'.sub('{public_id}', CGI.escape(public_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(['*/*'])
  # 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]

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

#complete_test_file_multipart_upload(public_id, body, opts = {}) ⇒ Object

Complete a multipart upload of a test file.

See Also:



102
103
104
105
 
# File 'lib/datadog_api_client/v2/api/synthetics_api.rb', line 102

def complete_test_file_multipart_upload(public_id, body, opts = {})
  complete_test_file_multipart_upload_with_http_info(public_id, body, opts)
  nil
end

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

Complete a multipart upload of a test file.

Complete a multipart file upload for a Synthetic test. Call this endpoint after all parts have been uploaded using the presigned URLs obtained from the multipart presigned URLs endpoint.

Parameters:

Returns:

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

    nil, response status code and response headers



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

def complete_test_file_multipart_upload_with_http_info(public_id, body, opts = {})

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SyntheticsAPI.complete_test_file_multipart_upload ...'
  end
  # verify the required parameter 'public_id' is set
  if @api_client.config.client_side_validation && public_id.nil?
    fail ArgumentError, "Missing the required parameter 'public_id' when calling SyntheticsAPI.complete_test_file_multipart_upload"
  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 SyntheticsAPI.complete_test_file_multipart_upload"
  end
  # resource path
  local_var_path = '/api/v2/synthetics/tests/{public_id}/files/multipart-upload-complete'.sub('{public_id}', CGI.escape(public_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(['*/*'])
  # 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]

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

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

Create a Network Path test.

See Also:



175
176
177
178
 
# File 'lib/datadog_api_client/v2/api/synthetics_api.rb', line 175

def create_synthetics_network_test(body, opts = {})
  data, _status_code, _headers = create_synthetics_network_test_with_http_info(body, opts)
  data
end

#create_synthetics_network_test_with_http_info(body, opts = {}) ⇒ Array<(SyntheticsNetworkTestResponse, Integer, Hash)>

Create a Network Path test.

Parameters:

Returns:



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
229
230
231
232
233
234
 
# File 'lib/datadog_api_client/v2/api/synthetics_api.rb', line 184

def create_synthetics_network_test_with_http_info(body, opts = {})

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SyntheticsAPI.create_synthetics_network_test ...'
  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 SyntheticsAPI.create_synthetics_network_test"
  end
  # resource path
  local_var_path = '/api/v2/synthetics/tests/network'

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

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

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

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

Create a test suite.

See Also:



239
240
241
242
 
# File 'lib/datadog_api_client/v2/api/synthetics_api.rb', line 239

def create_synthetics_suite(body, opts = {})
  data, _status_code, _headers = create_synthetics_suite_with_http_info(body, opts)
  data
end

#create_synthetics_suite_with_http_info(body, opts = {}) ⇒ Array<(SyntheticsSuiteResponse, Integer, Hash)>

Create a test suite.

Parameters:

Returns:

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

    SyntheticsSuiteResponse data, response status code and response headers



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
289
290
291
292
293
294
295
296
297
298
 
# File 'lib/datadog_api_client/v2/api/synthetics_api.rb', line 248

def create_synthetics_suite_with_http_info(body, opts = {})

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SyntheticsAPI.create_synthetics_suite ...'
  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 SyntheticsAPI.create_synthetics_suite"
  end
  # resource path
  local_var_path = '/api/v2/synthetics/suites'

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

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

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

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

Bulk delete suites.

See Also:



303
304
305
306
 
# File 'lib/datadog_api_client/v2/api/synthetics_api.rb', line 303

def delete_synthetics_suites(body, opts = {})
  data, _status_code, _headers = delete_synthetics_suites_with_http_info(body, opts)
  data
end

#delete_synthetics_suites_with_http_info(body, opts = {}) ⇒ Array<(DeletedSuitesResponse, Integer, Hash)>

Bulk delete suites.

Parameters:

Returns:

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

    DeletedSuitesResponse data, response status code and response headers



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
351
352
353
354
355
356
357
358
359
360
361
362
 
# File 'lib/datadog_api_client/v2/api/synthetics_api.rb', line 312

def delete_synthetics_suites_with_http_info(body, opts = {})

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SyntheticsAPI.delete_synthetics_suites ...'
  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 SyntheticsAPI.delete_synthetics_suites"
  end
  # resource path
  local_var_path = '/api/v2/synthetics/suites/bulk-delete'

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

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

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

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

Bulk delete tests.

See Also:



367
368
369
370
 
# File 'lib/datadog_api_client/v2/api/synthetics_api.rb', line 367

def delete_synthetics_tests(body, opts = {})
  data, _status_code, _headers = delete_synthetics_tests_with_http_info(body, opts)
  data
end

#delete_synthetics_tests_with_http_info(body, opts = {}) ⇒ Array<(DeletedTestsResponse, Integer, Hash)>

Bulk delete tests.

Parameters:

Returns:

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

    DeletedTestsResponse data, response status code and response headers



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
424
425
426
 
# File 'lib/datadog_api_client/v2/api/synthetics_api.rb', line 376

def delete_synthetics_tests_with_http_info(body, opts = {})

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SyntheticsAPI.delete_synthetics_tests ...'
  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 SyntheticsAPI.delete_synthetics_tests"
  end
  # resource path
  local_var_path = '/api/v2/synthetics/tests/bulk-delete'

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

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

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

#edit_synthetics_suite(public_id, body, opts = {}) ⇒ Object

Edit a test suite.

See Also:



431
432
433
434
 
# File 'lib/datadog_api_client/v2/api/synthetics_api.rb', line 431

def edit_synthetics_suite(public_id, body, opts = {})
  data, _status_code, _headers = edit_synthetics_suite_with_http_info(public_id, body, opts)
  data
end

#edit_synthetics_suite_with_http_info(public_id, body, opts = {}) ⇒ Array<(SyntheticsSuiteResponse, Integer, Hash)>

Edit a test suite.

Parameters:

  • public_id (String) —

    The public ID of the suite to edit.

  • body (SuiteCreateEditRequest) —

    New suite details to be saved.

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

    the optional parameters

Returns:

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

    SyntheticsSuiteResponse data, response status code and response headers



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/synthetics_api.rb', line 441

def edit_synthetics_suite_with_http_info(public_id, body, opts = {})

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SyntheticsAPI.edit_synthetics_suite ...'
  end
  # verify the required parameter 'public_id' is set
  if @api_client.config.client_side_validation && public_id.nil?
    fail ArgumentError, "Missing the required parameter 'public_id' when calling SyntheticsAPI.edit_synthetics_suite"
  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 SyntheticsAPI.edit_synthetics_suite"
  end
  # resource path
  local_var_path = '/api/v2/synthetics/suites/{public_id}'.sub('{public_id}', CGI.escape(public_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] || 'SyntheticsSuiteResponse'

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

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

#get_api_multistep_subtest_parents(public_id, opts = {}) ⇒ Object

Get parent tests for a subtest.

See Also:



500
501
502
503
 
# File 'lib/datadog_api_client/v2/api/synthetics_api.rb', line 500

def get_api_multistep_subtest_parents(public_id, opts = {})
  data, _status_code, _headers = get_api_multistep_subtest_parents_with_http_info(public_id, opts)
  data
end

#get_api_multistep_subtest_parents_with_http_info(public_id, opts = {}) ⇒ Array<(SyntheticsApiMultistepParentTestsResponse, Integer, Hash)>

Get parent tests for a subtest.

Get the list of API multistep tests that include a given subtest, along with their monitor status.

Parameters:

  • public_id (String) —

    The public ID of the subtest.

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

    the optional parameters

Returns:



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

def get_api_multistep_subtest_parents_with_http_info(public_id, opts = {})

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SyntheticsAPI.get_api_multistep_subtest_parents ...'
  end
  # verify the required parameter 'public_id' is set
  if @api_client.config.client_side_validation && public_id.nil?
    fail ArgumentError, "Missing the required parameter 'public_id' when calling SyntheticsAPI.get_api_multistep_subtest_parents"
  end
  # resource path
  local_var_path = '/api/v2/synthetics/api-multistep/subtests/{public_id}/parents'.sub('{public_id}', CGI.escape(public_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] || 'SyntheticsApiMultistepParentTestsResponse'

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

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

#get_api_multistep_subtests(public_id, opts = {}) ⇒ Object

Get available subtests for a multistep test.

See Also:



566
567
568
569
 
# File 'lib/datadog_api_client/v2/api/synthetics_api.rb', line 566

def get_api_multistep_subtests(public_id, opts = {})
  data, _status_code, _headers = get_api_multistep_subtests_with_http_info(public_id, opts)
  data
end

#get_api_multistep_subtests_with_http_info(public_id, opts = {}) ⇒ Array<(SyntheticsApiMultistepSubtestsResponse, Integer, Hash)>

Get available subtests for a multistep test.

Get the list of API tests that can be added as subtests to a given API multistep test. The current test is excluded from the list since a test cannot be a subtest of itself.

Parameters:

  • public_id (String) —

    The public ID of the API multistep test.

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

    the optional parameters

Returns:



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
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
 
# File 'lib/datadog_api_client/v2/api/synthetics_api.rb', line 579

def get_api_multistep_subtests_with_http_info(public_id, opts = {})

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SyntheticsAPI.get_api_multistep_subtests ...'
  end
  # verify the required parameter 'public_id' is set
  if @api_client.config.client_side_validation && public_id.nil?
    fail ArgumentError, "Missing the required parameter 'public_id' when calling SyntheticsAPI.get_api_multistep_subtests"
  end
  # resource path
  local_var_path = '/api/v2/synthetics/api-multistep/subtests/{public_id}'.sub('{public_id}', CGI.escape(public_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] || 'SyntheticsApiMultistepSubtestsResponse'

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

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

#get_on_demand_concurrency_cap(opts = {}) ⇒ Object

Get the on-demand concurrency cap.

See Also:



632
633
634
635
 
# File 'lib/datadog_api_client/v2/api/synthetics_api.rb', line 632

def get_on_demand_concurrency_cap(opts = {})
  data, _status_code, _headers = get_on_demand_concurrency_cap_with_http_info(opts)
  data
end

#get_on_demand_concurrency_cap_with_http_info(opts = {}) ⇒ Array<(OnDemandConcurrencyCapResponse, Integer, Hash)>

Get the on-demand concurrency cap.

Get the on-demand concurrency cap.

Parameters:

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

    the optional parameters

Returns:



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

def get_on_demand_concurrency_cap_with_http_info(opts = {})

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SyntheticsAPI.get_on_demand_concurrency_cap ...'
  end
  # resource path
  local_var_path = '/api/v2/synthetics/settings/on_demand_concurrency_cap'

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

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

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

#get_synthetics_browser_test_result(public_id, result_id, opts = {}) ⇒ Object

Get a browser test result.

See Also:



692
693
694
695
 
# File 'lib/datadog_api_client/v2/api/synthetics_api.rb', line 692

def get_synthetics_browser_test_result(public_id, result_id, opts = {})
  data, _status_code, _headers = get_synthetics_browser_test_result_with_http_info(public_id, result_id, opts)
  data
end

#get_synthetics_browser_test_result_with_http_info(public_id, result_id, opts = {}) ⇒ Array<(SyntheticsTestResultResponse, Integer, Hash)>

Get a browser test result.

Get a specific full result from a given Synthetic browser test.

Parameters:

  • public_id (String) —

    The public ID of the Synthetic browser test to which the target result belongs.

  • result_id (String) —

    The ID of the result to get.

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

    the optional parameters

Options Hash (opts):

  • :event_id (String) —

    The event ID used to look up the result in the event store.

  • :timestamp (Integer) —

    Timestamp in seconds to look up the result.

Returns:



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

def get_synthetics_browser_test_result_with_http_info(public_id, result_id, opts = {})

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SyntheticsAPI.get_synthetics_browser_test_result ...'
  end
  # verify the required parameter 'public_id' is set
  if @api_client.config.client_side_validation && public_id.nil?
    fail ArgumentError, "Missing the required parameter 'public_id' when calling SyntheticsAPI.get_synthetics_browser_test_result"
  end
  # verify the required parameter 'result_id' is set
  if @api_client.config.client_side_validation && result_id.nil?
    fail ArgumentError, "Missing the required parameter 'result_id' when calling SyntheticsAPI.get_synthetics_browser_test_result"
  end
  # resource path
  local_var_path = '/api/v2/synthetics/tests/browser/{public_id}/results/{result_id}'.sub('{public_id}', CGI.escape(public_id.to_s).gsub('%2F', '/')).sub('{result_id}', CGI.escape(result_id.to_s).gsub('%2F', '/'))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'event_id'] = opts[:'event_id'] if !opts[:'event_id'].nil?
  query_params[:'timestamp'] = opts[:'timestamp'] if !opts[:'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] || 'SyntheticsTestResultResponse'

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

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

#get_synthetics_fast_test_result(id, opts = {}) ⇒ Object

Get a fast test result.

See Also:



766
767
768
769
 
# File 'lib/datadog_api_client/v2/api/synthetics_api.rb', line 766

def get_synthetics_fast_test_result(id, opts = {})
  data, _status_code, _headers = get_synthetics_fast_test_result_with_http_info(id, opts)
  data
end

#get_synthetics_fast_test_result_with_http_info(id, opts = {}) ⇒ Array<(SyntheticsFastTestResult, Integer, Hash)>

Get a fast test result.

Parameters:

  • id (String) —

    The UUID of the fast test to retrieve the result for.

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

    the optional parameters

Returns:

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

    SyntheticsFastTestResult data, response status code and response headers



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
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
 
# File 'lib/datadog_api_client/v2/api/synthetics_api.rb', line 775

def get_synthetics_fast_test_result_with_http_info(id, opts = {})

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SyntheticsAPI.get_synthetics_fast_test_result ...'
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling SyntheticsAPI.get_synthetics_fast_test_result"
  end
  # resource path
  local_var_path = '/api/v2/synthetics/tests/fast/{id}'.sub('{id}', CGI.escape(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] || 'SyntheticsFastTestResult'

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

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

#get_synthetics_network_test(public_id, opts = {}) ⇒ Object

Get a Network Path test.

See Also:



828
829
830
831
 
# File 'lib/datadog_api_client/v2/api/synthetics_api.rb', line 828

def get_synthetics_network_test(public_id, opts = {})
  data, _status_code, _headers = get_synthetics_network_test_with_http_info(public_id, opts)
  data
end

#get_synthetics_network_test_with_http_info(public_id, opts = {}) ⇒ Array<(SyntheticsNetworkTestResponse, Integer, Hash)>

Get a Network Path test.

Parameters:

  • public_id (String) —

    The public ID of the Network Path test to get details from.

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

    the optional parameters

Returns:



837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
 
# File 'lib/datadog_api_client/v2/api/synthetics_api.rb', line 837

def get_synthetics_network_test_with_http_info(public_id, opts = {})

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SyntheticsAPI.get_synthetics_network_test ...'
  end
  # verify the required parameter 'public_id' is set
  if @api_client.config.client_side_validation && public_id.nil?
    fail ArgumentError, "Missing the required parameter 'public_id' when calling SyntheticsAPI.get_synthetics_network_test"
  end
  # resource path
  local_var_path = '/api/v2/synthetics/tests/network/{public_id}'.sub('{public_id}', CGI.escape(public_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] || 'SyntheticsNetworkTestResponse'

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

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

#get_synthetics_suite(public_id, opts = {}) ⇒ Object

Get a suite.

See Also:



890
891
892
893
 
# File 'lib/datadog_api_client/v2/api/synthetics_api.rb', line 890

def get_synthetics_suite(public_id, opts = {})
  data, _status_code, _headers = get_synthetics_suite_with_http_info(public_id, opts)
  data
end

#get_synthetics_suite_with_http_info(public_id, opts = {}) ⇒ Array<(SyntheticsSuiteResponse, Integer, Hash)>

Get a suite.

Parameters:

  • public_id (String) —

    The public ID of the suite to get details from.

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

    the optional parameters

Returns:

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

    SyntheticsSuiteResponse data, response status code and response headers



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
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
 
# File 'lib/datadog_api_client/v2/api/synthetics_api.rb', line 899

def get_synthetics_suite_with_http_info(public_id, opts = {})

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SyntheticsAPI.get_synthetics_suite ...'
  end
  # verify the required parameter 'public_id' is set
  if @api_client.config.client_side_validation && public_id.nil?
    fail ArgumentError, "Missing the required parameter 'public_id' when calling SyntheticsAPI.get_synthetics_suite"
  end
  # resource path
  local_var_path = '/api/v2/synthetics/suites/{public_id}'.sub('{public_id}', CGI.escape(public_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] || 'SyntheticsSuiteResponse'

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

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

#get_synthetics_test_result(public_id, result_id, opts = {}) ⇒ Object

Get a test result.

See Also:



952
953
954
955
 
# File 'lib/datadog_api_client/v2/api/synthetics_api.rb', line 952

def get_synthetics_test_result(public_id, result_id, opts = {})
  data, _status_code, _headers = get_synthetics_test_result_with_http_info(public_id, result_id, opts)
  data
end

#get_synthetics_test_result_with_http_info(public_id, result_id, opts = {}) ⇒ Array<(SyntheticsTestResultResponse, Integer, Hash)>

Get a test result.

Get a specific full result from a given Synthetic test.

Parameters:

  • public_id (String) —

    The public ID of the Synthetic test to which the target result belongs.

  • result_id (String) —

    The ID of the result to get.

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

    the optional parameters

Options Hash (opts):

  • :event_id (String) —

    The event ID used to look up the result in the event store.

  • :timestamp (Integer) —

    Timestamp in seconds to look up the result.

Returns:



967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
 
# File 'lib/datadog_api_client/v2/api/synthetics_api.rb', line 967

def get_synthetics_test_result_with_http_info(public_id, result_id, opts = {})

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SyntheticsAPI.get_synthetics_test_result ...'
  end
  # verify the required parameter 'public_id' is set
  if @api_client.config.client_side_validation && public_id.nil?
    fail ArgumentError, "Missing the required parameter 'public_id' when calling SyntheticsAPI.get_synthetics_test_result"
  end
  # verify the required parameter 'result_id' is set
  if @api_client.config.client_side_validation && result_id.nil?
    fail ArgumentError, "Missing the required parameter 'result_id' when calling SyntheticsAPI.get_synthetics_test_result"
  end
  # resource path
  local_var_path = '/api/v2/synthetics/tests/{public_id}/results/{result_id}'.sub('{public_id}', CGI.escape(public_id.to_s).gsub('%2F', '/')).sub('{result_id}', CGI.escape(result_id.to_s).gsub('%2F', '/'))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'event_id'] = opts[:'event_id'] if !opts[:'event_id'].nil?
  query_params[:'timestamp'] = opts[:'timestamp'] if !opts[:'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] || 'SyntheticsTestResultResponse'

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

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

#get_synthetics_test_version(public_id, version_number, opts = {}) ⇒ Object

Get a specific version of a test.

See Also:



1026
1027
1028
1029
 
# File 'lib/datadog_api_client/v2/api/synthetics_api.rb', line 1026

def get_synthetics_test_version(public_id, version_number, opts = {})
  data, _status_code, _headers = get_synthetics_test_version_with_http_info(public_id, version_number, opts)
  data
end

#get_synthetics_test_version_with_http_info(public_id, version_number, opts = {}) ⇒ Array<(SyntheticsTestVersionResponse, Integer, Hash)>

Get a specific version of a test.

Get a specific version of a Synthetic test by its version number.

Parameters:

  • public_id (String) —

    The public ID of the Synthetic test.

  • version_number (Integer) —

    The version number to retrieve.

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

    the optional parameters

Options Hash (opts):

  • :include_change_metadata (Boolean) —

    If ‘true`, include change metadata in the response.

  • :only_check_existence (Boolean) —

    If ‘true`, only check whether the version exists without returning its full payload. Returns an empty object if the version exists, or 404 if not.

Returns:



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

def get_synthetics_test_version_with_http_info(public_id, version_number, opts = {})

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SyntheticsAPI.get_synthetics_test_version ...'
  end
  # verify the required parameter 'public_id' is set
  if @api_client.config.client_side_validation && public_id.nil?
    fail ArgumentError, "Missing the required parameter 'public_id' when calling SyntheticsAPI.get_synthetics_test_version"
  end
  # verify the required parameter 'version_number' is set
  if @api_client.config.client_side_validation && version_number.nil?
    fail ArgumentError, "Missing the required parameter 'version_number' when calling SyntheticsAPI.get_synthetics_test_version"
  end
  # resource path
  local_var_path = '/api/v2/synthetics/tests/{public_id}/version_history/{version_number}'.sub('{public_id}', CGI.escape(public_id.to_s).gsub('%2F', '/')).sub('{version_number}', CGI.escape(version_number.to_s).gsub('%2F', '/'))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'include_change_metadata'] = opts[:'include_change_metadata'] if !opts[:'include_change_metadata'].nil?
  query_params[:'only_check_existence'] = opts[:'only_check_existence'] if !opts[:'only_check_existence'].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] || 'SyntheticsTestVersionResponse'

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

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

#get_test_file_download_url(public_id, body, opts = {}) ⇒ Object

Get a presigned URL for downloading a test file.

See Also:



1100
1101
1102
1103
 
# File 'lib/datadog_api_client/v2/api/synthetics_api.rb', line 1100

def get_test_file_download_url(public_id, body, opts = {})
  data, _status_code, _headers = get_test_file_download_url_with_http_info(public_id, body, opts)
  data
end

#get_test_file_download_url_with_http_info(public_id, body, opts = {}) ⇒ Array<(SyntheticsTestFileDownloadResponse, Integer, Hash)>

Get a presigned URL for downloading a test file.

Get a presigned URL to download a file attached to a Synthetic test. The returned URL is temporary and expires after a short period.

Parameters:

Returns:



1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
 
# File 'lib/datadog_api_client/v2/api/synthetics_api.rb', line 1114

def get_test_file_download_url_with_http_info(public_id, body, opts = {})

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SyntheticsAPI.get_test_file_download_url ...'
  end
  # verify the required parameter 'public_id' is set
  if @api_client.config.client_side_validation && public_id.nil?
    fail ArgumentError, "Missing the required parameter 'public_id' when calling SyntheticsAPI.get_test_file_download_url"
  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 SyntheticsAPI.get_test_file_download_url"
  end
  # resource path
  local_var_path = '/api/v2/synthetics/tests/{public_id}/files/download'.sub('{public_id}', CGI.escape(public_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] || 'SyntheticsTestFileDownloadResponse'

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

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

#get_test_file_multipart_presigned_urls(public_id, body, opts = {}) ⇒ Object

Get presigned URLs for uploading a test file.

See Also:



1173
1174
1175
1176
 
# File 'lib/datadog_api_client/v2/api/synthetics_api.rb', line 1173

def get_test_file_multipart_presigned_urls(public_id, body, opts = {})
  data, _status_code, _headers = get_test_file_multipart_presigned_urls_with_http_info(public_id, body, opts)
  data
end

#get_test_file_multipart_presigned_urls_with_http_info(public_id, body, opts = {}) ⇒ Array<(SyntheticsTestFileMultipartPresignedUrlsResponse, Integer, Hash)>

Get presigned URLs for uploading a test file.

Get presigned URLs for uploading a file to a Synthetic test using multipart upload. Returns the presigned URLs for each part along with the bucket key that references the file.

Parameters:

Returns:



1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
 
# File 'lib/datadog_api_client/v2/api/synthetics_api.rb', line 1187

def get_test_file_multipart_presigned_urls_with_http_info(public_id, body, opts = {})

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SyntheticsAPI.get_test_file_multipart_presigned_urls ...'
  end
  # verify the required parameter 'public_id' is set
  if @api_client.config.client_side_validation && public_id.nil?
    fail ArgumentError, "Missing the required parameter 'public_id' when calling SyntheticsAPI.get_test_file_multipart_presigned_urls"
  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 SyntheticsAPI.get_test_file_multipart_presigned_urls"
  end
  # resource path
  local_var_path = '/api/v2/synthetics/tests/{public_id}/files/multipart-presigned-urls'.sub('{public_id}', CGI.escape(public_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] || 'SyntheticsTestFileMultipartPresignedUrlsResponse'

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

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

#get_test_parent_suites(public_id, opts = {}) ⇒ Object

Get parent suites for a test.

See Also:



1246
1247
1248
1249
 
# File 'lib/datadog_api_client/v2/api/synthetics_api.rb', line 1246

def get_test_parent_suites(public_id, opts = {})
  data, _status_code, _headers = get_test_parent_suites_with_http_info(public_id, opts)
  data
end

#get_test_parent_suites_with_http_info(public_id, opts = {}) ⇒ Array<(SyntheticsTestParentSuitesResponse, Integer, Hash)>

Get parent suites for a test.

Get the list of parent suites and their status for a given Synthetic test.

Parameters:

  • public_id (String) —

    The public ID of the Synthetic test.

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

    the optional parameters

Returns:



1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
 
# File 'lib/datadog_api_client/v2/api/synthetics_api.rb', line 1258

def get_test_parent_suites_with_http_info(public_id, opts = {})

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SyntheticsAPI.get_test_parent_suites ...'
  end
  # verify the required parameter 'public_id' is set
  if @api_client.config.client_side_validation && public_id.nil?
    fail ArgumentError, "Missing the required parameter 'public_id' when calling SyntheticsAPI.get_test_parent_suites"
  end
  # resource path
  local_var_path = '/api/v2/synthetics/tests/{public_id}/parent-suites'.sub('{public_id}', CGI.escape(public_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] || 'SyntheticsTestParentSuitesResponse'

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

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

#list_synthetics_browser_test_latest_results(public_id, opts = {}) ⇒ Object

Get a browser test’s latest results.

See Also:



1311
1312
1313
1314
 
# File 'lib/datadog_api_client/v2/api/synthetics_api.rb', line 1311

def list_synthetics_browser_test_latest_results(public_id, opts = {})
  data, _status_code, _headers = list_synthetics_browser_test_latest_results_with_http_info(public_id, opts)
  data
end

#list_synthetics_browser_test_latest_results_with_http_info(public_id, opts = {}) ⇒ Array<(SyntheticsTestLatestResultsResponse, Integer, Hash)>

Get a browser test’s latest results.

Get the latest result summaries for a given Synthetic browser test.

Parameters:

  • public_id (String) —

    The public ID of the Synthetic browser test for which to search results.

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

    the optional parameters

Options Hash (opts):

  • :from_ts (Integer) —

    Timestamp in milliseconds from which to start querying results.

  • :to_ts (Integer) —

    Timestamp in milliseconds up to which to query results.

  • :status (SyntheticsTestResultStatus) —

    Filter results by status.

  • :run_type (SyntheticsTestResultRunType) —

    Filter results by run type.

  • :probe_dc (Array<String>) —

    Locations for which to query results.

  • :device_id (Array<String>) —

    Device IDs for which to query results.

Returns:



1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
 
# File 'lib/datadog_api_client/v2/api/synthetics_api.rb', line 1329

def list_synthetics_browser_test_latest_results_with_http_info(public_id, opts = {})

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SyntheticsAPI.list_synthetics_browser_test_latest_results ...'
  end
  # verify the required parameter 'public_id' is set
  if @api_client.config.client_side_validation && public_id.nil?
    fail ArgumentError, "Missing the required parameter 'public_id' when calling SyntheticsAPI.list_synthetics_browser_test_latest_results"
  end
  allowable_values = ['passed', 'failed', 'no_data']
  if @api_client.config.client_side_validation && opts[:'status'] && !allowable_values.include?(opts[:'status'])
    fail ArgumentError, "invalid value for \"status\", must be one of #{allowable_values}"
  end
  allowable_values = ['scheduled', 'fast', 'ci', 'triggered']
  if @api_client.config.client_side_validation && opts[:'run_type'] && !allowable_values.include?(opts[:'run_type'])
    fail ArgumentError, "invalid value for \"run_type\", must be one of #{allowable_values}"
  end
  # resource path
  local_var_path = '/api/v2/synthetics/tests/browser/{public_id}/results'.sub('{public_id}', CGI.escape(public_id.to_s).gsub('%2F', '/'))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'from_ts'] = opts[:'from_ts'] if !opts[:'from_ts'].nil?
  query_params[:'to_ts'] = opts[:'to_ts'] if !opts[:'to_ts'].nil?
  query_params[:'status'] = opts[:'status'] if !opts[:'status'].nil?
  query_params[:'runType'] = opts[:'run_type'] if !opts[:'run_type'].nil?
  query_params[:'probe_dc'] = @api_client.build_collection_param(opts[:'probe_dc'], :multi) if !opts[:'probe_dc'].nil?
  query_params[:'device_id'] = @api_client.build_collection_param(opts[:'device_id'], :multi) if !opts[:'device_id'].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] || 'SyntheticsTestLatestResultsResponse'

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

  new_options = opts.merge(
    :operation => :list_synthetics_browser_test_latest_results,
    :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"
  )
  new_options[:query_string_normalizer] = HTTParty::Request::NON_RAILS_QUERY_STRING_NORMALIZER

  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: SyntheticsAPI#list_synthetics_browser_test_latest_results\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#list_synthetics_test_latest_results(public_id, opts = {}) ⇒ Object

Get a test’s latest results.

See Also:



1397
1398
1399
1400
 
# File 'lib/datadog_api_client/v2/api/synthetics_api.rb', line 1397

def list_synthetics_test_latest_results(public_id, opts = {})
  data, _status_code, _headers = list_synthetics_test_latest_results_with_http_info(public_id, opts)
  data
end

#list_synthetics_test_latest_results_with_http_info(public_id, opts = {}) ⇒ Array<(SyntheticsTestLatestResultsResponse, Integer, Hash)>

Get a test’s latest results.

Get the latest result summaries for a given Synthetic test.

Parameters:

  • public_id (String) —

    The public ID of the Synthetic test for which to search results.

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

    the optional parameters

Options Hash (opts):

  • :from_ts (Integer) —

    Timestamp in milliseconds from which to start querying results.

  • :to_ts (Integer) —

    Timestamp in milliseconds up to which to query results.

  • :status (SyntheticsTestResultStatus) —

    Filter results by status.

  • :run_type (SyntheticsTestResultRunType) —

    Filter results by run type.

  • :probe_dc (Array<String>) —

    Locations for which to query results.

  • :device_id (Array<String>) —

    Device IDs for which to query results.

Returns:



1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
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
 
# File 'lib/datadog_api_client/v2/api/synthetics_api.rb', line 1415

def list_synthetics_test_latest_results_with_http_info(public_id, opts = {})

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SyntheticsAPI.list_synthetics_test_latest_results ...'
  end
  # verify the required parameter 'public_id' is set
  if @api_client.config.client_side_validation && public_id.nil?
    fail ArgumentError, "Missing the required parameter 'public_id' when calling SyntheticsAPI.list_synthetics_test_latest_results"
  end
  allowable_values = ['passed', 'failed', 'no_data']
  if @api_client.config.client_side_validation && opts[:'status'] && !allowable_values.include?(opts[:'status'])
    fail ArgumentError, "invalid value for \"status\", must be one of #{allowable_values}"
  end
  allowable_values = ['scheduled', 'fast', 'ci', 'triggered']
  if @api_client.config.client_side_validation && opts[:'run_type'] && !allowable_values.include?(opts[:'run_type'])
    fail ArgumentError, "invalid value for \"run_type\", must be one of #{allowable_values}"
  end
  # resource path
  local_var_path = '/api/v2/synthetics/tests/{public_id}/results'.sub('{public_id}', CGI.escape(public_id.to_s).gsub('%2F', '/'))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'from_ts'] = opts[:'from_ts'] if !opts[:'from_ts'].nil?
  query_params[:'to_ts'] = opts[:'to_ts'] if !opts[:'to_ts'].nil?
  query_params[:'status'] = opts[:'status'] if !opts[:'status'].nil?
  query_params[:'runType'] = opts[:'run_type'] if !opts[:'run_type'].nil?
  query_params[:'probe_dc'] = @api_client.build_collection_param(opts[:'probe_dc'], :multi) if !opts[:'probe_dc'].nil?
  query_params[:'device_id'] = @api_client.build_collection_param(opts[:'device_id'], :multi) if !opts[:'device_id'].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] || 'SyntheticsTestLatestResultsResponse'

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

  new_options = opts.merge(
    :operation => :list_synthetics_test_latest_results,
    :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"
  )
  new_options[:query_string_normalizer] = HTTParty::Request::NON_RAILS_QUERY_STRING_NORMALIZER

  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: SyntheticsAPI#list_synthetics_test_latest_results\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#list_synthetics_test_versions(public_id, opts = {}) ⇒ Object

Get version history of a test.

See Also:



1483
1484
1485
1486
 
# File 'lib/datadog_api_client/v2/api/synthetics_api.rb', line 1483

def list_synthetics_test_versions(public_id, opts = {})
  data, _status_code, _headers = list_synthetics_test_versions_with_http_info(public_id, opts)
  data
end

#list_synthetics_test_versions_with_http_info(public_id, opts = {}) ⇒ Array<(SyntheticsTestVersionHistoryResponse, Integer, Hash)>

Get version history of a test.

Get the paginated version history for a Synthetic test.

Parameters:

  • public_id (String) —

    The public ID of the Synthetic test.

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

    the optional parameters

Options Hash (opts):

  • :last_version_number (Integer) —

    The version number of the last item from the previous page. Omit to get the first page.

  • :limit (Integer) —

    Maximum number of version records to return per page.

Returns:



1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
 
# File 'lib/datadog_api_client/v2/api/synthetics_api.rb', line 1497

def list_synthetics_test_versions_with_http_info(public_id, opts = {})

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SyntheticsAPI.list_synthetics_test_versions ...'
  end
  # verify the required parameter 'public_id' is set
  if @api_client.config.client_side_validation && public_id.nil?
    fail ArgumentError, "Missing the required parameter 'public_id' when calling SyntheticsAPI.list_synthetics_test_versions"
  end
  if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] > 50
    fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling SyntheticsAPI.list_synthetics_test_versions, must be smaller than or equal to 50.'
  end
  # resource path
  local_var_path = '/api/v2/synthetics/tests/{public_id}/version_history'.sub('{public_id}', CGI.escape(public_id.to_s).gsub('%2F', '/'))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'last_version_number'] = opts[:'last_version_number'] if !opts[:'last_version_number'].nil?
  query_params[:'limit'] = opts[:'limit'] if !opts[:'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] || 'SyntheticsTestVersionHistoryResponse'

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

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

#patch_global_variable(variable_id, body, opts = {}) ⇒ Object

Patch a global variable.

See Also:



1555
1556
1557
1558
 
# File 'lib/datadog_api_client/v2/api/synthetics_api.rb', line 1555

def patch_global_variable(variable_id, body, opts = {})
  data, _status_code, _headers = patch_global_variable_with_http_info(variable_id, body, opts)
  data
end

#patch_global_variable_with_http_info(variable_id, body, opts = {}) ⇒ Array<(GlobalVariableResponse, Integer, Hash)>

Patch a global variable.

Patch a global variable using JSON Patch (RFC 6902). This endpoint allows partial updates to a global variable by specifying only the fields to modify.

Common operations include:

  • Replace field values: ‘“replace”, “path”: “/name”, “value”: “new_name”`

  • Update nested values: ‘“replace”, “path”: “/value/value”, “value”: “new_value”`

  • Add/update tags: ‘“add”, “path”: “/tags/-”, “value”: “new_tag”`

  • Remove fields: ‘“remove”, “path”: “/description”`

Parameters:

  • variable_id (String) —

    The ID of the global variable.

  • body (GlobalVariableJsonPatchRequest) —

    JSON Patch document with operations to apply.

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

    the optional parameters

Returns:

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

    GlobalVariableResponse data, response status code and response headers



1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
 
# File 'lib/datadog_api_client/v2/api/synthetics_api.rb', line 1575

def patch_global_variable_with_http_info(variable_id, body, opts = {})

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SyntheticsAPI.patch_global_variable ...'
  end
  # verify the required parameter 'variable_id' is set
  if @api_client.config.client_side_validation && variable_id.nil?
    fail ArgumentError, "Missing the required parameter 'variable_id' when calling SyntheticsAPI.patch_global_variable"
  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 SyntheticsAPI.patch_global_variable"
  end
  # resource path
  local_var_path = '/api/v2/synthetics/variables/{variable_id}/jsonpatch'.sub('{variable_id}', CGI.escape(variable_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] || 'GlobalVariableResponse'

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

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

#patch_test_suite(public_id, body, opts = {}) ⇒ Object

Patch a test suite.

See Also:



1634
1635
1636
1637
 
# File 'lib/datadog_api_client/v2/api/synthetics_api.rb', line 1634

def patch_test_suite(public_id, body, opts = {})
  data, _status_code, _headers = patch_test_suite_with_http_info(public_id, body, opts)
  data
end

#patch_test_suite_with_http_info(public_id, body, opts = {}) ⇒ Array<(SyntheticsSuiteResponse, Integer, Hash)>

Patch a test suite.

Patch a Synthetic test suite using JSON Patch (RFC 6902). Use partial updates to modify only specific fields of a test suite.

Common operations include:

  • Replace field values: ‘“replace”, “path”: “/name”, “value”: “new_name”`

  • Add/update tags: ‘“add”, “path”: “/tags/-”, “value”: “new_tag”`

  • Remove fields: ‘“remove”, “path”: “/message”`

Parameters:

  • public_id (String) —

    The public ID of the Synthetic test suite to patch.

  • body (SuiteJsonPatchRequest) —

    JSON Patch document with operations to apply.

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

    the optional parameters

Returns:

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

    SyntheticsSuiteResponse data, response status code and response headers



1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
 
# File 'lib/datadog_api_client/v2/api/synthetics_api.rb', line 1653

def patch_test_suite_with_http_info(public_id, body, opts = {})

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SyntheticsAPI.patch_test_suite ...'
  end
  # verify the required parameter 'public_id' is set
  if @api_client.config.client_side_validation && public_id.nil?
    fail ArgumentError, "Missing the required parameter 'public_id' when calling SyntheticsAPI.patch_test_suite"
  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 SyntheticsAPI.patch_test_suite"
  end
  # resource path
  local_var_path = '/api/v2/synthetics/suites/{public_id}/jsonpatch'.sub('{public_id}', CGI.escape(public_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] || 'SyntheticsSuiteResponse'

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

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

#poll_synthetics_test_results(result_ids, opts = {}) ⇒ Object

Poll for test results.

See Also:



1712
1713
1714
1715
 
# File 'lib/datadog_api_client/v2/api/synthetics_api.rb', line 1712

def poll_synthetics_test_results(result_ids, opts = {})
  data, _status_code, _headers = poll_synthetics_test_results_with_http_info(result_ids, opts)
  data
end

#poll_synthetics_test_results_with_http_info(result_ids, opts = {}) ⇒ Array<(SyntheticsPollTestResultsResponse, Integer, Hash)>

Poll for test results.

Poll for test results given a list of result IDs. This is typically used after triggering tests with CI/CD to retrieve results once they are available.

Parameters:

  • result_ids (String) —

    A JSON-encoded array of result IDs to poll for.

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

    the optional parameters

Returns:



1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
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
 
# File 'lib/datadog_api_client/v2/api/synthetics_api.rb', line 1725

def poll_synthetics_test_results_with_http_info(result_ids, opts = {})

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SyntheticsAPI.poll_synthetics_test_results ...'
  end
  # verify the required parameter 'result_ids' is set
  if @api_client.config.client_side_validation && result_ids.nil?
    fail ArgumentError, "Missing the required parameter 'result_ids' when calling SyntheticsAPI.poll_synthetics_test_results"
  end
  # resource path
  local_var_path = '/api/v2/synthetics/tests/poll_results'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'result_ids'] = result_ids

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

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

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

#search_suites(opts = {}) ⇒ Object

Search test suites.

See Also:



1779
1780
1781
1782
 
# File 'lib/datadog_api_client/v2/api/synthetics_api.rb', line 1779

def search_suites(opts = {})
  data, _status_code, _headers = search_suites_with_http_info(opts)
  data
end

#search_suites_with_http_info(opts = {}) ⇒ Array<(SyntheticsSuiteSearchResponse, Integer, Hash)>

Search test suites.

Search for test suites.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :query (String) —

    The search query.

  • :sort (String) —

    The sort order for the results (e.g., ‘name,asc` or `name,desc`).

  • :facets_only (Boolean) —

    If true, return only facets instead of full test details.

  • :start (Integer) —

    The offset from which to start returning results.

  • :count (Integer) —

    The maximum number of results to return.

Returns:



1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
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
 
# File 'lib/datadog_api_client/v2/api/synthetics_api.rb', line 1795

def search_suites_with_http_info(opts = {})

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SyntheticsAPI.search_suites ...'
  end
  # resource path
  local_var_path = '/api/v2/synthetics/suites/search'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'query'] = opts[:'query'] if !opts[:'query'].nil?
  query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
  query_params[:'facets_only'] = opts[:'facets_only'] if !opts[:'facets_only'].nil?
  query_params[:'start'] = opts[:'start'] if !opts[:'start'].nil?
  query_params[:'count'] = opts[:'count'] if !opts[:'count'].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] || 'SyntheticsSuiteSearchResponse'

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

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

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

Save new value for on-demand concurrency cap.

See Also:



1849
1850
1851
1852
 
# File 'lib/datadog_api_client/v2/api/synthetics_api.rb', line 1849

def set_on_demand_concurrency_cap(body, opts = {})
  data, _status_code, _headers = set_on_demand_concurrency_cap_with_http_info(body, opts)
  data
end

#set_on_demand_concurrency_cap_with_http_info(body, opts = {}) ⇒ Array<(OnDemandConcurrencyCapResponse, Integer, Hash)>

Save new value for on-demand concurrency cap.

Save new value for on-demand concurrency cap.

Parameters:

Returns:



1861
1862
1863
1864
1865
1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
 
# File 'lib/datadog_api_client/v2/api/synthetics_api.rb', line 1861

def set_on_demand_concurrency_cap_with_http_info(body, opts = {})

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SyntheticsAPI.set_on_demand_concurrency_cap ...'
  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 SyntheticsAPI.set_on_demand_concurrency_cap"
  end
  # resource path
  local_var_path = '/api/v2/synthetics/settings/on_demand_concurrency_cap'

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

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

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

#update_synthetics_network_test(public_id, body, opts = {}) ⇒ Object

Edit a Network Path test.

See Also:



1916
1917
1918
1919
 
# File 'lib/datadog_api_client/v2/api/synthetics_api.rb', line 1916

def update_synthetics_network_test(public_id, body, opts = {})
  data, _status_code, _headers = update_synthetics_network_test_with_http_info(public_id, body, opts)
  data
end

#update_synthetics_network_test_with_http_info(public_id, body, opts = {}) ⇒ Array<(SyntheticsNetworkTestResponse, Integer, Hash)>

Edit a Network Path test.

Parameters:

  • public_id (String) —

    The public ID of the Network Path test to edit.

  • body (SyntheticsNetworkTestEditRequest) —

    New Network Path test details to be saved.

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

    the optional parameters

Returns:



1926
1927
1928
1929
1930
1931
1932
1933
1934
1935
1936
1937
1938
1939
1940
1941
1942
1943
1944
1945
1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
1979
1980
 
# File 'lib/datadog_api_client/v2/api/synthetics_api.rb', line 1926

def update_synthetics_network_test_with_http_info(public_id, body, opts = {})

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SyntheticsAPI.update_synthetics_network_test ...'
  end
  # verify the required parameter 'public_id' is set
  if @api_client.config.client_side_validation && public_id.nil?
    fail ArgumentError, "Missing the required parameter 'public_id' when calling SyntheticsAPI.update_synthetics_network_test"
  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 SyntheticsAPI.update_synthetics_network_test"
  end
  # resource path
  local_var_path = '/api/v2/synthetics/tests/network/{public_id}'.sub('{public_id}', CGI.escape(public_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] || 'SyntheticsNetworkTestResponse'

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

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