Class: DatadogAPIClient::V2::StatusPagesAPI

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

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

Returns a new instance of StatusPagesAPI.



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

def api_client
  @api_client
end

Instance Method Details

#create_component(page_id, body, opts = {}) ⇒ Object

Create component.

See Also:



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

def create_component(page_id, body, opts = {})
  data, _status_code, _headers = create_component_with_http_info(page_id, body, opts)
  data
end

#create_component_with_http_info(page_id, body, opts = {}) ⇒ Array<(StatusPagesComponent, Integer, Hash)>

Create component.

Creates a new component.

Parameters:

  • page_id (UUID) —

    The ID of the status page.

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

    the optional parameters

Options Hash (opts):

  • :include (String) —

    Comma-separated list of resources to include. Supported values: created_by_user, last_modified_by_user, status_page, group.

Returns:

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

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

def create_component_with_http_info(page_id, body, opts = {})

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: StatusPagesAPI.create_component ...'
  end
  # verify the required parameter 'page_id' is set
  if @api_client.config.client_side_validation && page_id.nil?
    fail ArgumentError, "Missing the required parameter 'page_id' when calling StatusPagesAPI.create_component"
  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 StatusPagesAPI.create_component"
  end
  # resource path
  local_var_path = '/api/v2/statuspages/{page_id}/components'.sub('{page_id}', CGI.escape(page_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'])
  # 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] || 'StatusPagesComponent'

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

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

#create_degradation(page_id, body, opts = {}) ⇒ Object

Create degradation.

See Also:



103
104
105
106
 
# File 'lib/datadog_api_client/v2/api/status_pages_api.rb', line 103

def create_degradation(page_id, body, opts = {})
  data, _status_code, _headers = create_degradation_with_http_info(page_id, body, opts)
  data
end

#create_degradation_with_http_info(page_id, body, opts = {}) ⇒ Array<(Degradation, Integer, Hash)>

Create degradation.

Creates a new degradation.

Parameters:

  • page_id (UUID) —

    The ID of the status page.

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

    the optional parameters

Options Hash (opts):

  • :notify_subscribers (Boolean) —

    Whether to notify page subscribers of the degradation.

  • :include (String) —

    Comma-separated list of resources to include. Supported values: created_by_user, last_modified_by_user, status_page.

Returns:

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

    Degradation data, response status code and response headers



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
172
173
174
 
# File 'lib/datadog_api_client/v2/api/status_pages_api.rb', line 118

def create_degradation_with_http_info(page_id, body, opts = {})

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: StatusPagesAPI.create_degradation ...'
  end
  # verify the required parameter 'page_id' is set
  if @api_client.config.client_side_validation && page_id.nil?
    fail ArgumentError, "Missing the required parameter 'page_id' when calling StatusPagesAPI.create_degradation"
  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 StatusPagesAPI.create_degradation"
  end
  # resource path
  local_var_path = '/api/v2/statuspages/{page_id}/degradations'.sub('{page_id}', CGI.escape(page_id.to_s).gsub('%2F', '/'))

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

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

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

#create_maintenance(page_id, body, opts = {}) ⇒ Object

Schedule maintenance.

See Also:



179
180
181
182
 
# File 'lib/datadog_api_client/v2/api/status_pages_api.rb', line 179

def create_maintenance(page_id, body, opts = {})
  data, _status_code, _headers = create_maintenance_with_http_info(page_id, body, opts)
  data
end

#create_maintenance_with_http_info(page_id, body, opts = {}) ⇒ Array<(Maintenance, Integer, Hash)>

Schedule maintenance.

Schedules a new maintenance.

Parameters:

  • page_id (UUID) —

    The ID of the status page.

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

    the optional parameters

Options Hash (opts):

  • :notify_subscribers (Boolean) —

    Whether to notify page subscribers of the maintenance.

  • :include (String) —

    Comma-separated list of resources to include. Supported values: created_by_user, last_modified_by_user, status_page.

Returns:

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

    Maintenance data, response status code and response headers



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
247
248
249
250
 
# File 'lib/datadog_api_client/v2/api/status_pages_api.rb', line 194

def create_maintenance_with_http_info(page_id, body, opts = {})

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: StatusPagesAPI.create_maintenance ...'
  end
  # verify the required parameter 'page_id' is set
  if @api_client.config.client_side_validation && page_id.nil?
    fail ArgumentError, "Missing the required parameter 'page_id' when calling StatusPagesAPI.create_maintenance"
  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 StatusPagesAPI.create_maintenance"
  end
  # resource path
  local_var_path = '/api/v2/statuspages/{page_id}/maintenances'.sub('{page_id}', CGI.escape(page_id.to_s).gsub('%2F', '/'))

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

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

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

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

Create status page.

See Also:



255
256
257
258
 
# File 'lib/datadog_api_client/v2/api/status_pages_api.rb', line 255

def create_status_page(body, opts = {})
  data, _status_code, _headers = create_status_page_with_http_info(body, opts)
  data
end

#create_status_page_with_http_info(body, opts = {}) ⇒ Array<(StatusPage, Integer, Hash)>

Create status page.

Creates a new status page.

Parameters:

Options Hash (opts):

  • :include (String) —

    Comma-separated list of resources to include. Supported values: created_by_user, last_modified_by_user.

Returns:

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

    StatusPage data, response status code and response headers



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/v2/api/status_pages_api.rb', line 268

def create_status_page_with_http_info(body, opts = {})

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

  # 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'])
  # 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] || 'StatusPage'

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

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

#delete_component(page_id, component_id, opts = {}) ⇒ Object

Delete component.

See Also:



324
325
326
327
 
# File 'lib/datadog_api_client/v2/api/status_pages_api.rb', line 324

def delete_component(page_id, component_id, opts = {})
  delete_component_with_http_info(page_id, component_id, opts)
  nil
end

#delete_component_with_http_info(page_id, component_id, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Delete component.

Deletes a component by its ID.

Parameters:

  • page_id (UUID) —

    The ID of the status page.

  • component_id (UUID) —

    The ID of the component.

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



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/v2/api/status_pages_api.rb', line 337

def delete_component_with_http_info(page_id, component_id, opts = {})

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: StatusPagesAPI.delete_component ...'
  end
  # verify the required parameter 'page_id' is set
  if @api_client.config.client_side_validation && page_id.nil?
    fail ArgumentError, "Missing the required parameter 'page_id' when calling StatusPagesAPI.delete_component"
  end
  # verify the required parameter 'component_id' is set
  if @api_client.config.client_side_validation && component_id.nil?
    fail ArgumentError, "Missing the required parameter 'component_id' when calling StatusPagesAPI.delete_component"
  end
  # resource path
  local_var_path = '/api/v2/statuspages/{page_id}/components/{component_id}'.sub('{page_id}', CGI.escape(page_id.to_s).gsub('%2F', '/')).sub('{component_id}', CGI.escape(component_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_component,
    :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: StatusPagesAPI#delete_component\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_degradation(page_id, degradation_id, opts = {}) ⇒ Object

Delete degradation.

See Also:



394
395
396
397
 
# File 'lib/datadog_api_client/v2/api/status_pages_api.rb', line 394

def delete_degradation(page_id, degradation_id, opts = {})
  delete_degradation_with_http_info(page_id, degradation_id, opts)
  nil
end

#delete_degradation_with_http_info(page_id, degradation_id, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Delete degradation.

Deletes a degradation by its ID.

Parameters:

  • page_id (UUID) —

    The ID of the status page.

  • degradation_id (UUID) —

    The ID of the degradation.

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



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

def delete_degradation_with_http_info(page_id, degradation_id, opts = {})

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: StatusPagesAPI.delete_degradation ...'
  end
  # verify the required parameter 'page_id' is set
  if @api_client.config.client_side_validation && page_id.nil?
    fail ArgumentError, "Missing the required parameter 'page_id' when calling StatusPagesAPI.delete_degradation"
  end
  # verify the required parameter 'degradation_id' is set
  if @api_client.config.client_side_validation && degradation_id.nil?
    fail ArgumentError, "Missing the required parameter 'degradation_id' when calling StatusPagesAPI.delete_degradation"
  end
  # resource path
  local_var_path = '/api/v2/statuspages/{page_id}/degradations/{degradation_id}'.sub('{page_id}', CGI.escape(page_id.to_s).gsub('%2F', '/')).sub('{degradation_id}', CGI.escape(degradation_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_degradation,
    :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: StatusPagesAPI#delete_degradation\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_status_page(page_id, opts = {}) ⇒ Object

Delete status page.

See Also:



464
465
466
467
 
# File 'lib/datadog_api_client/v2/api/status_pages_api.rb', line 464

def delete_status_page(page_id, opts = {})
  delete_status_page_with_http_info(page_id, opts)
  nil
end

#delete_status_page_with_http_info(page_id, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Delete status page.

Deletes a status page by its ID.

Parameters:

  • page_id (UUID) —

    The ID of the status page.

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



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
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
 
# File 'lib/datadog_api_client/v2/api/status_pages_api.rb', line 476

def delete_status_page_with_http_info(page_id, opts = {})

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

#get_component(page_id, component_id, opts = {}) ⇒ Object

Get component.

See Also:



529
530
531
532
 
# File 'lib/datadog_api_client/v2/api/status_pages_api.rb', line 529

def get_component(page_id, component_id, opts = {})
  data, _status_code, _headers = get_component_with_http_info(page_id, component_id, opts)
  data
end

#get_component_with_http_info(page_id, component_id, opts = {}) ⇒ Array<(StatusPagesComponent, Integer, Hash)>

Get component.

Retrieves a specific component by its ID.

Parameters:

  • page_id (UUID) —

    The ID of the status page.

  • component_id (UUID) —

    The ID of the component.

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

    the optional parameters

Options Hash (opts):

  • :include (String) —

    Comma-separated list of resources to include. Supported values: created_by_user, last_modified_by_user, status_page, group.

Returns:

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

    StatusPagesComponent data, response status code and response headers



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
583
584
585
586
587
588
589
590
591
592
593
594
595
596
 
# File 'lib/datadog_api_client/v2/api/status_pages_api.rb', line 543

def get_component_with_http_info(page_id, component_id, opts = {})

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: StatusPagesAPI.get_component ...'
  end
  # verify the required parameter 'page_id' is set
  if @api_client.config.client_side_validation && page_id.nil?
    fail ArgumentError, "Missing the required parameter 'page_id' when calling StatusPagesAPI.get_component"
  end
  # verify the required parameter 'component_id' is set
  if @api_client.config.client_side_validation && component_id.nil?
    fail ArgumentError, "Missing the required parameter 'component_id' when calling StatusPagesAPI.get_component"
  end
  # resource path
  local_var_path = '/api/v2/statuspages/{page_id}/components/{component_id}'.sub('{page_id}', CGI.escape(page_id.to_s).gsub('%2F', '/')).sub('{component_id}', CGI.escape(component_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] || 'StatusPagesComponent'

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

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

#get_degradation(page_id, degradation_id, opts = {}) ⇒ Object

Get degradation.

See Also:



601
602
603
604
 
# File 'lib/datadog_api_client/v2/api/status_pages_api.rb', line 601

def get_degradation(page_id, degradation_id, opts = {})
  data, _status_code, _headers = get_degradation_with_http_info(page_id, degradation_id, opts)
  data
end

#get_degradation_with_http_info(page_id, degradation_id, opts = {}) ⇒ Array<(Degradation, Integer, Hash)>

Get degradation.

Retrieves a specific degradation by its ID.

Parameters:

  • page_id (UUID) —

    The ID of the status page.

  • degradation_id (UUID) —

    The ID of the degradation.

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

    the optional parameters

Options Hash (opts):

  • :include (String) —

    Comma-separated list of resources to include. Supported values: created_by_user, last_modified_by_user, status_page.

Returns:

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

    Degradation data, response status code and response headers



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
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
 
# File 'lib/datadog_api_client/v2/api/status_pages_api.rb', line 615

def get_degradation_with_http_info(page_id, degradation_id, opts = {})

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: StatusPagesAPI.get_degradation ...'
  end
  # verify the required parameter 'page_id' is set
  if @api_client.config.client_side_validation && page_id.nil?
    fail ArgumentError, "Missing the required parameter 'page_id' when calling StatusPagesAPI.get_degradation"
  end
  # verify the required parameter 'degradation_id' is set
  if @api_client.config.client_side_validation && degradation_id.nil?
    fail ArgumentError, "Missing the required parameter 'degradation_id' when calling StatusPagesAPI.get_degradation"
  end
  # resource path
  local_var_path = '/api/v2/statuspages/{page_id}/degradations/{degradation_id}'.sub('{page_id}', CGI.escape(page_id.to_s).gsub('%2F', '/')).sub('{degradation_id}', CGI.escape(degradation_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] || 'Degradation'

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

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

#get_maintenance(page_id, maintenance_id, opts = {}) ⇒ Object

Get maintenance.

See Also:



673
674
675
676
 
# File 'lib/datadog_api_client/v2/api/status_pages_api.rb', line 673

def get_maintenance(page_id, maintenance_id, opts = {})
  data, _status_code, _headers = get_maintenance_with_http_info(page_id, maintenance_id, opts)
  data
end

#get_maintenance_with_http_info(page_id, maintenance_id, opts = {}) ⇒ Array<(Maintenance, Integer, Hash)>

Get maintenance.

Retrieves a specific maintenance by its ID.

Parameters:

  • page_id (UUID) —

    The ID of the status page.

  • maintenance_id (UUID) —

    The ID of the maintenance.

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

    the optional parameters

Options Hash (opts):

  • :include (String) —

    Comma-separated list of resources to include. Supported values: created_by_user, last_modified_by_user, status_page.

Returns:

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

    Maintenance data, response status code and response headers



687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
 
# File 'lib/datadog_api_client/v2/api/status_pages_api.rb', line 687

def get_maintenance_with_http_info(page_id, maintenance_id, opts = {})

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: StatusPagesAPI.get_maintenance ...'
  end
  # verify the required parameter 'page_id' is set
  if @api_client.config.client_side_validation && page_id.nil?
    fail ArgumentError, "Missing the required parameter 'page_id' when calling StatusPagesAPI.get_maintenance"
  end
  # verify the required parameter 'maintenance_id' is set
  if @api_client.config.client_side_validation && maintenance_id.nil?
    fail ArgumentError, "Missing the required parameter 'maintenance_id' when calling StatusPagesAPI.get_maintenance"
  end
  # resource path
  local_var_path = '/api/v2/statuspages/{page_id}/maintenances/{maintenance_id}'.sub('{page_id}', CGI.escape(page_id.to_s).gsub('%2F', '/')).sub('{maintenance_id}', CGI.escape(maintenance_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] || 'Maintenance'

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

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

#get_status_page(page_id, opts = {}) ⇒ Object

Get status page.

See Also:



745
746
747
748
 
# File 'lib/datadog_api_client/v2/api/status_pages_api.rb', line 745

def get_status_page(page_id, opts = {})
  data, _status_code, _headers = get_status_page_with_http_info(page_id, opts)
  data
end

#get_status_page_with_http_info(page_id, opts = {}) ⇒ Array<(StatusPage, Integer, Hash)>

Get status page.

Retrieves a specific status page by its ID.

Parameters:

  • page_id (UUID) —

    The ID of the status page.

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

    the optional parameters

Options Hash (opts):

  • :include (String) —

    Comma-separated list of resources to include. Supported values: created_by_user, last_modified_by_user.

Returns:

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

    StatusPage data, response status code and response headers



758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
 
# File 'lib/datadog_api_client/v2/api/status_pages_api.rb', line 758

def get_status_page_with_http_info(page_id, opts = {})

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

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

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

#list_components(page_id, opts = {}) ⇒ Object

List components.

See Also:



812
813
814
815
 
# File 'lib/datadog_api_client/v2/api/status_pages_api.rb', line 812

def list_components(page_id, opts = {})
  data, _status_code, _headers = list_components_with_http_info(page_id, opts)
  data
end

#list_components_with_http_info(page_id, opts = {}) ⇒ Array<(StatusPagesComponentArray, Integer, Hash)>

List components.

Lists all components for a status page.

Parameters:

  • page_id (UUID) —

    The ID of the status page.

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

    the optional parameters

Options Hash (opts):

  • :include (String) —

    Comma-separated list of resources to include. Supported values: created_by_user, last_modified_by_user, status_page, group.

Returns:

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

    StatusPagesComponentArray data, response status code and response headers



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

def list_components_with_http_info(page_id, opts = {})

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: StatusPagesAPI.list_components ...'
  end
  # verify the required parameter 'page_id' is set
  if @api_client.config.client_side_validation && page_id.nil?
    fail ArgumentError, "Missing the required parameter 'page_id' when calling StatusPagesAPI.list_components"
  end
  # resource path
  local_var_path = '/api/v2/statuspages/{page_id}/components'.sub('{page_id}', CGI.escape(page_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] || 'StatusPagesComponentArray'

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

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

#list_degradations(opts = {}) ⇒ Object

List degradations.

See Also:



879
880
881
882
 
# File 'lib/datadog_api_client/v2/api/status_pages_api.rb', line 879

def list_degradations(opts = {})
  data, _status_code, _headers = list_degradations_with_http_info(opts)
  data
end

#list_degradations_with_http_info(opts = {}) ⇒ Array<(DegradationArray, Integer, Hash)>

List degradations.

Lists all degradations for the organization. Optionally filter by status and page.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :filter_page_id (String) —

    Optional page id filter.

  • :page_offset (Integer) —

    Offset to use as the start of the page.

  • :page_limit (Integer) —

    The number of degradations to return per page.

  • :include (String) —

    Comma-separated list of resources to include. Supported values: created_by_user, last_modified_by_user, status_page.

  • :filter_status (String) —

    Optional degradation status filter. Supported values: investigating, identified, monitoring, resolved.

  • :sort (String) —

    Sort order. Prefix with ‘-’ for descending. Supported values: created_at, -created_at, modified_at, -modified_at.

Returns:

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

    DegradationArray data, response status code and response headers



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

def list_degradations_with_http_info(opts = {})

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: StatusPagesAPI.list_degradations ...'
  end
  # resource path
  local_var_path = '/api/v2/statuspages/degradations'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'filter[page_id]'] = opts[:'filter_page_id'] if !opts[:'filter_page_id'].nil?
  query_params[:'page[offset]'] = opts[:'page_offset'] if !opts[:'page_offset'].nil?
  query_params[:'page[limit]'] = opts[:'page_limit'] if !opts[:'page_limit'].nil?
  query_params[:'include'] = opts[:'include'] if !opts[:'include'].nil?
  query_params[:'filter[status]'] = opts[:'filter_status'] if !opts[:'filter_status'].nil?
  query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].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] || 'DegradationArray'

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

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

#list_maintenances(opts = {}) ⇒ Object

List maintenances.

See Also:



951
952
953
954
 
# File 'lib/datadog_api_client/v2/api/status_pages_api.rb', line 951

def list_maintenances(opts = {})
  data, _status_code, _headers = list_maintenances_with_http_info(opts)
  data
end

#list_maintenances_with_http_info(opts = {}) ⇒ Array<(MaintenanceArray, Integer, Hash)>

List maintenances.

Lists all maintenances for the organization. Optionally filter by status and page.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :filter_page_id (String) —

    Optional page id filter.

  • :page_offset (Integer) —

    Offset to use as the start of the page.

  • :page_limit (Integer) —

    The number of maintenances to return per page.

  • :include (String) —

    Comma-separated list of resources to include. Supported values: created_by_user, last_modified_by_user, status_page.

  • :filter_status (String) —

    Optional maintenance status filter. Supported values: scheduled, in_progress, completed.

  • :sort (String) —

    Sort order. Prefix with ‘-’ for descending. Supported values: created_at, -created_at, start_date, -start_date.

Returns:

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

    MaintenanceArray data, response status code and response headers



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

def list_maintenances_with_http_info(opts = {})

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: StatusPagesAPI.list_maintenances ...'
  end
  # resource path
  local_var_path = '/api/v2/statuspages/maintenances'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'filter[page_id]'] = opts[:'filter_page_id'] if !opts[:'filter_page_id'].nil?
  query_params[:'page[offset]'] = opts[:'page_offset'] if !opts[:'page_offset'].nil?
  query_params[:'page[limit]'] = opts[:'page_limit'] if !opts[:'page_limit'].nil?
  query_params[:'include'] = opts[:'include'] if !opts[:'include'].nil?
  query_params[:'filter[status]'] = opts[:'filter_status'] if !opts[:'filter_status'].nil?
  query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].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] || 'MaintenanceArray'

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

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

#list_status_pages(opts = {}) ⇒ Object

List status pages.

See Also:



1023
1024
1025
1026
 
# File 'lib/datadog_api_client/v2/api/status_pages_api.rb', line 1023

def list_status_pages(opts = {})
  data, _status_code, _headers = list_status_pages_with_http_info(opts)
  data
end

#list_status_pages_with_http_info(opts = {}) ⇒ Array<(StatusPageArray, Integer, Hash)>

List status pages.

Lists all status pages for the organization.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :page_offset (Integer) —

    Offset to use as the start of the page.

  • :page_limit (Integer) —

    The number of status pages to return per page.

  • :include (String) —

    Comma-separated list of resources to include. Supported values: created_by_user, last_modified_by_user.

Returns:

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

    StatusPageArray data, response status code and response headers



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
1078
1079
1080
1081
1082
1083
1084
 
# File 'lib/datadog_api_client/v2/api/status_pages_api.rb', line 1037

def list_status_pages_with_http_info(opts = {})

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: StatusPagesAPI.list_status_pages ...'
  end
  # resource path
  local_var_path = '/api/v2/statuspages'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'page[offset]'] = opts[:'page_offset'] if !opts[:'page_offset'].nil?
  query_params[:'page[limit]'] = opts[:'page_limit'] if !opts[:'page_limit'].nil?
  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] || 'StatusPageArray'

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

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

#update_component(page_id, component_id, body, opts = {}) ⇒ Object

Update component.

See Also:



1089
1090
1091
1092
 
# File 'lib/datadog_api_client/v2/api/status_pages_api.rb', line 1089

def update_component(page_id, component_id, body, opts = {})
  data, _status_code, _headers = update_component_with_http_info(page_id, component_id, body, opts)
  data
end

#update_component_with_http_info(page_id, component_id, body, opts = {}) ⇒ Array<(StatusPagesComponent, Integer, Hash)>

Update component.

Updates an existing component’s attributes.

Parameters:

  • page_id (UUID) —

    The ID of the status page.

  • component_id (UUID) —

    The ID of the component.

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

    the optional parameters

Options Hash (opts):

  • :include (String) —

    Comma-separated list of resources to include. Supported values: created_by_user, last_modified_by_user, status_page, group.

Returns:

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

    StatusPagesComponent data, response status code and response headers



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
1156
1157
1158
1159
1160
1161
1162
1163
 
# File 'lib/datadog_api_client/v2/api/status_pages_api.rb', line 1104

def update_component_with_http_info(page_id, component_id, body, opts = {})

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: StatusPagesAPI.update_component ...'
  end
  # verify the required parameter 'page_id' is set
  if @api_client.config.client_side_validation && page_id.nil?
    fail ArgumentError, "Missing the required parameter 'page_id' when calling StatusPagesAPI.update_component"
  end
  # verify the required parameter 'component_id' is set
  if @api_client.config.client_side_validation && component_id.nil?
    fail ArgumentError, "Missing the required parameter 'component_id' when calling StatusPagesAPI.update_component"
  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 StatusPagesAPI.update_component"
  end
  # resource path
  local_var_path = '/api/v2/statuspages/{page_id}/components/{component_id}'.sub('{page_id}', CGI.escape(page_id.to_s).gsub('%2F', '/')).sub('{component_id}', CGI.escape(component_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'])
  # 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] || 'StatusPagesComponent'

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

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

#update_degradation(page_id, degradation_id, body, opts = {}) ⇒ Object

Update degradation.

See Also:



1168
1169
1170
1171
 
# File 'lib/datadog_api_client/v2/api/status_pages_api.rb', line 1168

def update_degradation(page_id, degradation_id, body, opts = {})
  data, _status_code, _headers = update_degradation_with_http_info(page_id, degradation_id, body, opts)
  data
end

#update_degradation_with_http_info(page_id, degradation_id, body, opts = {}) ⇒ Array<(Degradation, Integer, Hash)>

Update degradation.

Updates an existing degradation’s attributes.

Parameters:

  • page_id (UUID) —

    The ID of the status page.

  • degradation_id (UUID) —

    The ID of the degradation.

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

    the optional parameters

Options Hash (opts):

  • :notify_subscribers (Boolean) —

    Whether to notify page subscribers of the degradation.

  • :include (String) —

    Comma-separated list of resources to include. Supported values: created_by_user, last_modified_by_user, status_page.

Returns:

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

    Degradation data, response status code and response headers



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
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
 
# File 'lib/datadog_api_client/v2/api/status_pages_api.rb', line 1184

def update_degradation_with_http_info(page_id, degradation_id, body, opts = {})

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: StatusPagesAPI.update_degradation ...'
  end
  # verify the required parameter 'page_id' is set
  if @api_client.config.client_side_validation && page_id.nil?
    fail ArgumentError, "Missing the required parameter 'page_id' when calling StatusPagesAPI.update_degradation"
  end
  # verify the required parameter 'degradation_id' is set
  if @api_client.config.client_side_validation && degradation_id.nil?
    fail ArgumentError, "Missing the required parameter 'degradation_id' when calling StatusPagesAPI.update_degradation"
  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 StatusPagesAPI.update_degradation"
  end
  # resource path
  local_var_path = '/api/v2/statuspages/{page_id}/degradations/{degradation_id}'.sub('{page_id}', CGI.escape(page_id.to_s).gsub('%2F', '/')).sub('{degradation_id}', CGI.escape(degradation_id.to_s).gsub('%2F', '/'))

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

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

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

#update_maintenance(page_id, maintenance_id, body, opts = {}) ⇒ Object

Update maintenance.

See Also:



1249
1250
1251
1252
 
# File 'lib/datadog_api_client/v2/api/status_pages_api.rb', line 1249

def update_maintenance(page_id, maintenance_id, body, opts = {})
  data, _status_code, _headers = update_maintenance_with_http_info(page_id, maintenance_id, body, opts)
  data
end

#update_maintenance_with_http_info(page_id, maintenance_id, body, opts = {}) ⇒ Array<(Maintenance, Integer, Hash)>

Update maintenance.

Updates an existing maintenance’s attributes.

Parameters:

  • page_id (UUID) —

    The ID of the status page.

  • maintenance_id (UUID) —

    The ID of the maintenance.

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

    the optional parameters

Options Hash (opts):

  • :notify_subscribers (Boolean) —

    Whether to notify page subscribers of the maintenance.

  • :include (String) —

    Comma-separated list of resources to include. Supported values: created_by_user, last_modified_by_user, status_page.

Returns:

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

    Maintenance data, response status code and response headers



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
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
 
# File 'lib/datadog_api_client/v2/api/status_pages_api.rb', line 1265

def update_maintenance_with_http_info(page_id, maintenance_id, body, opts = {})

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: StatusPagesAPI.update_maintenance ...'
  end
  # verify the required parameter 'page_id' is set
  if @api_client.config.client_side_validation && page_id.nil?
    fail ArgumentError, "Missing the required parameter 'page_id' when calling StatusPagesAPI.update_maintenance"
  end
  # verify the required parameter 'maintenance_id' is set
  if @api_client.config.client_side_validation && maintenance_id.nil?
    fail ArgumentError, "Missing the required parameter 'maintenance_id' when calling StatusPagesAPI.update_maintenance"
  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 StatusPagesAPI.update_maintenance"
  end
  # resource path
  local_var_path = '/api/v2/statuspages/{page_id}/maintenances/{maintenance_id}'.sub('{page_id}', CGI.escape(page_id.to_s).gsub('%2F', '/')).sub('{maintenance_id}', CGI.escape(maintenance_id.to_s).gsub('%2F', '/'))

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

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

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

#update_status_page(page_id, body, opts = {}) ⇒ Object

Update status page.

See Also:



1330
1331
1332
1333
 
# File 'lib/datadog_api_client/v2/api/status_pages_api.rb', line 1330

def update_status_page(page_id, body, opts = {})
  data, _status_code, _headers = update_status_page_with_http_info(page_id, body, opts)
  data
end

#update_status_page_with_http_info(page_id, body, opts = {}) ⇒ Array<(StatusPage, Integer, Hash)>

Update status page.

Updates an existing status page’s attributes.

Parameters:

  • page_id (UUID) —

    The ID of the status page.

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

    the optional parameters

Options Hash (opts):

  • :delete_subscribers (Boolean) —

    Whether to delete existing subscribers when updating a status page’s type.

  • :include (String) —

    Comma-separated list of resources to include. Supported values: created_by_user, last_modified_by_user.

Returns:

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

    StatusPage data, response status code and response headers



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
1393
1394
1395
1396
1397
1398
1399
1400
1401
 
# File 'lib/datadog_api_client/v2/api/status_pages_api.rb', line 1345

def update_status_page_with_http_info(page_id, body, opts = {})

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: StatusPagesAPI.update_status_page ...'
  end
  # verify the required parameter 'page_id' is set
  if @api_client.config.client_side_validation && page_id.nil?
    fail ArgumentError, "Missing the required parameter 'page_id' when calling StatusPagesAPI.update_status_page"
  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 StatusPagesAPI.update_status_page"
  end
  # resource path
  local_var_path = '/api/v2/statuspages/{page_id}'.sub('{page_id}', CGI.escape(page_id.to_s).gsub('%2F', '/'))

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

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

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