Class: DatadogAPIClient::V2::MonitorsAPI

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

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

Returns a new instance of MonitorsAPI.



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

def api_client
  @api_client
end

Instance Method Details

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

Create a monitor configuration policy.

See Also:



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

def create_monitor_config_policy(body, opts = {})
  data, _status_code, _headers = create_monitor_config_policy_with_http_info(body, opts)
  data
end

#create_monitor_config_policy_with_http_info(body, opts = {}) ⇒ Array<(MonitorConfigPolicyResponse, Integer, Hash)>

Create a monitor configuration policy.

Create a monitor configuration policy.

Parameters:

Returns:

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

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

def create_monitor_config_policy_with_http_info(body, opts = {})

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: MonitorsAPI.create_monitor_config_policy ...'
  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 MonitorsAPI.create_monitor_config_policy"
  end
  # resource path
  local_var_path = '/api/v2/monitor/policy'

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

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

  new_options = opts.merge(
    :operation => :create_monitor_config_policy,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type,
    :api_version => "V2"
  )

  data, status_code, headers = @api_client.call_api(Net::HTTP::Post, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: MonitorsAPI#create_monitor_config_policy\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

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

Create a monitor notification rule.

See Also:



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

def create_monitor_notification_rule(body, opts = {})
  data, _status_code, _headers = create_monitor_notification_rule_with_http_info(body, opts)
  data
end

#create_monitor_notification_rule_with_http_info(body, opts = {}) ⇒ Array<(MonitorNotificationRuleResponse, Integer, Hash)>

Create a monitor notification rule.

Creates a monitor notification rule.

Parameters:

Returns:



108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
 
# File 'lib/datadog_api_client/v2/api/monitors_api.rb', line 108

def create_monitor_notification_rule_with_http_info(body, opts = {})
  unstable_enabled = @api_client.config.unstable_operations["v2.create_monitor_notification_rule".to_sym]
  if unstable_enabled
    @api_client.config.logger.warn format("Using unstable operation '%s'", "v2.create_monitor_notification_rule")
  else
    raise DatadogAPIClient::APIError.new(message: format("Unstable operation '%s' is disabled", "v2.create_monitor_notification_rule"))
  end

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: MonitorsAPI.create_monitor_notification_rule ...'
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling MonitorsAPI.create_monitor_notification_rule"
  end
  # resource path
  local_var_path = '/api/v2/monitor/notification_rule'

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

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

  new_options = opts.merge(
    :operation => :create_monitor_notification_rule,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type,
    :api_version => "V2"
  )

  data, status_code, headers = @api_client.call_api(Net::HTTP::Post, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: MonitorsAPI#create_monitor_notification_rule\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

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

Create a monitor user template.

See Also:



169
170
171
172
 
# File 'lib/datadog_api_client/v2/api/monitors_api.rb', line 169

def create_monitor_user_template(body, opts = {})
  data, _status_code, _headers = create_monitor_user_template_with_http_info(body, opts)
  data
end

#create_monitor_user_template_with_http_info(body, opts = {}) ⇒ Array<(MonitorUserTemplateCreateResponse, Integer, Hash)>

Create a monitor user template.

Create a new monitor user template.

Parameters:

Returns:



181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
 
# File 'lib/datadog_api_client/v2/api/monitors_api.rb', line 181

def create_monitor_user_template_with_http_info(body, opts = {})
  unstable_enabled = @api_client.config.unstable_operations["v2.create_monitor_user_template".to_sym]
  if unstable_enabled
    @api_client.config.logger.warn format("Using unstable operation '%s'", "v2.create_monitor_user_template")
  else
    raise DatadogAPIClient::APIError.new(message: format("Unstable operation '%s' is disabled", "v2.create_monitor_user_template"))
  end

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: MonitorsAPI.create_monitor_user_template ...'
  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 MonitorsAPI.create_monitor_user_template"
  end
  # resource path
  local_var_path = '/api/v2/monitor/template'

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

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

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

#delete_monitor_config_policy(policy_id, opts = {}) ⇒ Object

Delete a monitor configuration policy.

See Also:



242
243
244
245
 
# File 'lib/datadog_api_client/v2/api/monitors_api.rb', line 242

def delete_monitor_config_policy(policy_id, opts = {})
  delete_monitor_config_policy_with_http_info(policy_id, opts)
  nil
end

#delete_monitor_config_policy_with_http_info(policy_id, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Delete a monitor configuration policy.

Delete a monitor configuration policy.

Parameters:

  • policy_id (String) —

    ID of the monitor configuration policy.

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



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
299
300
301
302
 
# File 'lib/datadog_api_client/v2/api/monitors_api.rb', line 254

def delete_monitor_config_policy_with_http_info(policy_id, opts = {})

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

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

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['*/*'])

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

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

  # return_type
  return_type = opts[:debug_return_type]

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

  new_options = opts.merge(
    :operation => :delete_monitor_config_policy,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type,
    :api_version => "V2"
  )

  data, status_code, headers = @api_client.call_api(Net::HTTP::Delete, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: MonitorsAPI#delete_monitor_config_policy\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_monitor_notification_rule(rule_id, opts = {}) ⇒ Object

Delete a monitor notification rule.

See Also:



307
308
309
310
 
# File 'lib/datadog_api_client/v2/api/monitors_api.rb', line 307

def delete_monitor_notification_rule(rule_id, opts = {})
  delete_monitor_notification_rule_with_http_info(rule_id, opts)
  nil
end

#delete_monitor_notification_rule_with_http_info(rule_id, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Delete a monitor notification rule.

Deletes a monitor notification rule by ‘rule_id`.

Parameters:

  • rule_id (String) —

    ID of the monitor notification rule to delete.

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



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
363
364
365
366
367
368
369
370
371
372
373
 
# File 'lib/datadog_api_client/v2/api/monitors_api.rb', line 319

def delete_monitor_notification_rule_with_http_info(rule_id, opts = {})
  unstable_enabled = @api_client.config.unstable_operations["v2.delete_monitor_notification_rule".to_sym]
  if unstable_enabled
    @api_client.config.logger.warn format("Using unstable operation '%s'", "v2.delete_monitor_notification_rule")
  else
    raise DatadogAPIClient::APIError.new(message: format("Unstable operation '%s' is disabled", "v2.delete_monitor_notification_rule"))
  end

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

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

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['*/*'])

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

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

  # return_type
  return_type = opts[:debug_return_type]

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

  new_options = opts.merge(
    :operation => :delete_monitor_notification_rule,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type,
    :api_version => "V2"
  )

  data, status_code, headers = @api_client.call_api(Net::HTTP::Delete, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: MonitorsAPI#delete_monitor_notification_rule\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_monitor_user_template(template_id, opts = {}) ⇒ Object

Delete a monitor user template.

See Also:



378
379
380
381
 
# File 'lib/datadog_api_client/v2/api/monitors_api.rb', line 378

def delete_monitor_user_template(template_id, opts = {})
  delete_monitor_user_template_with_http_info(template_id, opts)
  nil
end

#delete_monitor_user_template_with_http_info(template_id, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Delete a monitor user template.

Delete an existing monitor user template by its ID.

Parameters:

  • template_id (String) —

    ID of the monitor user template.

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



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
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
 
# File 'lib/datadog_api_client/v2/api/monitors_api.rb', line 390

def delete_monitor_user_template_with_http_info(template_id, opts = {})
  unstable_enabled = @api_client.config.unstable_operations["v2.delete_monitor_user_template".to_sym]
  if unstable_enabled
    @api_client.config.logger.warn format("Using unstable operation '%s'", "v2.delete_monitor_user_template")
  else
    raise DatadogAPIClient::APIError.new(message: format("Unstable operation '%s' is disabled", "v2.delete_monitor_user_template"))
  end

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

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

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['*/*'])

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

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

  # return_type
  return_type = opts[:debug_return_type]

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

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

#get_monitor_config_policy(policy_id, opts = {}) ⇒ Object

Get a monitor configuration policy.

See Also:



449
450
451
452
 
# File 'lib/datadog_api_client/v2/api/monitors_api.rb', line 449

def get_monitor_config_policy(policy_id, opts = {})
  data, _status_code, _headers = get_monitor_config_policy_with_http_info(policy_id, opts)
  data
end

#get_monitor_config_policy_with_http_info(policy_id, opts = {}) ⇒ Array<(MonitorConfigPolicyResponse, Integer, Hash)>

Get a monitor configuration policy.

Get a monitor configuration policy by ‘policy_id`.

Parameters:

  • policy_id (String) —

    ID of the monitor configuration policy.

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

    the optional parameters

Returns:

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

    MonitorConfigPolicyResponse data, response status code and response headers



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
496
497
498
499
500
501
502
503
504
505
506
507
508
509
 
# File 'lib/datadog_api_client/v2/api/monitors_api.rb', line 461

def get_monitor_config_policy_with_http_info(policy_id, opts = {})

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: MonitorsAPI.get_monitor_config_policy ...'
  end
  # verify the required parameter 'policy_id' is set
  if @api_client.config.client_side_validation && policy_id.nil?
    fail ArgumentError, "Missing the required parameter 'policy_id' when calling MonitorsAPI.get_monitor_config_policy"
  end
  # resource path
  local_var_path = '/api/v2/monitor/policy/{policy_id}'.sub('{policy_id}', CGI.escape(policy_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] || 'MonitorConfigPolicyResponse'

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

  new_options = opts.merge(
    :operation => :get_monitor_config_policy,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type,
    :api_version => "V2"
  )

  data, status_code, headers = @api_client.call_api(Net::HTTP::Get, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: MonitorsAPI#get_monitor_config_policy\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_monitor_notification_rule(rule_id, opts = {}) ⇒ Object

Get a monitor notification rule.

See Also:



514
515
516
517
 
# File 'lib/datadog_api_client/v2/api/monitors_api.rb', line 514

def get_monitor_notification_rule(rule_id, opts = {})
  data, _status_code, _headers = get_monitor_notification_rule_with_http_info(rule_id, opts)
  data
end

#get_monitor_notification_rule_with_http_info(rule_id, opts = {}) ⇒ Array<(MonitorNotificationRuleResponse, Integer, Hash)>

Get a monitor notification rule.

Returns a monitor notification rule by ‘rule_id`.

Parameters:

  • rule_id (String) —

    ID of the monitor notification rule to fetch.

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

    the optional parameters

Options Hash (opts):

  • :include (String) —

    Comma-separated list of resource paths for related resources to include in the response. Supported resource path is ‘created_by`.

Returns:



527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
 
# File 'lib/datadog_api_client/v2/api/monitors_api.rb', line 527

def get_monitor_notification_rule_with_http_info(rule_id, opts = {})
  unstable_enabled = @api_client.config.unstable_operations["v2.get_monitor_notification_rule".to_sym]
  if unstable_enabled
    @api_client.config.logger.warn format("Using unstable operation '%s'", "v2.get_monitor_notification_rule")
  else
    raise DatadogAPIClient::APIError.new(message: format("Unstable operation '%s' is disabled", "v2.get_monitor_notification_rule"))
  end

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

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'include'] = opts[:'include'] if !opts[:'include'].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] || 'MonitorNotificationRuleResponse'

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

  new_options = opts.merge(
    :operation => :get_monitor_notification_rule,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type,
    :api_version => "V2"
  )

  data, status_code, headers = @api_client.call_api(Net::HTTP::Get, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: MonitorsAPI#get_monitor_notification_rule\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_monitor_notification_rules(opts = {}) ⇒ Object

Get all monitor notification rules.

See Also:



587
588
589
590
 
# File 'lib/datadog_api_client/v2/api/monitors_api.rb', line 587

def get_monitor_notification_rules(opts = {})
  data, _status_code, _headers = get_monitor_notification_rules_with_http_info(opts)
  data
end

#get_monitor_notification_rules_with_http_info(opts = {}) ⇒ Array<(MonitorNotificationRuleListResponse, Integer, Hash)>

Get all monitor notification rules.

Returns a list of all monitor notification rules.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :include (String) —

    Comma-separated list of resource paths for related resources to include in the response. Supported resource path is ‘created_by`.

Returns:



599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
 
# File 'lib/datadog_api_client/v2/api/monitors_api.rb', line 599

def get_monitor_notification_rules_with_http_info(opts = {})
  unstable_enabled = @api_client.config.unstable_operations["v2.get_monitor_notification_rules".to_sym]
  if unstable_enabled
    @api_client.config.logger.warn format("Using unstable operation '%s'", "v2.get_monitor_notification_rules")
  else
    raise DatadogAPIClient::APIError.new(message: format("Unstable operation '%s' is disabled", "v2.get_monitor_notification_rules"))
  end

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: MonitorsAPI.get_monitor_notification_rules ...'
  end
  # resource path
  local_var_path = '/api/v2/monitor/notification_rule'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'include'] = opts[:'include'] if !opts[:'include'].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] || 'MonitorNotificationRuleListResponse'

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

  new_options = opts.merge(
    :operation => :get_monitor_notification_rules,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type,
    :api_version => "V2"
  )

  data, status_code, headers = @api_client.call_api(Net::HTTP::Get, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: MonitorsAPI#get_monitor_notification_rules\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_monitor_user_template(template_id, opts = {}) ⇒ Object

Get a monitor user template.

See Also:



655
656
657
658
 
# File 'lib/datadog_api_client/v2/api/monitors_api.rb', line 655

def get_monitor_user_template(template_id, opts = {})
  data, _status_code, _headers = get_monitor_user_template_with_http_info(template_id, opts)
  data
end

#get_monitor_user_template_with_http_info(template_id, opts = {}) ⇒ Array<(MonitorUserTemplateResponse, Integer, Hash)>

Get a monitor user template.

Retrieve a monitor user template by its ID.

Parameters:

  • template_id (String) —

    ID of the monitor user template.

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

    the optional parameters

Options Hash (opts):

  • :with_all_versions (Boolean) —

    Whether to include all versions of the template in the response in the versions field.

Returns:

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

    MonitorUserTemplateResponse data, response status code and response headers



668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
 
# File 'lib/datadog_api_client/v2/api/monitors_api.rb', line 668

def get_monitor_user_template_with_http_info(template_id, opts = {})
  unstable_enabled = @api_client.config.unstable_operations["v2.get_monitor_user_template".to_sym]
  if unstable_enabled
    @api_client.config.logger.warn format("Using unstable operation '%s'", "v2.get_monitor_user_template")
  else
    raise DatadogAPIClient::APIError.new(message: format("Unstable operation '%s' is disabled", "v2.get_monitor_user_template"))
  end

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

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'with_all_versions'] = opts[:'with_all_versions'] if !opts[:'with_all_versions'].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] || 'MonitorUserTemplateResponse'

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

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

#list_monitor_config_policies(opts = {}) ⇒ Object

Get all monitor configuration policies.

See Also:



728
729
730
731
 
# File 'lib/datadog_api_client/v2/api/monitors_api.rb', line 728

def list_monitor_config_policies(opts = {})
  data, _status_code, _headers = list_monitor_config_policies_with_http_info(opts)
  data
end

#list_monitor_config_policies_with_http_info(opts = {}) ⇒ Array<(MonitorConfigPolicyListResponse, Integer, Hash)>

Get all monitor configuration policies.

Get all monitor configuration policies.

Parameters:

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

    the optional parameters

Returns:



739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
 
# File 'lib/datadog_api_client/v2/api/monitors_api.rb', line 739

def list_monitor_config_policies_with_http_info(opts = {})

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: MonitorsAPI.list_monitor_config_policies ...'
  end
  # resource path
  local_var_path = '/api/v2/monitor/policy'

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

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

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

#list_monitor_user_templates(opts = {}) ⇒ Object

Get all monitor user templates.

See Also:



788
789
790
791
 
# File 'lib/datadog_api_client/v2/api/monitors_api.rb', line 788

def list_monitor_user_templates(opts = {})
  data, _status_code, _headers = list_monitor_user_templates_with_http_info(opts)
  data
end

#list_monitor_user_templates_with_http_info(opts = {}) ⇒ Array<(MonitorUserTemplateListResponse, Integer, Hash)>

Get all monitor user templates.

Retrieve all monitor user templates.

Parameters:

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

    the optional parameters

Returns:



799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
 
# File 'lib/datadog_api_client/v2/api/monitors_api.rb', line 799

def list_monitor_user_templates_with_http_info(opts = {})
  unstable_enabled = @api_client.config.unstable_operations["v2.list_monitor_user_templates".to_sym]
  if unstable_enabled
    @api_client.config.logger.warn format("Using unstable operation '%s'", "v2.list_monitor_user_templates")
  else
    raise DatadogAPIClient::APIError.new(message: format("Unstable operation '%s' is disabled", "v2.list_monitor_user_templates"))
  end

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: MonitorsAPI.list_monitor_user_templates ...'
  end
  # resource path
  local_var_path = '/api/v2/monitor/template'

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

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

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

#update_monitor_config_policy(policy_id, body, opts = {}) ⇒ Object

Edit a monitor configuration policy.

See Also:



854
855
856
857
 
# File 'lib/datadog_api_client/v2/api/monitors_api.rb', line 854

def update_monitor_config_policy(policy_id, body, opts = {})
  data, _status_code, _headers = update_monitor_config_policy_with_http_info(policy_id, body, opts)
  data
end

#update_monitor_config_policy_with_http_info(policy_id, body, opts = {}) ⇒ Array<(MonitorConfigPolicyResponse, Integer, Hash)>

Edit a monitor configuration policy.

Edit a monitor configuration policy.

Parameters:

  • policy_id (String) —

    ID of the monitor configuration policy.

  • body (MonitorConfigPolicyEditRequest) —

    Description of the update.

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

    the optional parameters

Returns:

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

    MonitorConfigPolicyResponse data, response status code and response headers



867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
 
# File 'lib/datadog_api_client/v2/api/monitors_api.rb', line 867

def update_monitor_config_policy_with_http_info(policy_id, body, opts = {})

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: MonitorsAPI.update_monitor_config_policy ...'
  end
  # verify the required parameter 'policy_id' is set
  if @api_client.config.client_side_validation && policy_id.nil?
    fail ArgumentError, "Missing the required parameter 'policy_id' when calling MonitorsAPI.update_monitor_config_policy"
  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 MonitorsAPI.update_monitor_config_policy"
  end
  # resource path
  local_var_path = '/api/v2/monitor/policy/{policy_id}'.sub('{policy_id}', CGI.escape(policy_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] || 'MonitorConfigPolicyResponse'

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

  new_options = opts.merge(
    :operation => :update_monitor_config_policy,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type,
    :api_version => "V2"
  )

  data, status_code, headers = @api_client.call_api(Net::HTTP::Patch, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: MonitorsAPI#update_monitor_config_policy\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_monitor_notification_rule(rule_id, body, opts = {}) ⇒ Object

Update a monitor notification rule.

See Also:



926
927
928
929
 
# File 'lib/datadog_api_client/v2/api/monitors_api.rb', line 926

def update_monitor_notification_rule(rule_id, body, opts = {})
  data, _status_code, _headers = update_monitor_notification_rule_with_http_info(rule_id, body, opts)
  data
end

#update_monitor_notification_rule_with_http_info(rule_id, body, opts = {}) ⇒ Array<(MonitorNotificationRuleResponse, Integer, Hash)>

Update a monitor notification rule.

Updates a monitor notification rule by ‘rule_id`.

Parameters:

  • rule_id (String) —

    ID of the monitor notification rule to update.

  • body (MonitorNotificationRuleUpdateRequest) —

    Request body to update the monitor notification rule.

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

    the optional parameters

Returns:



939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
 
# File 'lib/datadog_api_client/v2/api/monitors_api.rb', line 939

def update_monitor_notification_rule_with_http_info(rule_id, body, opts = {})
  unstable_enabled = @api_client.config.unstable_operations["v2.update_monitor_notification_rule".to_sym]
  if unstable_enabled
    @api_client.config.logger.warn format("Using unstable operation '%s'", "v2.update_monitor_notification_rule")
  else
    raise DatadogAPIClient::APIError.new(message: format("Unstable operation '%s' is disabled", "v2.update_monitor_notification_rule"))
  end

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: MonitorsAPI.update_monitor_notification_rule ...'
  end
  # verify the required parameter 'rule_id' is set
  if @api_client.config.client_side_validation && rule_id.nil?
    fail ArgumentError, "Missing the required parameter 'rule_id' when calling MonitorsAPI.update_monitor_notification_rule"
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling MonitorsAPI.update_monitor_notification_rule"
  end
  # resource path
  local_var_path = '/api/v2/monitor/notification_rule/{rule_id}'.sub('{rule_id}', CGI.escape(rule_id.to_s).gsub('%2F', '/'))

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

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

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

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(body)

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

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

  new_options = opts.merge(
    :operation => :update_monitor_notification_rule,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type,
    :api_version => "V2"
  )

  data, status_code, headers = @api_client.call_api(Net::HTTP::Patch, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: MonitorsAPI#update_monitor_notification_rule\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_monitor_user_template(template_id, body, opts = {}) ⇒ Object

Update a monitor user template to a new version.

See Also:



1004
1005
1006
1007
 
# File 'lib/datadog_api_client/v2/api/monitors_api.rb', line 1004

def update_monitor_user_template(template_id, body, opts = {})
  data, _status_code, _headers = update_monitor_user_template_with_http_info(template_id, body, opts)
  data
end

#update_monitor_user_template_with_http_info(template_id, body, opts = {}) ⇒ Array<(MonitorUserTemplateResponse, Integer, Hash)>

Update a monitor user template to a new version.

Creates a new version of an existing monitor user template.

Parameters:

Returns:

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

    MonitorUserTemplateResponse data, response status code and response headers



1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
 
# File 'lib/datadog_api_client/v2/api/monitors_api.rb', line 1017

def update_monitor_user_template_with_http_info(template_id, body, opts = {})
  unstable_enabled = @api_client.config.unstable_operations["v2.update_monitor_user_template".to_sym]
  if unstable_enabled
    @api_client.config.logger.warn format("Using unstable operation '%s'", "v2.update_monitor_user_template")
  else
    raise DatadogAPIClient::APIError.new(message: format("Unstable operation '%s' is disabled", "v2.update_monitor_user_template"))
  end

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: MonitorsAPI.update_monitor_user_template ...'
  end
  # verify the required parameter 'template_id' is set
  if @api_client.config.client_side_validation && template_id.nil?
    fail ArgumentError, "Missing the required parameter 'template_id' when calling MonitorsAPI.update_monitor_user_template"
  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 MonitorsAPI.update_monitor_user_template"
  end
  # resource path
  local_var_path = '/api/v2/monitor/template/{template_id}'.sub('{template_id}', CGI.escape(template_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] || 'MonitorUserTemplateResponse'

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

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

#validate_existing_monitor_user_template(template_id, body, opts = {}) ⇒ Object

Validate an existing monitor user template.

See Also:



1082
1083
1084
1085
 
# File 'lib/datadog_api_client/v2/api/monitors_api.rb', line 1082

def validate_existing_monitor_user_template(template_id, body, opts = {})
  validate_existing_monitor_user_template_with_http_info(template_id, body, opts)
  nil
end

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

Validate an existing monitor user template.

Validate the structure and content of an existing monitor user template being updated to a new version.

Parameters:

Returns:

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

    nil, response status code and response headers



1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
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
 
# File 'lib/datadog_api_client/v2/api/monitors_api.rb', line 1095

def validate_existing_monitor_user_template_with_http_info(template_id, body, opts = {})
  unstable_enabled = @api_client.config.unstable_operations["v2.validate_existing_monitor_user_template".to_sym]
  if unstable_enabled
    @api_client.config.logger.warn format("Using unstable operation '%s'", "v2.validate_existing_monitor_user_template")
  else
    raise DatadogAPIClient::APIError.new(message: format("Unstable operation '%s' is disabled", "v2.validate_existing_monitor_user_template"))
  end

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

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

Validate a monitor user template.

See Also:



1160
1161
1162
1163
 
# File 'lib/datadog_api_client/v2/api/monitors_api.rb', line 1160

def validate_monitor_user_template(body, opts = {})
  validate_monitor_user_template_with_http_info(body, opts)
  nil
end

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

Validate a monitor user template.

Validate the structure and content of a monitor user template.

Parameters:

Returns:

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

    nil, response status code and response headers



1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
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
 
# File 'lib/datadog_api_client/v2/api/monitors_api.rb', line 1172

def validate_monitor_user_template_with_http_info(body, opts = {})
  unstable_enabled = @api_client.config.unstable_operations["v2.validate_monitor_user_template".to_sym]
  if unstable_enabled
    @api_client.config.logger.warn format("Using unstable operation '%s'", "v2.validate_monitor_user_template")
  else
    raise DatadogAPIClient::APIError.new(message: format("Unstable operation '%s' is disabled", "v2.validate_monitor_user_template"))
  end

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: MonitorsAPI.validate_monitor_user_template ...'
  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 MonitorsAPI.validate_monitor_user_template"
  end
  # resource path
  local_var_path = '/api/v2/monitor/template/validate'

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