Class: DatadogAPIClient::V1::DowntimesAPI

Inherits:
Object
  • Object
show all
Defined in:
lib/datadog_api_client/v1/api/downtimes_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

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

Returns a new instance of DowntimesAPI.



22
23
24
 
# File 'lib/datadog_api_client/v1/api/downtimes_api.rb', line 22

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

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



20
21
22
 
# File 'lib/datadog_api_client/v1/api/downtimes_api.rb', line 20

def api_client
  @api_client
end

Instance Method Details

#cancel_downtime(downtime_id, opts = {}) ⇒ Object

Cancel a downtime.

See Also:



30
31
32
33
 
# File 'lib/datadog_api_client/v1/api/downtimes_api.rb', line 30

def cancel_downtime(downtime_id, opts = {})
  cancel_downtime_with_http_info(downtime_id, opts)
  nil
end

#cancel_downtime_with_http_info(downtime_id, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Deprecated.

This API is deprecated.

Cancel a downtime.

Cancel a downtime. Note: This endpoint has been deprecated. Please use v2 endpoints.

Parameters:

  • downtime_id (Integer) —

    ID of the downtime to cancel.

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
 
# File 'lib/datadog_api_client/v1/api/downtimes_api.rb', line 40

def cancel_downtime_with_http_info(downtime_id, opts = {})

  if @api_client.config.unstable_operations.has_key?(:cancel_downtime)
    unstable_enabled = @api_client.config.unstable_operations[:cancel_downtime]
    if unstable_enabled
      @api_client.config.logger.warn format("Using unstable operation '%s'", "cancel_downtime")
    else
      raise APIError.new(message: format("Unstable operation '%s' is disabled", "cancel_downtime"))
    end
  end

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DowntimesAPI.cancel_downtime ...'
  end
  # verify the required parameter 'downtime_id' is set
  if @api_client.config.client_side_validation && downtime_id.nil?
    fail ArgumentError, "Missing the required parameter 'downtime_id' when calling DowntimesAPI.cancel_downtime"
  end
  # resource path
  local_var_path = '/api/v1/downtime/{downtime_id}'.sub('{' + 'downtime_id' + '}', CGI.escape(downtime_id.to_s))

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

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

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

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

  # return_type
  return_type = opts[:debug_return_type]

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

  new_options = opts.merge(
    :operation => :cancel_downtime,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

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

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

Cancel downtimes by scope.

See Also:



103
104
105
106
 
# File 'lib/datadog_api_client/v1/api/downtimes_api.rb', line 103

def cancel_downtimes_by_scope(body, opts = {})
  data, _status_code, _headers = cancel_downtimes_by_scope_with_http_info(body, opts)
  data
end

#cancel_downtimes_by_scope_with_http_info(body, opts = {}) ⇒ Array<(CanceledDowntimesIds, Integer, Hash)>

Deprecated.

This API is deprecated.

Cancel downtimes by scope.

Delete all downtimes that match the scope of X. Note: This only interacts with Downtimes created using v1 endpoints. This endpoint has been deprecated and will not be replaced. Please use v2 endpoints to find and cancel downtimes.

Parameters:

Returns:

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

    CanceledDowntimesIds data, response status code and response headers



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
165
166
167
168
169
170
171
 
# File 'lib/datadog_api_client/v1/api/downtimes_api.rb', line 113

def cancel_downtimes_by_scope_with_http_info(body, opts = {})

  if @api_client.config.unstable_operations.has_key?(:cancel_downtimes_by_scope)
    unstable_enabled = @api_client.config.unstable_operations[:cancel_downtimes_by_scope]
    if unstable_enabled
      @api_client.config.logger.warn format("Using unstable operation '%s'", "cancel_downtimes_by_scope")
    else
      raise APIError.new(message: format("Unstable operation '%s' is disabled", "cancel_downtimes_by_scope"))
    end
  end

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DowntimesAPI.cancel_downtimes_by_scope ...'
  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 DowntimesAPI.cancel_downtimes_by_scope"
  end
  # resource path
  local_var_path = '/api/v1/downtime/cancel/by_scope'

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

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

  new_options = opts.merge(
    :operation => :cancel_downtimes_by_scope,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

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

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

Schedule a downtime.

See Also:



178
179
180
181
 
# File 'lib/datadog_api_client/v1/api/downtimes_api.rb', line 178

def create_downtime(body, opts = {})
  data, _status_code, _headers = create_downtime_with_http_info(body, opts)
  data
end

#create_downtime_with_http_info(body, opts = {}) ⇒ Array<(Downtime, Integer, Hash)>

Deprecated.

This API is deprecated.

Schedule a downtime.

Schedule a downtime. Note: This endpoint has been deprecated. Please use v2 endpoints.

Parameters:

  • body (Downtime) —

    Schedule a downtime request body.

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

    the optional parameters

Returns:

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

    Downtime data, response status code and response headers



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
238
239
240
241
242
243
244
245
246
 
# File 'lib/datadog_api_client/v1/api/downtimes_api.rb', line 188

def create_downtime_with_http_info(body, opts = {})

  if @api_client.config.unstable_operations.has_key?(:create_downtime)
    unstable_enabled = @api_client.config.unstable_operations[:create_downtime]
    if unstable_enabled
      @api_client.config.logger.warn format("Using unstable operation '%s'", "create_downtime")
    else
      raise APIError.new(message: format("Unstable operation '%s' is disabled", "create_downtime"))
    end
  end

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DowntimesAPI.create_downtime ...'
  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 DowntimesAPI.create_downtime"
  end
  # resource path
  local_var_path = '/api/v1/downtime'

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

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

  new_options = opts.merge(
    :operation => :create_downtime,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

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

#get_downtime(downtime_id, opts = {}) ⇒ Object

Get a downtime.

See Also:



253
254
255
256
 
# File 'lib/datadog_api_client/v1/api/downtimes_api.rb', line 253

def get_downtime(downtime_id, opts = {})
  data, _status_code, _headers = get_downtime_with_http_info(downtime_id, opts)
  data
end

#get_downtime_with_http_info(downtime_id, opts = {}) ⇒ Array<(Downtime, Integer, Hash)>

Deprecated.

This API is deprecated.

Get a downtime.

Get downtime detail by downtime_id. Note: This endpoint has been deprecated. Please use v2 endpoints.

Parameters:

  • downtime_id (Integer) —

    ID of the downtime to fetch.

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

    the optional parameters

Returns:

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

    Downtime data, response status code and response headers



263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
 
# File 'lib/datadog_api_client/v1/api/downtimes_api.rb', line 263

def get_downtime_with_http_info(downtime_id, opts = {})

  if @api_client.config.unstable_operations.has_key?(:get_downtime)
    unstable_enabled = @api_client.config.unstable_operations[:get_downtime]
    if unstable_enabled
      @api_client.config.logger.warn format("Using unstable operation '%s'", "get_downtime")
    else
      raise APIError.new(message: format("Unstable operation '%s' is disabled", "get_downtime"))
    end
  end

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DowntimesAPI.get_downtime ...'
  end
  # verify the required parameter 'downtime_id' is set
  if @api_client.config.client_side_validation && downtime_id.nil?
    fail ArgumentError, "Missing the required parameter 'downtime_id' when calling DowntimesAPI.get_downtime"
  end
  # resource path
  local_var_path = '/api/v1/downtime/{downtime_id}'.sub('{' + 'downtime_id' + '}', CGI.escape(downtime_id.to_s))

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

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

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

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

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

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

  new_options = opts.merge(
    :operation => :get_downtime,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

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

#list_downtimes(opts = {}) ⇒ Object

Get all downtimes.

See Also:



326
327
328
329
 
# File 'lib/datadog_api_client/v1/api/downtimes_api.rb', line 326

def list_downtimes(opts = {})
  data, _status_code, _headers = list_downtimes_with_http_info(opts)
  data
end

#list_downtimes_with_http_info(opts = {}) ⇒ Array<(Array<Downtime>, Integer, Hash)>

Deprecated.

This API is deprecated.

Get all downtimes.

Get all scheduled downtimes. Note: This endpoint has been deprecated. Please use v2 endpoints.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :current_only (Boolean) —

    Only return downtimes that are active when the request is made.

  • :with_creator (Boolean) —

    Return creator information.

Returns:

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

    Array data, response status code and response headers



336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
 
# File 'lib/datadog_api_client/v1/api/downtimes_api.rb', line 336

def list_downtimes_with_http_info(opts = {})

  if @api_client.config.unstable_operations.has_key?(:list_downtimes)
    unstable_enabled = @api_client.config.unstable_operations[:list_downtimes]
    if unstable_enabled
      @api_client.config.logger.warn format("Using unstable operation '%s'", "list_downtimes")
    else
      raise APIError.new(message: format("Unstable operation '%s' is disabled", "list_downtimes"))
    end
  end

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DowntimesAPI.list_downtimes ...'
  end
  # resource path
  local_var_path = '/api/v1/downtime'

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

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

  new_options = opts.merge(
    :operation => :list_downtimes,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

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

#list_monitor_downtimes(monitor_id, opts = {}) ⇒ Object

Get active downtimes for a monitor.

See Also:



396
397
398
399
 
# File 'lib/datadog_api_client/v1/api/downtimes_api.rb', line 396

def list_monitor_downtimes(monitor_id, opts = {})
  data, _status_code, _headers = list_monitor_downtimes_with_http_info(monitor_id, opts)
  data
end

#list_monitor_downtimes_with_http_info(monitor_id, opts = {}) ⇒ Array<(Array<Downtime>, Integer, Hash)>

Deprecated.

This API is deprecated.

Get active downtimes for a monitor.

Get all active v1 downtimes for the specified monitor. Note: This endpoint has been deprecated. Please use v2 endpoints.

Parameters:

  • monitor_id (Integer) —

    The id of the monitor

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

    the optional parameters

Returns:

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

    Array data, response status code and response headers



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
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
 
# File 'lib/datadog_api_client/v1/api/downtimes_api.rb', line 406

def list_monitor_downtimes_with_http_info(monitor_id, opts = {})

  if @api_client.config.unstable_operations.has_key?(:list_monitor_downtimes)
    unstable_enabled = @api_client.config.unstable_operations[:list_monitor_downtimes]
    if unstable_enabled
      @api_client.config.logger.warn format("Using unstable operation '%s'", "list_monitor_downtimes")
    else
      raise APIError.new(message: format("Unstable operation '%s' is disabled", "list_monitor_downtimes"))
    end
  end

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DowntimesAPI.list_monitor_downtimes ...'
  end
  # verify the required parameter 'monitor_id' is set
  if @api_client.config.client_side_validation && monitor_id.nil?
    fail ArgumentError, "Missing the required parameter 'monitor_id' when calling DowntimesAPI.list_monitor_downtimes"
  end
  # resource path
  local_var_path = '/api/v1/monitor/{monitor_id}/downtimes'.sub('{' + 'monitor_id' + '}', CGI.escape(monitor_id.to_s))

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

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

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

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

  # return_type
  return_type = opts[:debug_return_type] || 'Array<Downtime>'

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

  new_options = opts.merge(
    :operation => :list_monitor_downtimes,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

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

#update_downtime(downtime_id, body, opts = {}) ⇒ Object

Update a downtime.

See Also:



470
471
472
473
 
# File 'lib/datadog_api_client/v1/api/downtimes_api.rb', line 470

def update_downtime(downtime_id, body, opts = {})
  data, _status_code, _headers = update_downtime_with_http_info(downtime_id, body, opts)
  data
end

#update_downtime_with_http_info(downtime_id, body, opts = {}) ⇒ Array<(Downtime, Integer, Hash)>

Deprecated.

This API is deprecated.

Update a downtime.

Update a single downtime by downtime_id. Note: This endpoint has been deprecated. Please use v2 endpoints.

Parameters:

  • downtime_id (Integer) —

    ID of the downtime to update.

  • body (Downtime) —

    Update a downtime request body.

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

    the optional parameters

Returns:

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

    Downtime data, response status code and response headers



481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
 
# File 'lib/datadog_api_client/v1/api/downtimes_api.rb', line 481

def update_downtime_with_http_info(downtime_id, body, opts = {})

  if @api_client.config.unstable_operations.has_key?(:update_downtime)
    unstable_enabled = @api_client.config.unstable_operations[:update_downtime]
    if unstable_enabled
      @api_client.config.logger.warn format("Using unstable operation '%s'", "update_downtime")
    else
      raise APIError.new(message: format("Unstable operation '%s' is disabled", "update_downtime"))
    end
  end

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DowntimesAPI.update_downtime ...'
  end
  # verify the required parameter 'downtime_id' is set
  if @api_client.config.client_side_validation && downtime_id.nil?
    fail ArgumentError, "Missing the required parameter 'downtime_id' when calling DowntimesAPI.update_downtime"
  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 DowntimesAPI.update_downtime"
  end
  # resource path
  local_var_path = '/api/v1/downtime/{downtime_id}'.sub('{' + 'downtime_id' + '}', CGI.escape(downtime_id.to_s))

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

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

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

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

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

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

  new_options = opts.merge(
    :operation => :update_downtime,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

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