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_backfilled_degradation(page_id, body, opts = {}) ⇒ Object

Create backfilled degradation.

See Also:



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

def create_backfilled_degradation(page_id, body, opts = {})
  data, _status_code, _headers = create_backfilled_degradation_with_http_info(page_id, body, opts)
  data
end

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

Create backfilled degradation.

Creates a backfilled degradation with predefined updates.

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



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_backfilled_degradation_with_http_info(page_id, body, opts = {})

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: StatusPagesAPI.create_backfilled_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_backfilled_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_backfilled_degradation"
  end
  # resource path
  local_var_path = '/api/v2/statuspages/{page_id}/degradations/backfill'.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] || 'Degradation'

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

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

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

Create backfilled maintenance.

See Also:



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

def create_backfilled_maintenance(page_id, body, opts = {})
  data, _status_code, _headers = create_backfilled_maintenance_with_http_info(page_id, body, opts)
  data
end

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

Create backfilled maintenance.

Creates a backfilled maintenance with predefined updates.

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



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

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

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: StatusPagesAPI.create_backfilled_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_backfilled_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_backfilled_maintenance"
  end
  # resource path
  local_var_path = '/api/v2/statuspages/{page_id}/maintenances/backfill'.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] || 'Maintenance'

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

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

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

Create component.

See Also:



177
178
179
180
 
# File 'lib/datadog_api_client/v2/api/status_pages_api.rb', line 177

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



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

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:



251
252
253
254
 
# File 'lib/datadog_api_client/v2/api/status_pages_api.rb', line 251

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

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

Create degradation template.

See Also:



327
328
329
330
 
# File 'lib/datadog_api_client/v2/api/status_pages_api.rb', line 327

def create_degradation_template(page_id, body, opts = {})
  data, _status_code, _headers = create_degradation_template_with_http_info(page_id, body, opts)
  data
end

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

Create degradation template.

Creates a new degradation template.

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<(DegradationTemplate, Integer, Hash)>) —

    DegradationTemplate data, response status code and response headers



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
390
391
392
393
394
395
396
 
# File 'lib/datadog_api_client/v2/api/status_pages_api.rb', line 341

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

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: StatusPagesAPI.create_degradation_template ...'
  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_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 StatusPagesAPI.create_degradation_template"
  end
  # resource path
  local_var_path = '/api/v2/statuspages/{page_id}/degradation_templates'.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] || 'DegradationTemplate'

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

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



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

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:



401
402
403
404
 
# File 'lib/datadog_api_client/v2/api/status_pages_api.rb', line 401

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

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

Create maintenance template.

See Also:



477
478
479
480
 
# File 'lib/datadog_api_client/v2/api/status_pages_api.rb', line 477

def create_maintenance_template(page_id, body, opts = {})
  data, _status_code, _headers = create_maintenance_template_with_http_info(page_id, body, opts)
  data
end

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

Create maintenance template.

Creates a new maintenance template.

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<(MaintenanceTemplate, Integer, Hash)>) —

    MaintenanceTemplate data, response status code and response headers



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

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

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: StatusPagesAPI.create_maintenance_template ...'
  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_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 StatusPagesAPI.create_maintenance_template"
  end
  # resource path
  local_var_path = '/api/v2/statuspages/{page_id}/maintenance_templates'.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] || 'MaintenanceTemplate'

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

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



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
463
464
465
466
467
468
469
470
471
472
 
# File 'lib/datadog_api_client/v2/api/status_pages_api.rb', line 416

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:



551
552
553
554
 
# File 'lib/datadog_api_client/v2/api/status_pages_api.rb', line 551

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 in an unpublished state. Use the dedicated publish status page endpoint to publish the page after creation.

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



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
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
 
# File 'lib/datadog_api_client/v2/api/status_pages_api.rb', line 564

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:



620
621
622
623
 
# File 'lib/datadog_api_client/v2/api/status_pages_api.rb', line 620

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



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
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
 
# File 'lib/datadog_api_client/v2/api/status_pages_api.rb', line 633

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:



690
691
692
693
 
# File 'lib/datadog_api_client/v2/api/status_pages_api.rb', line 690

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

#delete_degradation_template(page_id, template_id, opts = {}) ⇒ Object

Delete degradation template.

See Also:



760
761
762
763
 
# File 'lib/datadog_api_client/v2/api/status_pages_api.rb', line 760

def delete_degradation_template(page_id, template_id, opts = {})
  delete_degradation_template_with_http_info(page_id, template_id, opts)
  nil
end

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

Delete degradation template.

Deletes a degradation template by its ID (soft delete).

Parameters:

  • page_id (UUID) —

    The ID of the status page.

  • template_id (UUID) —

    The ID of the degradation or maintenance template.

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



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

def delete_degradation_template_with_http_info(page_id, template_id, opts = {})

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: StatusPagesAPI.delete_degradation_template ...'
  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_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 StatusPagesAPI.delete_degradation_template"
  end
  # resource path
  local_var_path = '/api/v2/statuspages/{page_id}/degradation_templates/{template_id}'.sub('{page_id}', CGI.escape(page_id.to_s).gsub('%2F', '/')).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_degradation_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: StatusPagesAPI#delete_degradation_template\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
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



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
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
 
# File 'lib/datadog_api_client/v2/api/status_pages_api.rb', line 703

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_maintenance_template(page_id, template_id, opts = {}) ⇒ Object

Delete maintenance template.

See Also:



830
831
832
833
 
# File 'lib/datadog_api_client/v2/api/status_pages_api.rb', line 830

def delete_maintenance_template(page_id, template_id, opts = {})
  delete_maintenance_template_with_http_info(page_id, template_id, opts)
  nil
end

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

Delete maintenance template.

Deletes a maintenance template by its ID (soft delete).

Parameters:

  • page_id (UUID) —

    The ID of the status page.

  • template_id (UUID) —

    The ID of the degradation or maintenance template.

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
 
# File 'lib/datadog_api_client/v2/api/status_pages_api.rb', line 843

def delete_maintenance_template_with_http_info(page_id, template_id, opts = {})

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: StatusPagesAPI.delete_maintenance_template ...'
  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_maintenance_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 StatusPagesAPI.delete_maintenance_template"
  end
  # resource path
  local_var_path = '/api/v2/statuspages/{page_id}/maintenance_templates/{template_id}'.sub('{page_id}', CGI.escape(page_id.to_s).gsub('%2F', '/')).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_maintenance_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: StatusPagesAPI#delete_maintenance_template\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:



900
901
902
903
 
# File 'lib/datadog_api_client/v2/api/status_pages_api.rb', line 900

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



912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
 
# File 'lib/datadog_api_client/v2/api/status_pages_api.rb', line 912

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

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

Edit degradation update.

See Also:



965
966
967
968
 
# File 'lib/datadog_api_client/v2/api/status_pages_api.rb', line 965

def edit_degradation_update(degradation_id, page_id, update_id, body, opts = {})
  data, _status_code, _headers = edit_degradation_update_with_http_info(degradation_id, page_id, update_id, body, opts)
  data
end

#edit_degradation_update_with_http_info(degradation_id, page_id, update_id, body, opts = {}) ⇒ Array<(DegradationUpdate, Integer, Hash)>

Edit degradation update.

Edits a specific degradation update.

Parameters:

  • degradation_id (UUID) —

    The ID of the degradation.

  • page_id (UUID) —

    The ID of the status page.

  • update_id (UUID) —

    The ID of the degradation update.

  • body (PatchDegradationUpdateRequest)
  • 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, degradation, status_page.

Returns:

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

    DegradationUpdate data, response status code and response headers



981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
 
# File 'lib/datadog_api_client/v2/api/status_pages_api.rb', line 981

def edit_degradation_update_with_http_info(degradation_id, page_id, update_id, body, opts = {})

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

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

  new_options = opts.merge(
    :operation => :edit_degradation_update,
    :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#edit_degradation_update\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:



1049
1050
1051
1052
 
# File 'lib/datadog_api_client/v2/api/status_pages_api.rb', line 1049

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



1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
 
# File 'lib/datadog_api_client/v2/api/status_pages_api.rb', line 1063

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:



1121
1122
1123
1124
 
# File 'lib/datadog_api_client/v2/api/status_pages_api.rb', line 1121

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_template(page_id, template_id, opts = {}) ⇒ Object

Get degradation template.

See Also:



1193
1194
1195
1196
 
# File 'lib/datadog_api_client/v2/api/status_pages_api.rb', line 1193

def get_degradation_template(page_id, template_id, opts = {})
  data, _status_code, _headers = get_degradation_template_with_http_info(page_id, template_id, opts)
  data
end

#get_degradation_template_with_http_info(page_id, template_id, opts = {}) ⇒ Array<(DegradationTemplate, Integer, Hash)>

Get degradation template.

Retrieves a specific degradation template by its ID.

Parameters:

  • page_id (UUID) —

    The ID of the status page.

  • template_id (UUID) —

    The ID of the degradation or maintenance template.

  • 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<(DegradationTemplate, Integer, Hash)>) —

    DegradationTemplate data, response status code and response headers



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
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
 
# File 'lib/datadog_api_client/v2/api/status_pages_api.rb', line 1207

def get_degradation_template_with_http_info(page_id, template_id, opts = {})

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: StatusPagesAPI.get_degradation_template ...'
  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_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 StatusPagesAPI.get_degradation_template"
  end
  # resource path
  local_var_path = '/api/v2/statuspages/{page_id}/degradation_templates/{template_id}'.sub('{page_id}', CGI.escape(page_id.to_s).gsub('%2F', '/')).sub('{template_id}', CGI.escape(template_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] || 'DegradationTemplate'

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

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



1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
 
# File 'lib/datadog_api_client/v2/api/status_pages_api.rb', line 1135

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:



1265
1266
1267
1268
 
# File 'lib/datadog_api_client/v2/api/status_pages_api.rb', line 1265

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_template(page_id, template_id, opts = {}) ⇒ Object

Get maintenance template.

See Also:



1337
1338
1339
1340
 
# File 'lib/datadog_api_client/v2/api/status_pages_api.rb', line 1337

def get_maintenance_template(page_id, template_id, opts = {})
  data, _status_code, _headers = get_maintenance_template_with_http_info(page_id, template_id, opts)
  data
end

#get_maintenance_template_with_http_info(page_id, template_id, opts = {}) ⇒ Array<(MaintenanceTemplate, Integer, Hash)>

Get maintenance template.

Retrieves a specific maintenance template by its ID.

Parameters:

  • page_id (UUID) —

    The ID of the status page.

  • template_id (UUID) —

    The ID of the degradation or maintenance template.

  • 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<(MaintenanceTemplate, Integer, Hash)>) —

    MaintenanceTemplate data, response status code and response headers



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

def get_maintenance_template_with_http_info(page_id, template_id, opts = {})

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: StatusPagesAPI.get_maintenance_template ...'
  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_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 StatusPagesAPI.get_maintenance_template"
  end
  # resource path
  local_var_path = '/api/v2/statuspages/{page_id}/maintenance_templates/{template_id}'.sub('{page_id}', CGI.escape(page_id.to_s).gsub('%2F', '/')).sub('{template_id}', CGI.escape(template_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] || 'MaintenanceTemplate'

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

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



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
1326
1327
1328
1329
1330
1331
1332
 
# File 'lib/datadog_api_client/v2/api/status_pages_api.rb', line 1279

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:



1409
1410
1411
1412
 
# File 'lib/datadog_api_client/v2/api/status_pages_api.rb', line 1409

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



1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
 
# File 'lib/datadog_api_client/v2/api/status_pages_api.rb', line 1422

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:



1476
1477
1478
1479
 
# File 'lib/datadog_api_client/v2/api/status_pages_api.rb', line 1476

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



1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
 
# File 'lib/datadog_api_client/v2/api/status_pages_api.rb', line 1489

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_degradation_templates(page_id, opts = {}) ⇒ Object

List degradation templates.

See Also:



1617
1618
1619
1620
 
# File 'lib/datadog_api_client/v2/api/status_pages_api.rb', line 1617

def list_degradation_templates(page_id, opts = {})
  data, _status_code, _headers = list_degradation_templates_with_http_info(page_id, opts)
  data
end

#list_degradation_templates_with_http_info(page_id, opts = {}) ⇒ Array<(DegradationTemplateArray, Integer, Hash)>

List degradation templates.

Lists all degradation templates 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.

Returns:

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

    DegradationTemplateArray data, response status code and response headers



1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
 
# File 'lib/datadog_api_client/v2/api/status_pages_api.rb', line 1630

def list_degradation_templates_with_http_info(page_id, opts = {})

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: StatusPagesAPI.list_degradation_templates ...'
  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_degradation_templates"
  end
  # resource path
  local_var_path = '/api/v2/statuspages/{page_id}/degradation_templates'.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] || 'DegradationTemplateArray'

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

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

#list_degradations(opts = {}) ⇒ Object

List degradations.

See Also:



1543
1544
1545
1546
 
# File 'lib/datadog_api_client/v2/api/status_pages_api.rb', line 1543

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.

  • :filter_source_id (String) —

    Optional source ID filter. Returns only degradations whose source matches this ID (for example, an incident ID).

Returns:

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

    DegradationArray data, response status code and response headers



1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
 
# File 'lib/datadog_api_client/v2/api/status_pages_api.rb', line 1561

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?
  query_params[:'filter[source_id]'] = opts[:'filter_source_id'] if !opts[:'filter_source_id'].nil?

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

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

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

  # return_type
  return_type = opts[:debug_return_type] || '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_maintenance_templates(page_id, opts = {}) ⇒ Object

List maintenance templates.

See Also:



1756
1757
1758
1759
 
# File 'lib/datadog_api_client/v2/api/status_pages_api.rb', line 1756

def list_maintenance_templates(page_id, opts = {})
  data, _status_code, _headers = list_maintenance_templates_with_http_info(page_id, opts)
  data
end

#list_maintenance_templates_with_http_info(page_id, opts = {}) ⇒ Array<(MaintenanceTemplateArray, Integer, Hash)>

List maintenance templates.

Lists all maintenance templates 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.

Returns:

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

    MaintenanceTemplateArray data, response status code and response headers



1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
 
# File 'lib/datadog_api_client/v2/api/status_pages_api.rb', line 1769

def list_maintenance_templates_with_http_info(page_id, opts = {})

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: StatusPagesAPI.list_maintenance_templates ...'
  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_maintenance_templates"
  end
  # resource path
  local_var_path = '/api/v2/statuspages/{page_id}/maintenance_templates'.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] || 'MaintenanceTemplateArray'

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

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

#list_maintenances(opts = {}) ⇒ Object

List maintenances.

See Also:



1684
1685
1686
1687
 
# File 'lib/datadog_api_client/v2/api/status_pages_api.rb', line 1684

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



1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
 
# File 'lib/datadog_api_client/v2/api/status_pages_api.rb', line 1701

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:



1823
1824
1825
1826
 
# File 'lib/datadog_api_client/v2/api/status_pages_api.rb', line 1823

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.

  • :filter_domain_prefix (String) —

    Filter status pages by exact domain prefix match. Returns at most one result.

  • :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



1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
 
# File 'lib/datadog_api_client/v2/api/status_pages_api.rb', line 1838

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[:'filter[domain_prefix]'] = opts[:'filter_domain_prefix'] if !opts[:'filter_domain_prefix'].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

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

Edit maintenance update.

See Also:



1891
1892
1893
1894
 
# File 'lib/datadog_api_client/v2/api/status_pages_api.rb', line 1891

def patch_maintenance_update(page_id, maintenance_id, update_id, body, opts = {})
  data, _status_code, _headers = patch_maintenance_update_with_http_info(page_id, maintenance_id, update_id, body, opts)
  data
end

#patch_maintenance_update_with_http_info(page_id, maintenance_id, update_id, body, opts = {}) ⇒ Array<(MaintenanceUpdate, Integer, Hash)>

Edit maintenance update.

Edits the message of a specific maintenance update. Editing is allowed regardless of the parent maintenance's status, including completed and canceled maintenances.

Parameters:

  • page_id (UUID) —

    The ID of the status page.

  • maintenance_id (UUID) —

    The ID of the maintenance.

  • update_id (UUID) —

    The ID of the maintenance update.

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

    the optional parameters

Returns:

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

    MaintenanceUpdate data, response status code and response headers



1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
1930
1931
1932
1933
1934
1935
1936
1937
1938
1939
1940
1941
1942
1943
1944
1945
1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
 
# File 'lib/datadog_api_client/v2/api/status_pages_api.rb', line 1906

def patch_maintenance_update_with_http_info(page_id, maintenance_id, update_id, body, opts = {})

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

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

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

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

Publish status page.

See Also:



1973
1974
1975
1976
 
# File 'lib/datadog_api_client/v2/api/status_pages_api.rb', line 1973

def publish_status_page(page_id, opts = {})
  publish_status_page_with_http_info(page_id, opts)
  nil
end

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

Publish status page.

Publishes a status page. For pages of type public, makes the status page available on the public internet and requires the status_pages_public_page_publish permission. For pages of type internal, makes the status page available under the status-pages/$domain_prefix/view route within the Datadog organization and requires the status_pages_internal_page_publish permission.

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



1985
1986
1987
1988
1989
1990
1991
1992
1993
1994
1995
1996
1997
1998
1999
2000
2001
2002
2003
2004
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
2026
2027
2028
2029
2030
2031
2032
2033
 
# File 'lib/datadog_api_client/v2/api/status_pages_api.rb', line 1985

def publish_status_page_with_http_info(page_id, opts = {})

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: StatusPagesAPI.publish_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.publish_status_page"
  end
  # resource path
  local_var_path = '/api/v2/statuspages/{page_id}/publish'.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 => :publish_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#publish_status_page\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

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

Soft delete degradation update.

See Also:



2038
2039
2040
2041
 
# File 'lib/datadog_api_client/v2/api/status_pages_api.rb', line 2038

def soft_delete_degradation_update(degradation_id, page_id, update_id, opts = {})
  soft_delete_degradation_update_with_http_info(degradation_id, page_id, update_id, opts)
  nil
end

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

Soft delete degradation update.

Soft-deletes a degradation update.

Parameters:

  • degradation_id (UUID) —

    The ID of the degradation.

  • page_id (UUID) —

    The ID of the status page.

  • update_id (UUID) —

    The ID of the degradation update.

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



2052
2053
2054
2055
2056
2057
2058
2059
2060
2061
2062
2063
2064
2065
2066
2067
2068
2069
2070
2071
2072
2073
2074
2075
2076
2077
2078
2079
2080
2081
2082
2083
2084
2085
2086
2087
2088
2089
2090
2091
2092
2093
2094
2095
2096
2097
2098
2099
2100
2101
2102
2103
2104
2105
2106
2107
2108
 
# File 'lib/datadog_api_client/v2/api/status_pages_api.rb', line 2052

def soft_delete_degradation_update_with_http_info(degradation_id, page_id, update_id, opts = {})

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

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

Unpublish status page.

See Also:



2113
2114
2115
2116
 
# File 'lib/datadog_api_client/v2/api/status_pages_api.rb', line 2113

def unpublish_status_page(page_id, opts = {})
  unpublish_status_page_with_http_info(page_id, opts)
  nil
end

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

Unpublish status page.

Unpublishes a status page. For pages of type public, removes the status page from the public internet and requires the status_pages_public_page_publish permission. For pages of type internal, removes the status-pages/$domain_prefix/view route from the Datadog organization and requires the status_pages_internal_page_publish permission.

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



2125
2126
2127
2128
2129
2130
2131
2132
2133
2134
2135
2136
2137
2138
2139
2140
2141
2142
2143
2144
2145
2146
2147
2148
2149
2150
2151
2152
2153
2154
2155
2156
2157
2158
2159
2160
2161
2162
2163
2164
2165
2166
2167
2168
2169
2170
2171
2172
2173
 
# File 'lib/datadog_api_client/v2/api/status_pages_api.rb', line 2125

def unpublish_status_page_with_http_info(page_id, opts = {})

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



2178
2179
2180
2181
 
# File 'lib/datadog_api_client/v2/api/status_pages_api.rb', line 2178

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



2193
2194
2195
2196
2197
2198
2199
2200
2201
2202
2203
2204
2205
2206
2207
2208
2209
2210
2211
2212
2213
2214
2215
2216
2217
2218
2219
2220
2221
2222
2223
2224
2225
2226
2227
2228
2229
2230
2231
2232
2233
2234
2235
2236
2237
2238
2239
2240
2241
2242
2243
2244
2245
2246
2247
2248
2249
2250
2251
2252
 
# File 'lib/datadog_api_client/v2/api/status_pages_api.rb', line 2193

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:



2257
2258
2259
2260
 
# File 'lib/datadog_api_client/v2/api/status_pages_api.rb', line 2257

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_template(template_id, page_id, body, opts = {}) ⇒ Object

Update degradation template.

See Also:



2338
2339
2340
2341
 
# File 'lib/datadog_api_client/v2/api/status_pages_api.rb', line 2338

def update_degradation_template(template_id, page_id, body, opts = {})
  data, _status_code, _headers = update_degradation_template_with_http_info(template_id, page_id, body, opts)
  data
end

#update_degradation_template_with_http_info(template_id, page_id, body, opts = {}) ⇒ Array<(DegradationTemplate, Integer, Hash)>

Update degradation template.

Updates an existing degradation template's attributes.

Parameters:

  • template_id (UUID) —

    The ID of the degradation or maintenance template.

  • page_id (UUID) —

    The ID of the status page.

  • body (PatchDegradationTemplateRequest)
  • 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<(DegradationTemplate, Integer, Hash)>) —

    DegradationTemplate data, response status code and response headers



2353
2354
2355
2356
2357
2358
2359
2360
2361
2362
2363
2364
2365
2366
2367
2368
2369
2370
2371
2372
2373
2374
2375
2376
2377
2378
2379
2380
2381
2382
2383
2384
2385
2386
2387
2388
2389
2390
2391
2392
2393
2394
2395
2396
2397
2398
2399
2400
2401
2402
2403
2404
2405
2406
2407
2408
2409
2410
2411
2412
 
# File 'lib/datadog_api_client/v2/api/status_pages_api.rb', line 2353

def update_degradation_template_with_http_info(template_id, page_id, body, opts = {})

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: StatusPagesAPI.update_degradation_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 StatusPagesAPI.update_degradation_template"
  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_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 StatusPagesAPI.update_degradation_template"
  end
  # resource path
  local_var_path = '/api/v2/statuspages/{page_id}/degradation_templates/{template_id}'.sub('{template_id}', CGI.escape(template_id.to_s).gsub('%2F', '/')).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] || 'DegradationTemplate'

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

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



2273
2274
2275
2276
2277
2278
2279
2280
2281
2282
2283
2284
2285
2286
2287
2288
2289
2290
2291
2292
2293
2294
2295
2296
2297
2298
2299
2300
2301
2302
2303
2304
2305
2306
2307
2308
2309
2310
2311
2312
2313
2314
2315
2316
2317
2318
2319
2320
2321
2322
2323
2324
2325
2326
2327
2328
2329
2330
2331
2332
2333
 
# File 'lib/datadog_api_client/v2/api/status_pages_api.rb', line 2273

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:



2417
2418
2419
2420
 
# File 'lib/datadog_api_client/v2/api/status_pages_api.rb', line 2417

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_template(page_id, template_id, body, opts = {}) ⇒ Object

Update maintenance template.

See Also:



2498
2499
2500
2501
 
# File 'lib/datadog_api_client/v2/api/status_pages_api.rb', line 2498

def update_maintenance_template(page_id, template_id, body, opts = {})
  data, _status_code, _headers = update_maintenance_template_with_http_info(page_id, template_id, body, opts)
  data
end

#update_maintenance_template_with_http_info(page_id, template_id, body, opts = {}) ⇒ Array<(MaintenanceTemplate, Integer, Hash)>

Update maintenance template.

Updates an existing maintenance template's attributes.

Parameters:

  • page_id (UUID) —

    The ID of the status page.

  • template_id (UUID) —

    The ID of the degradation or maintenance template.

  • body (PatchMaintenanceTemplateRequest)
  • 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<(MaintenanceTemplate, Integer, Hash)>) —

    MaintenanceTemplate data, response status code and response headers



2513
2514
2515
2516
2517
2518
2519
2520
2521
2522
2523
2524
2525
2526
2527
2528
2529
2530
2531
2532
2533
2534
2535
2536
2537
2538
2539
2540
2541
2542
2543
2544
2545
2546
2547
2548
2549
2550
2551
2552
2553
2554
2555
2556
2557
2558
2559
2560
2561
2562
2563
2564
2565
2566
2567
2568
2569
2570
2571
2572
 
# File 'lib/datadog_api_client/v2/api/status_pages_api.rb', line 2513

def update_maintenance_template_with_http_info(page_id, template_id, body, opts = {})

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: StatusPagesAPI.update_maintenance_template ...'
  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_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 StatusPagesAPI.update_maintenance_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 StatusPagesAPI.update_maintenance_template"
  end
  # resource path
  local_var_path = '/api/v2/statuspages/{page_id}/maintenance_templates/{template_id}'.sub('{page_id}', CGI.escape(page_id.to_s).gsub('%2F', '/')).sub('{template_id}', CGI.escape(template_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] || 'MaintenanceTemplate'

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

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



2433
2434
2435
2436
2437
2438
2439
2440
2441
2442
2443
2444
2445
2446
2447
2448
2449
2450
2451
2452
2453
2454
2455
2456
2457
2458
2459
2460
2461
2462
2463
2464
2465
2466
2467
2468
2469
2470
2471
2472
2473
2474
2475
2476
2477
2478
2479
2480
2481
2482
2483
2484
2485
2486
2487
2488
2489
2490
2491
2492
2493
 
# File 'lib/datadog_api_client/v2/api/status_pages_api.rb', line 2433

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:



2577
2578
2579
2580
 
# File 'lib/datadog_api_client/v2/api/status_pages_api.rb', line 2577

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. To publish and unpublish status pages, use the dedicated publish and unpublish status page endpoints.

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



2592
2593
2594
2595
2596
2597
2598
2599
2600
2601
2602
2603
2604
2605
2606
2607
2608
2609
2610
2611
2612
2613
2614
2615
2616
2617
2618
2619
2620
2621
2622
2623
2624
2625
2626
2627
2628
2629
2630
2631
2632
2633
2634
2635
2636
2637
2638
2639
2640
2641
2642
2643
2644
2645
2646
2647
2648
 
# File 'lib/datadog_api_client/v2/api/status_pages_api.rb', line 2592

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