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



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

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

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

Schedule maintenance.

Schedules a new maintenance.

Parameters:

  • page_id (UUID) —

    The ID of the status page.

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

    the optional parameters

Options Hash (opts):

  • :notify_subscribers (Boolean) —

    Whether to notify page subscribers of the maintenance.

  • :include (String) —

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

Returns:

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

    Maintenance data, response status code and response headers



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

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:



403
404
405
406
 
# File 'lib/datadog_api_client/v2/api/status_pages_api.rb', line 403

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](#publish-status-page) 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



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

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:



472
473
474
475
 
# File 'lib/datadog_api_client/v2/api/status_pages_api.rb', line 472

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



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

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:



542
543
544
545
 
# File 'lib/datadog_api_client/v2/api/status_pages_api.rb', line 542

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

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

Delete degradation.

Deletes a degradation by its ID.

Parameters:

  • page_id (UUID) —

    The ID of the status page.

  • degradation_id (UUID) —

    The ID of the degradation.

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
 
# File 'lib/datadog_api_client/v2/api/status_pages_api.rb', line 555

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

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

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

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

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

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

  # return_type
  return_type = opts[:debug_return_type]

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

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

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

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

Delete status page.

See Also:



612
613
614
615
 
# File 'lib/datadog_api_client/v2/api/status_pages_api.rb', line 612

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



624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
 
# File 'lib/datadog_api_client/v2/api/status_pages_api.rb', line 624

def delete_status_page_with_http_info(page_id, opts = {})

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

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

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

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

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

  # return_type
  return_type = opts[:debug_return_type]

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

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

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

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

Get component.

See Also:



677
678
679
680
 
# File 'lib/datadog_api_client/v2/api/status_pages_api.rb', line 677

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



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

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:



749
750
751
752
 
# File 'lib/datadog_api_client/v2/api/status_pages_api.rb', line 749

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

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

Get degradation.

Retrieves a specific degradation by its ID.

Parameters:

  • page_id (UUID) —

    The ID of the status page.

  • degradation_id (UUID) —

    The ID of the degradation.

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

    the optional parameters

Options Hash (opts):

  • :include (String) —

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

Returns:

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

    Degradation data, response status code and response headers



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

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:



821
822
823
824
 
# File 'lib/datadog_api_client/v2/api/status_pages_api.rb', line 821

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

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

Get maintenance.

Retrieves a specific maintenance by its ID.

Parameters:

  • page_id (UUID) —

    The ID of the status page.

  • maintenance_id (UUID) —

    The ID of the maintenance.

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

    the optional parameters

Options Hash (opts):

  • :include (String) —

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

Returns:

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

    Maintenance data, response status code and response headers



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

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:



893
894
895
896
 
# File 'lib/datadog_api_client/v2/api/status_pages_api.rb', line 893

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



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

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:



960
961
962
963
 
# File 'lib/datadog_api_client/v2/api/status_pages_api.rb', line 960

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



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

def list_components_with_http_info(page_id, opts = {})

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

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'include'] = opts[:'include'] if !opts[:'include'].nil?

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

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

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

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

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

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

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

#list_degradations(opts = {}) ⇒ Object

List degradations.

See Also:



1027
1028
1029
1030
 
# File 'lib/datadog_api_client/v2/api/status_pages_api.rb', line 1027

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

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

List degradations.

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

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :filter_page_id (String) —

    Optional page id filter.

  • :page_offset (Integer) —

    Offset to use as the start of the page.

  • :page_limit (Integer) —

    The number of degradations to return per page.

  • :include (String) —

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

  • :filter_status (String) —

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

  • :sort (String) —

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

Returns:

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

    DegradationArray data, response status code and response headers



1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
 
# File 'lib/datadog_api_client/v2/api/status_pages_api.rb', line 1044

def list_degradations_with_http_info(opts = {})

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

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'filter[page_id]'] = opts[:'filter_page_id'] if !opts[:'filter_page_id'].nil?
  query_params[:'page[offset]'] = opts[:'page_offset'] if !opts[:'page_offset'].nil?
  query_params[:'page[limit]'] = opts[:'page_limit'] if !opts[:'page_limit'].nil?
  query_params[:'include'] = opts[:'include'] if !opts[:'include'].nil?
  query_params[:'filter[status]'] = opts[:'filter_status'] if !opts[:'filter_status'].nil?
  query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?

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

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

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

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

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

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

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

#list_maintenances(opts = {}) ⇒ Object

List maintenances.

See Also:



1099
1100
1101
1102
 
# File 'lib/datadog_api_client/v2/api/status_pages_api.rb', line 1099

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



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

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:



1171
1172
1173
1174
 
# File 'lib/datadog_api_client/v2/api/status_pages_api.rb', line 1171

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



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

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

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

Publish status page.

See Also:



1239
1240
1241
1242
 
# File 'lib/datadog_api_client/v2/api/status_pages_api.rb', line 1239

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. The `status_pages_settings_write` permission is temporarily honored as we migrate publishing functionality from the update status page endpoint to the publish status page endpoint.

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



1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
 
# File 'lib/datadog_api_client/v2/api/status_pages_api.rb', line 1251

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

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

Unpublish status page.

See Also:



1304
1305
1306
1307
 
# File 'lib/datadog_api_client/v2/api/status_pages_api.rb', line 1304

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. The `status_pages_settings_write` permission is temporarily honored as we migrate unpublishing functionality from the update status page endpoint to the unpublish status page endpoint.

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



1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
 
# File 'lib/datadog_api_client/v2/api/status_pages_api.rb', line 1316

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:



1369
1370
1371
1372
 
# File 'lib/datadog_api_client/v2/api/status_pages_api.rb', line 1369

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



1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
 
# File 'lib/datadog_api_client/v2/api/status_pages_api.rb', line 1384

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:



1448
1449
1450
1451
 
# File 'lib/datadog_api_client/v2/api/status_pages_api.rb', line 1448

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

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

Update degradation.

Updates an existing degradation’s attributes.

Parameters:

  • page_id (UUID) —

    The ID of the status page.

  • degradation_id (UUID) —

    The ID of the degradation.

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

    the optional parameters

Options Hash (opts):

  • :notify_subscribers (Boolean) —

    Whether to notify page subscribers of the degradation.

  • :include (String) —

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

Returns:

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

    Degradation data, response status code and response headers



1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
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
 
# File 'lib/datadog_api_client/v2/api/status_pages_api.rb', line 1464

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:



1529
1530
1531
1532
 
# File 'lib/datadog_api_client/v2/api/status_pages_api.rb', line 1529

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

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

Update maintenance.

Updates an existing maintenance’s attributes.

Parameters:

  • page_id (UUID) —

    The ID of the status page.

  • maintenance_id (UUID) —

    The ID of the maintenance.

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

    the optional parameters

Options Hash (opts):

  • :notify_subscribers (Boolean) —

    Whether to notify page subscribers of the maintenance.

  • :include (String) —

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

Returns:

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

    Maintenance data, response status code and response headers



1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
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
 
# File 'lib/datadog_api_client/v2/api/status_pages_api.rb', line 1545

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:



1610
1611
1612
1613
 
# File 'lib/datadog_api_client/v2/api/status_pages_api.rb', line 1610

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. Note: Publishing and unpublishing via the ‘enabled` property will be deprecated on this endpoint. Use the dedicated [publish](#publish-status-page) and [unpublish](#unpublish-status-page) status page endpoints instead.

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



1625
1626
1627
1628
1629
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
1680
1681
 
# File 'lib/datadog_api_client/v2/api/status_pages_api.rb', line 1625

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