Class: DatadogAPIClient::V2::IncidentsAPI

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

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

Returns a new instance of IncidentsAPI.



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

def api_client
  @api_client
end

Instance Method Details

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

Create global incident handle.

See Also:



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

def create_global_incident_handle(body, opts = {})
  data, _status_code, _headers = create_global_incident_handle_with_http_info(body, opts)
  data
end

#create_global_incident_handle_with_http_info(body, opts = {}) ⇒ Array<(IncidentHandleResponse, Integer, Hash)>

Create global incident handle.

Create a new global incident handle.

Parameters:

Options Hash (opts):

  • :include (String) —

    Comma-separated list of related resources to include in the response

Returns:

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

    IncidentHandleResponse data, response status code and response headers



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

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

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: IncidentsAPI.create_global_incident_handle ...'
  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 IncidentsAPI.create_global_incident_handle"
  end
  # resource path
  local_var_path = '/api/v2/incidents/config/global/incident-handles'

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

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

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

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

Create an incident.

See Also:



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

def create_incident(body, opts = {})
  data, _status_code, _headers = create_incident_with_http_info(body, opts)
  data
end

#create_incident_attachment(incident_id, body, opts = {}) ⇒ Object

Create incident attachment.

See Also:



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

def create_incident_attachment(incident_id, body, opts = {})
  data, _status_code, _headers = create_incident_attachment_with_http_info(incident_id, body, opts)
  data
end

#create_incident_attachment_with_http_info(incident_id, body, opts = {}) ⇒ Array<(Attachment, Integer, Hash)>

Create incident attachment.

Create an incident attachment.

Parameters:

  • incident_id (String) —

    The UUID of the incident.

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

    the optional parameters

Options Hash (opts):

  • :include (String) —

    Resource to include in the response. Supported value: last_modified_by_user.

Returns:

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

    Attachment 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
247
248
249
250
251
252
 
# File 'lib/datadog_api_client/v2/api/incidents_api.rb', line 191

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

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

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

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

#create_incident_impact(incident_id, body, opts = {}) ⇒ Object

Create an incident impact.

See Also:



257
258
259
260
 
# File 'lib/datadog_api_client/v2/api/incidents_api.rb', line 257

def create_incident_impact(incident_id, body, opts = {})
  data, _status_code, _headers = create_incident_impact_with_http_info(incident_id, body, opts)
  data
end

#create_incident_impact_with_http_info(incident_id, body, opts = {}) ⇒ Array<(IncidentImpactResponse, Integer, Hash)>

Create an incident impact.

Create an impact for an incident.

Parameters:

  • incident_id (String) —

    The UUID of the incident.

  • body (IncidentImpactCreateRequest) —

    Incident impact payload.

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

    the optional parameters

Options Hash (opts):

Returns:

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

    IncidentImpactResponse data, response status code and response headers



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
323
324
325
326
 
# File 'lib/datadog_api_client/v2/api/incidents_api.rb', line 271

def create_incident_impact_with_http_info(incident_id, body, opts = {})

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

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'include'] = @api_client.build_collection_param(opts[:'include'], :csv) 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] || 'IncidentImpactResponse'

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

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

#create_incident_integration(incident_id, body, opts = {}) ⇒ Object

Create an incident integration metadata.

See Also:



102
103
104
105
 
# File 'lib/datadog_api_client/v2/api/incidents_api.rb', line 102

def create_incident_integration(incident_id, body, opts = {})
  data, _status_code, _headers = create_incident_integration_with_http_info(incident_id, body, opts)
  data
end

#create_incident_integration_with_http_info(incident_id, body, opts = {}) ⇒ Array<(IncidentIntegrationMetadataResponse, Integer, Hash)>

Create an incident integration metadata.

Create an incident integration metadata.

Parameters:

  • incident_id (String) —

    The UUID of the incident.

  • body (IncidentIntegrationMetadataCreateRequest) —

    Incident integration metadata payload.

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

    the optional parameters

Returns:



115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
 
# File 'lib/datadog_api_client/v2/api/incidents_api.rb', line 115

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

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: IncidentsAPI.create_incident_integration ...'
  end
  # verify the required parameter 'incident_id' is set
  if @api_client.config.client_side_validation && incident_id.nil?
    fail ArgumentError, "Missing the required parameter 'incident_id' when calling IncidentsAPI.create_incident_integration"
  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 IncidentsAPI.create_incident_integration"
  end
  # resource path
  local_var_path = '/api/v2/incidents/{incident_id}/relationships/integrations'.sub('{incident_id}', CGI.escape(incident_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] || 'IncidentIntegrationMetadataResponse'

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

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

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

Create an incident notification rule.

See Also:



409
410
411
412
 
# File 'lib/datadog_api_client/v2/api/incidents_api.rb', line 409

def create_incident_notification_rule(body, opts = {})
  data, _status_code, _headers = create_incident_notification_rule_with_http_info(body, opts)
  data
end

#create_incident_notification_rule_with_http_info(body, opts = {}) ⇒ Array<(IncidentNotificationRule, Integer, Hash)>

Create an incident notification rule.

Creates a new notification rule.

Parameters:

Returns:

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

    IncidentNotificationRule data, response status code and response headers



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
473
474
475
476
477
 
# File 'lib/datadog_api_client/v2/api/incidents_api.rb', line 421

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

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: IncidentsAPI.create_incident_notification_rule ...'
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling IncidentsAPI.create_incident_notification_rule"
  end
  # resource path
  local_var_path = '/api/v2/incidents/config/notification-rules'

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

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

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

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

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

Create incident notification template.

See Also:



482
483
484
485
 
# File 'lib/datadog_api_client/v2/api/incidents_api.rb', line 482

def create_incident_notification_template(body, opts = {})
  data, _status_code, _headers = create_incident_notification_template_with_http_info(body, opts)
  data
end

#create_incident_notification_template_with_http_info(body, opts = {}) ⇒ Array<(IncidentNotificationTemplate, Integer, Hash)>

Create incident notification template.

Creates a new notification template.

Parameters:

Returns:



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
547
548
549
550
 
# File 'lib/datadog_api_client/v2/api/incidents_api.rb', line 494

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

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: IncidentsAPI.create_incident_notification_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 IncidentsAPI.create_incident_notification_template"
  end
  # resource path
  local_var_path = '/api/v2/incidents/config/notification-templates'

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

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

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

#create_incident_postmortem_attachment(incident_id, body, opts = {}) ⇒ Object

Create postmortem attachment.

See Also:



555
556
557
558
 
# File 'lib/datadog_api_client/v2/api/incidents_api.rb', line 555

def create_incident_postmortem_attachment(incident_id, body, opts = {})
  data, _status_code, _headers = create_incident_postmortem_attachment_with_http_info(incident_id, body, opts)
  data
end

#create_incident_postmortem_attachment_with_http_info(incident_id, body, opts = {}) ⇒ Array<(Attachment, Integer, Hash)>

Create postmortem attachment.

Create a postmortem attachment for an incident.

The endpoint accepts markdown for notebooks created in Confluence or Google Docs. Postmortems created from notebooks need to be formatted using frontend notebook cells, in addition to markdown format.

Parameters:

  • incident_id (String) —

    The ID of the incident

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

    the optional parameters

Returns:

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

    Attachment data, response status code and response headers



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
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
 
# File 'lib/datadog_api_client/v2/api/incidents_api.rb', line 572

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

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: IncidentsAPI.create_incident_postmortem_attachment ...'
  end
  # verify the required parameter 'incident_id' is set
  if @api_client.config.client_side_validation && incident_id.nil?
    fail ArgumentError, "Missing the required parameter 'incident_id' when calling IncidentsAPI.create_incident_postmortem_attachment"
  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 IncidentsAPI.create_incident_postmortem_attachment"
  end
  # resource path
  local_var_path = '/api/v2/incidents/{incident_id}/attachments/postmortems'.sub('{incident_id}', CGI.escape(incident_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] || 'Attachment'

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

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

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

Create postmortem template.

See Also:



637
638
639
640
 
# File 'lib/datadog_api_client/v2/api/incidents_api.rb', line 637

def create_incident_postmortem_template(body, opts = {})
  data, _status_code, _headers = create_incident_postmortem_template_with_http_info(body, opts)
  data
end

#create_incident_postmortem_template_with_http_info(body, opts = {}) ⇒ Array<(PostmortemTemplateResponse, Integer, Hash)>

Create postmortem template.

Create a new postmortem template for incidents.

Parameters:

Returns:

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

    PostmortemTemplateResponse data, response status code and response headers



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
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
 
# File 'lib/datadog_api_client/v2/api/incidents_api.rb', line 649

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

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: IncidentsAPI.create_incident_postmortem_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 IncidentsAPI.create_incident_postmortem_template"
  end
  # resource path
  local_var_path = '/api/v2/incidents/config/postmortem-templates'

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

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

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

#create_incident_todo(incident_id, body, opts = {}) ⇒ Object

Create an incident todo.

See Also:



180
181
182
183
 
# File 'lib/datadog_api_client/v2/api/incidents_api.rb', line 180

def create_incident_todo(incident_id, body, opts = {})
  data, _status_code, _headers = create_incident_todo_with_http_info(incident_id, body, opts)
  data
end

#create_incident_todo_with_http_info(incident_id, body, opts = {}) ⇒ Array<(IncidentTodoResponse, Integer, Hash)>

Create an incident todo.

Create an incident todo.

Parameters:

  • incident_id (String) —

    The UUID of the incident.

  • body (IncidentTodoCreateRequest) —

    Incident todo payload.

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

    the optional parameters

Returns:

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

    IncidentTodoResponse data, response status code and response headers



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
247
248
249
250
251
252
253
 
# File 'lib/datadog_api_client/v2/api/incidents_api.rb', line 193

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

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: IncidentsAPI.create_incident_todo ...'
  end
  # verify the required parameter 'incident_id' is set
  if @api_client.config.client_side_validation && incident_id.nil?
    fail ArgumentError, "Missing the required parameter 'incident_id' when calling IncidentsAPI.create_incident_todo"
  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 IncidentsAPI.create_incident_todo"
  end
  # resource path
  local_var_path = '/api/v2/incidents/{incident_id}/relationships/todos'.sub('{incident_id}', CGI.escape(incident_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] || 'IncidentTodoResponse'

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

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

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

Create an incident type.

See Also:



258
259
260
261
 
# File 'lib/datadog_api_client/v2/api/incidents_api.rb', line 258

def create_incident_type(body, opts = {})
  data, _status_code, _headers = create_incident_type_with_http_info(body, opts)
  data
end

#create_incident_type_with_http_info(body, opts = {}) ⇒ Array<(IncidentTypeResponse, Integer, Hash)>

Create an incident type.

Create an incident type.

Parameters:

Returns:

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

    IncidentTypeResponse data, response status code and response headers



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
323
324
325
326
 
# File 'lib/datadog_api_client/v2/api/incidents_api.rb', line 270

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

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

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

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

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

#create_incident_with_http_info(body, opts = {}) ⇒ Array<(IncidentResponse, Integer, Hash)>

Create an incident.

Create an incident.

Parameters:

  • body (IncidentCreateRequest) —

    Incident payload.

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

    the optional parameters

Returns:

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

    IncidentResponse data, response status code and response headers



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

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

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

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

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

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

#delete_global_incident_handle(opts = {}) ⇒ Object

Delete global incident handle.

See Also:



861
862
863
864
 
# File 'lib/datadog_api_client/v2/api/incidents_api.rb', line 861

def delete_global_incident_handle(opts = {})
  delete_global_incident_handle_with_http_info(opts)
  nil
end

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

Delete global incident handle.

Delete a global incident handle.

Parameters:

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



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

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

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: IncidentsAPI.delete_global_incident_handle ...'
  end
  # resource path
  local_var_path = '/api/v2/incidents/config/global/incident-handles'

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

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

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

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

  # return_type
  return_type = opts[:debug_return_type]

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

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

#delete_incident(incident_id, opts = {}) ⇒ Object

Delete an existing incident.

See Also:



331
332
333
334
 
# File 'lib/datadog_api_client/v2/api/incidents_api.rb', line 331

def delete_incident(incident_id, opts = {})
  delete_incident_with_http_info(incident_id, opts)
  nil
end

#delete_incident_attachment(incident_id, attachment_id, opts = {}) ⇒ Object

Delete incident attachment.

See Also:



998
999
1000
1001
 
# File 'lib/datadog_api_client/v2/api/incidents_api.rb', line 998

def delete_incident_attachment(incident_id, attachment_id, opts = {})
  delete_incident_attachment_with_http_info(incident_id, attachment_id, opts)
  nil
end

#delete_incident_attachment_with_http_info(incident_id, attachment_id, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Delete incident attachment.

Parameters:

  • incident_id (String) —

    The UUID of the incident.

  • attachment_id (String) —

    The ID of the attachment.

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



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
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
 
# File 'lib/datadog_api_client/v2/api/incidents_api.rb', line 1008

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

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

#delete_incident_impact(incident_id, impact_id, opts = {}) ⇒ Object

Delete an incident impact.

See Also:



1071
1072
1073
1074
 
# File 'lib/datadog_api_client/v2/api/incidents_api.rb', line 1071

def delete_incident_impact(incident_id, impact_id, opts = {})
  delete_incident_impact_with_http_info(incident_id, impact_id, opts)
  nil
end

#delete_incident_impact_with_http_info(incident_id, impact_id, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Delete an incident impact.

Delete an incident impact.

Parameters:

  • incident_id (String) —

    The UUID of the incident.

  • impact_id (String) —

    The UUID of the incident impact.

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



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
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
 
# File 'lib/datadog_api_client/v2/api/incidents_api.rb', line 1084

def delete_incident_impact_with_http_info(incident_id, impact_id, opts = {})

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

#delete_incident_integration(incident_id, integration_metadata_id, opts = {}) ⇒ Object

Delete an incident integration metadata.

See Also:



402
403
404
405
 
# File 'lib/datadog_api_client/v2/api/incidents_api.rb', line 402

def delete_incident_integration(incident_id, integration_metadata_id, opts = {})
  delete_incident_integration_with_http_info(incident_id, integration_metadata_id, opts)
  nil
end

#delete_incident_integration_with_http_info(incident_id, integration_metadata_id, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Delete an incident integration metadata.

Delete an incident integration metadata.

Parameters:

  • incident_id (String) —

    The UUID of the incident.

  • integration_metadata_id (String) —

    The UUID of the incident integration metadata.

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
 
# File 'lib/datadog_api_client/v2/api/incidents_api.rb', line 415

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

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

#delete_incident_notification_rule(id, opts = {}) ⇒ Object

Delete an incident notification rule.

See Also:



1217
1218
1219
1220
 
# File 'lib/datadog_api_client/v2/api/incidents_api.rb', line 1217

def delete_incident_notification_rule(id, opts = {})
  delete_incident_notification_rule_with_http_info(id, opts)
  nil
end

#delete_incident_notification_rule_with_http_info(id, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Delete an incident notification rule.

Deletes a notification rule by its ID.

Parameters:

  • id (UUID) —

    The ID of the notification rule.

  • 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, incident_type, notification_template

Returns:

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

    nil, response status code and response headers



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

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

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: IncidentsAPI.delete_incident_notification_rule ...'
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling IncidentsAPI.delete_incident_notification_rule"
  end
  # resource path
  local_var_path = '/api/v2/incidents/config/notification-rules/{id}'.sub('{id}', CGI.escape(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(['*/*'])

  # 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_incident_notification_rule,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type,
    :api_version => "V2"
  )

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

#delete_incident_notification_template(id, opts = {}) ⇒ Object

Delete a notification template.

See Also:



1290
1291
1292
1293
 
# File 'lib/datadog_api_client/v2/api/incidents_api.rb', line 1290

def delete_incident_notification_template(id, opts = {})
  delete_incident_notification_template_with_http_info(id, opts)
  nil
end

#delete_incident_notification_template_with_http_info(id, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Delete a notification template.

Deletes a notification template by its ID.

Parameters:

  • id (UUID) —

    The ID of the notification template.

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

    the optional parameters

Options Hash (opts):

  • :include (String) —

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

Returns:

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

    nil, response status code and response headers



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

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

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: IncidentsAPI.delete_incident_notification_template ...'
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling IncidentsAPI.delete_incident_notification_template"
  end
  # resource path
  local_var_path = '/api/v2/incidents/config/notification-templates/{id}'.sub('{id}', CGI.escape(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(['*/*'])

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

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

Delete postmortem template.

See Also:



1363
1364
1365
1366
 
# File 'lib/datadog_api_client/v2/api/incidents_api.rb', line 1363

def delete_incident_postmortem_template(template_id, opts = {})
  delete_incident_postmortem_template_with_http_info(template_id, opts)
  nil
end

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

Delete postmortem template.

Delete a postmortem template.

Parameters:

  • template_id (String) —

    The ID of the postmortem template

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



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

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

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: IncidentsAPI.delete_incident_postmortem_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 IncidentsAPI.delete_incident_postmortem_template"
  end
  # resource path
  local_var_path = '/api/v2/incidents/config/postmortem-templates/{template_id}'.sub('{template_id}', CGI.escape(template_id.to_s).gsub('%2F', '/'))

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

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

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

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

  # return_type
  return_type = opts[:debug_return_type]

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

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

#delete_incident_todo(incident_id, todo_id, opts = {}) ⇒ Object

Delete an incident todo.

See Also:



478
479
480
481
 
# File 'lib/datadog_api_client/v2/api/incidents_api.rb', line 478

def delete_incident_todo(incident_id, todo_id, opts = {})
  delete_incident_todo_with_http_info(incident_id, todo_id, opts)
  nil
end

#delete_incident_todo_with_http_info(incident_id, todo_id, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Delete an incident todo.

Delete an incident todo.

Parameters:

  • incident_id (String) —

    The UUID of the incident.

  • todo_id (String) —

    The UUID of the incident todo.

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

    the optional parameters

Returns:

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

    nil, 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
547
548
549
 
# File 'lib/datadog_api_client/v2/api/incidents_api.rb', line 491

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

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

#delete_incident_type(incident_type_id, opts = {}) ⇒ Object

Delete an incident type.

See Also:



554
555
556
557
 
# File 'lib/datadog_api_client/v2/api/incidents_api.rb', line 554

def delete_incident_type(incident_type_id, opts = {})
  delete_incident_type_with_http_info(incident_type_id, opts)
  nil
end

#delete_incident_type_with_http_info(incident_type_id, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Delete an incident type.

Delete an incident type.

Parameters:

  • incident_type_id (String) —

    The UUID of the incident type.

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



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
616
617
618
619
620
 
# File 'lib/datadog_api_client/v2/api/incidents_api.rb', line 566

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

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

#delete_incident_with_http_info(incident_id, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Delete an existing incident.

Deletes an existing incident from the users organization.

Parameters:

  • incident_id (String) —

    The UUID of the incident.

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



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

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

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

#get_global_incident_settings(opts = {}) ⇒ Object

Get global incident settings.

See Also:



1581
1582
1583
1584
 
# File 'lib/datadog_api_client/v2/api/incidents_api.rb', line 1581

def get_global_incident_settings(opts = {})
  data, _status_code, _headers = get_global_incident_settings_with_http_info(opts)
  data
end

#get_global_incident_settings_with_http_info(opts = {}) ⇒ Array<(GlobalIncidentSettingsResponse, Integer, Hash)>

Get global incident settings.

Retrieve global incident settings for the organization.

Parameters:

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

    the optional parameters

Returns:



1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
 
# File 'lib/datadog_api_client/v2/api/incidents_api.rb', line 1592

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

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: IncidentsAPI.get_global_incident_settings ...'
  end
  # resource path
  local_var_path = '/api/v2/incidents/config/global/settings'

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

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

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

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

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

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

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

#get_incident(incident_id, opts = {}) ⇒ Object

Get the details of an incident.

See Also:



625
626
627
628
 
# File 'lib/datadog_api_client/v2/api/incidents_api.rb', line 625

def get_incident(incident_id, opts = {})
  data, _status_code, _headers = get_incident_with_http_info(incident_id, opts)
  data
end

#get_incident_integration(incident_id, integration_metadata_id, opts = {}) ⇒ Object

Get incident integration metadata details.

See Also:



698
699
700
701
 
# File 'lib/datadog_api_client/v2/api/incidents_api.rb', line 698

def get_incident_integration(incident_id, integration_metadata_id, opts = {})
  data, _status_code, _headers = get_incident_integration_with_http_info(incident_id, integration_metadata_id, opts)
  data
end

#get_incident_integration_with_http_info(incident_id, integration_metadata_id, opts = {}) ⇒ Array<(IncidentIntegrationMetadataResponse, Integer, Hash)>

Get incident integration metadata details.

Get incident integration metadata details.

Parameters:

  • incident_id (String) —

    The UUID of the incident.

  • integration_metadata_id (String) —

    The UUID of the incident integration metadata.

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

    the optional parameters

Returns:



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
756
757
758
759
760
761
762
763
764
765
766
767
768
769
 
# File 'lib/datadog_api_client/v2/api/incidents_api.rb', line 711

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

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

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

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

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

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

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

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

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

#get_incident_notification_rule(id, opts = {}) ⇒ Object

Get an incident notification rule.

See Also:



1796
1797
1798
1799
 
# File 'lib/datadog_api_client/v2/api/incidents_api.rb', line 1796

def get_incident_notification_rule(id, opts = {})
  data, _status_code, _headers = get_incident_notification_rule_with_http_info(id, opts)
  data
end

#get_incident_notification_rule_with_http_info(id, opts = {}) ⇒ Array<(IncidentNotificationRule, Integer, Hash)>

Get an incident notification rule.

Retrieves a specific notification rule by its ID.

Parameters:

  • id (UUID) —

    The ID of the notification rule.

  • 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, incident_type, notification_template

Returns:

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

    IncidentNotificationRule data, response status code and response headers



1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
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
 
# File 'lib/datadog_api_client/v2/api/incidents_api.rb', line 1809

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

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

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

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

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

#get_incident_notification_template(id, opts = {}) ⇒ Object

Get incident notification template.

See Also:



1869
1870
1871
1872
 
# File 'lib/datadog_api_client/v2/api/incidents_api.rb', line 1869

def get_incident_notification_template(id, opts = {})
  data, _status_code, _headers = get_incident_notification_template_with_http_info(id, opts)
  data
end

#get_incident_notification_template_with_http_info(id, opts = {}) ⇒ Array<(IncidentNotificationTemplate, Integer, Hash)>

Get incident notification template.

Retrieves a specific notification template by its ID.

Parameters:

  • id (UUID) —

    The ID of the notification template.

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

    the optional parameters

Options Hash (opts):

  • :include (String) —

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

Returns:



1882
1883
1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
1903
1904
1905
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
 
# File 'lib/datadog_api_client/v2/api/incidents_api.rb', line 1882

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

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

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

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

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

Get postmortem template.

See Also:



1942
1943
1944
1945
 
# File 'lib/datadog_api_client/v2/api/incidents_api.rb', line 1942

def get_incident_postmortem_template(template_id, opts = {})
  data, _status_code, _headers = get_incident_postmortem_template_with_http_info(template_id, opts)
  data
end

#get_incident_postmortem_template_with_http_info(template_id, opts = {}) ⇒ Array<(PostmortemTemplateResponse, Integer, Hash)>

Get postmortem template.

Retrieve details of a specific postmortem template.

Parameters:

  • template_id (String) —

    The ID of the postmortem template

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

    the optional parameters

Returns:

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

    PostmortemTemplateResponse data, response status code and response headers



1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
1979
1980
1981
1982
1983
1984
1985
1986
1987
1988
1989
1990
1991
1992
1993
1994
1995
1996
1997
1998
1999
2000
2001
2002
2003
2004
2005
2006
2007
2008
 
# File 'lib/datadog_api_client/v2/api/incidents_api.rb', line 1954

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

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: IncidentsAPI.get_incident_postmortem_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 IncidentsAPI.get_incident_postmortem_template"
  end
  # resource path
  local_var_path = '/api/v2/incidents/config/postmortem-templates/{template_id}'.sub('{template_id}', CGI.escape(template_id.to_s).gsub('%2F', '/'))

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

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

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

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

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

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

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

#get_incident_todo(incident_id, todo_id, opts = {}) ⇒ Object

Get incident todo details.

See Also:



774
775
776
777
 
# File 'lib/datadog_api_client/v2/api/incidents_api.rb', line 774

def get_incident_todo(incident_id, todo_id, opts = {})
  data, _status_code, _headers = get_incident_todo_with_http_info(incident_id, todo_id, opts)
  data
end

#get_incident_todo_with_http_info(incident_id, todo_id, opts = {}) ⇒ Array<(IncidentTodoResponse, Integer, Hash)>

Get incident todo details.

Get incident todo details.

Parameters:

  • incident_id (String) —

    The UUID of the incident.

  • todo_id (String) —

    The UUID of the incident todo.

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

    the optional parameters

Returns:

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

    IncidentTodoResponse data, response status code and response headers



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
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
 
# File 'lib/datadog_api_client/v2/api/incidents_api.rb', line 787

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

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

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

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

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

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

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

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

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

#get_incident_type(incident_type_id, opts = {}) ⇒ Object

Get incident type details.

See Also:



850
851
852
853
 
# File 'lib/datadog_api_client/v2/api/incidents_api.rb', line 850

def get_incident_type(incident_type_id, opts = {})
  data, _status_code, _headers = get_incident_type_with_http_info(incident_type_id, opts)
  data
end

#get_incident_type_with_http_info(incident_type_id, opts = {}) ⇒ Array<(IncidentTypeResponse, Integer, Hash)>

Get incident type details.

Get incident type details.

Parameters:

  • incident_type_id (String) —

    The UUID of the incident type.

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

    the optional parameters

Returns:

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

    IncidentTypeResponse data, response status code and response headers



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
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
 
# File 'lib/datadog_api_client/v2/api/incidents_api.rb', line 862

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

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

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

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

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

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

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

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

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

#get_incident_with_http_info(incident_id, opts = {}) ⇒ Array<(IncidentResponse, Integer, Hash)>

Get the details of an incident.

Get the details of an incident by incident_id.

Parameters:

  • incident_id (String) —

    The UUID of the incident.

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

    the optional parameters

Options Hash (opts):

  • :include (Array<IncidentRelatedObject>) —

    Specifies which types of related objects should be included in the response.

Returns:

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

    IncidentResponse data, response status code and response headers



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
686
687
688
689
690
691
692
693
 
# File 'lib/datadog_api_client/v2/api/incidents_api.rb', line 638

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

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

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'include'] = @api_client.build_collection_param(opts[:'include'], :csv) 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] || 'IncidentResponse'

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

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

#list_global_incident_handles(opts = {}) ⇒ Object

List global incident handles.

See Also:



2160
2161
2162
2163
 
# File 'lib/datadog_api_client/v2/api/incidents_api.rb', line 2160

def list_global_incident_handles(opts = {})
  data, _status_code, _headers = list_global_incident_handles_with_http_info(opts)
  data
end

#list_global_incident_handles_with_http_info(opts = {}) ⇒ Array<(IncidentHandlesResponse, Integer, Hash)>

List global incident handles.

Retrieve a list of global incident handles.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :include (String) —

    Comma-separated list of related resources to include in the response

Returns:

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

    IncidentHandlesResponse data, response status code and response headers



2172
2173
2174
2175
2176
2177
2178
2179
2180
2181
2182
2183
2184
2185
2186
2187
2188
2189
2190
2191
2192
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
 
# File 'lib/datadog_api_client/v2/api/incidents_api.rb', line 2172

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

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: IncidentsAPI.list_global_incident_handles ...'
  end
  # resource path
  local_var_path = '/api/v2/incidents/config/global/incident-handles'

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

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

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

#list_incident_attachments(incident_id, opts = {}) ⇒ Object

List incident attachments.

See Also:



921
922
923
924
 
# File 'lib/datadog_api_client/v2/api/incidents_api.rb', line 921

def list_incident_attachments(incident_id, opts = {})
  data, _status_code, _headers = list_incident_attachments_with_http_info(incident_id, opts)
  data
end

#list_incident_attachments_with_http_info(incident_id, opts = {}) ⇒ Array<(AttachmentArray, Integer, Hash)>

List incident attachments.

List incident attachments.

Parameters:

  • incident_id (String) —

    The UUID of the incident.

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

    the optional parameters

Options Hash (opts):

  • :filter_attachment_type (String) —

    Filter attachments by type. Supported values are 1 (postmortem) and 2 (link).

  • :include (String) —

    Resource to include in the response. Supported value: last_modified_by_user.

Returns:

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

    AttachmentArray data, response status code and response headers



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
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
 
# File 'lib/datadog_api_client/v2/api/incidents_api.rb', line 935

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

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

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'include'] = @api_client.build_collection_param(opts[:'include'], :csv) if !opts[:'include'].nil?
  query_params[:'filter[attachment_type]'] = @api_client.build_collection_param(opts[:'filter_attachment_type'], :csv) if !opts[:'filter_attachment_type'].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] || 'IncidentAttachmentsResponse'

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

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

#list_incident_impacts(incident_id, opts = {}) ⇒ Object

List an incident's impacts.

See Also:



2303
2304
2305
2306
 
# File 'lib/datadog_api_client/v2/api/incidents_api.rb', line 2303

def list_incident_impacts(incident_id, opts = {})
  data, _status_code, _headers = list_incident_impacts_with_http_info(incident_id, opts)
  data
end

#list_incident_impacts_with_http_info(incident_id, opts = {}) ⇒ Array<(IncidentImpactsResponse, Integer, Hash)>

List an incident's impacts.

Get all impacts for an incident.

Parameters:

  • incident_id (String) —

    The UUID of the incident.

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

    the optional parameters

Options Hash (opts):

Returns:

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

    IncidentImpactsResponse data, response status code and response headers



2316
2317
2318
2319
2320
2321
2322
2323
2324
2325
2326
2327
2328
2329
2330
2331
2332
2333
2334
2335
2336
2337
2338
2339
2340
2341
2342
2343
2344
2345
2346
2347
2348
2349
2350
2351
2352
2353
2354
2355
2356
2357
2358
2359
2360
2361
2362
2363
2364
2365
 
# File 'lib/datadog_api_client/v2/api/incidents_api.rb', line 2316

def list_incident_impacts_with_http_info(incident_id, opts = {})

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

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'include'] = @api_client.build_collection_param(opts[:'include'], :csv) 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] || 'IncidentImpactsResponse'

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

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

#list_incident_integrations(incident_id, opts = {}) ⇒ Object

Get a list of an incident's integration metadata.

See Also:



996
997
998
999
 
# File 'lib/datadog_api_client/v2/api/incidents_api.rb', line 996

def list_incident_integrations(incident_id, opts = {})
  data, _status_code, _headers = list_incident_integrations_with_http_info(incident_id, opts)
  data
end

#list_incident_integrations_with_http_info(incident_id, opts = {}) ⇒ Array<(IncidentIntegrationMetadataListResponse, Integer, Hash)>

Get a list of an incident's integration metadata.

Get all integration metadata for an incident.

Parameters:

  • incident_id (String) —

    The UUID of the incident.

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

    the optional parameters

Returns:



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
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
 
# File 'lib/datadog_api_client/v2/api/incidents_api.rb', line 1008

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

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

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

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

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

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

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

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

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

#list_incident_notification_rules(opts = {}) ⇒ Object

List incident notification rules.

See Also:



2441
2442
2443
2444
 
# File 'lib/datadog_api_client/v2/api/incidents_api.rb', line 2441

def list_incident_notification_rules(opts = {})
  data, _status_code, _headers = list_incident_notification_rules_with_http_info(opts)
  data
end

#list_incident_notification_rules_with_http_info(opts = {}) ⇒ Array<(IncidentNotificationRuleArray, Integer, Hash)>

List incident notification rules.

Lists all notification rules for the organization. Optionally filter by incident type.

Parameters:

  • 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, incident_type, notification_template

Returns:



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
2494
2495
2496
2497
2498
2499
2500
2501
2502
2503
2504
 
# File 'lib/datadog_api_client/v2/api/incidents_api.rb', line 2453

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

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: IncidentsAPI.list_incident_notification_rules ...'
  end
  # resource path
  local_var_path = '/api/v2/incidents/config/notification-rules'

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

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

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

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

#list_incident_notification_templates(opts = {}) ⇒ Object

List incident notification templates.

See Also:



2509
2510
2511
2512
 
# File 'lib/datadog_api_client/v2/api/incidents_api.rb', line 2509

def list_incident_notification_templates(opts = {})
  data, _status_code, _headers = list_incident_notification_templates_with_http_info(opts)
  data
end

#list_incident_notification_templates_with_http_info(opts = {}) ⇒ Array<(IncidentNotificationTemplateArray, Integer, Hash)>

List incident notification templates.

Lists all notification templates. Optionally filter by incident type.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :filter_incident_type (UUID) —

    Optional incident type ID filter.

  • :include (String) —

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

Returns:



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
2573
2574
 
# File 'lib/datadog_api_client/v2/api/incidents_api.rb', line 2522

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

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: IncidentsAPI.list_incident_notification_templates ...'
  end
  # resource path
  local_var_path = '/api/v2/incidents/config/notification-templates'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'filter[incident-type]'] = opts[:'filter_incident_type'] if !opts[:'filter_incident_type'].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] || 'IncidentNotificationTemplateArray'

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

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

#list_incident_postmortem_templates(opts = {}) ⇒ Object

List postmortem templates.

See Also:



2579
2580
2581
2582
 
# File 'lib/datadog_api_client/v2/api/incidents_api.rb', line 2579

def list_incident_postmortem_templates(opts = {})
  data, _status_code, _headers = list_incident_postmortem_templates_with_http_info(opts)
  data
end

#list_incident_postmortem_templates_with_http_info(opts = {}) ⇒ Array<(PostmortemTemplatesResponse, Integer, Hash)>

List postmortem templates.

Retrieve a list of all postmortem templates for incidents.

Parameters:

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

    the optional parameters

Returns:

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

    PostmortemTemplatesResponse data, response status code and response headers



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

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

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: IncidentsAPI.list_incident_postmortem_templates ...'
  end
  # resource path
  local_var_path = '/api/v2/incidents/config/postmortem-templates'

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

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

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

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

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

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

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

#list_incident_todos(incident_id, opts = {}) ⇒ Object

Get a list of an incident's todos.

See Also:



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

def list_incident_todos(incident_id, opts = {})
  data, _status_code, _headers = list_incident_todos_with_http_info(incident_id, opts)
  data
end

#list_incident_todos_with_http_info(incident_id, opts = {}) ⇒ Array<(IncidentTodoListResponse, Integer, Hash)>

Get a list of an incident's todos.

Get all todos for an incident.

Parameters:

  • incident_id (String) —

    The UUID of the incident.

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

    the optional parameters

Returns:

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

    IncidentTodoListResponse data, response status code and response headers



1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
 
# File 'lib/datadog_api_client/v2/api/incidents_api.rb', line 1172

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

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

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

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

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

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

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

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

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

#list_incident_types(opts = {}) ⇒ Object

Get a list of incident types.

See Also:



1231
1232
1233
1234
 
# File 'lib/datadog_api_client/v2/api/incidents_api.rb', line 1231

def list_incident_types(opts = {})
  data, _status_code, _headers = list_incident_types_with_http_info(opts)
  data
end

#list_incident_types_with_http_info(opts = {}) ⇒ Array<(IncidentTypeListResponse, Integer, Hash)>

Get a list of incident types.

Get all incident types.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :include_deleted (Boolean) —

    Include deleted incident types in the response.

Returns:

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

    IncidentTypeListResponse data, response status code and response headers



1243
1244
1245
1246
1247
1248
1249
1250
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
 
# File 'lib/datadog_api_client/v2/api/incidents_api.rb', line 1243

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

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: IncidentsAPI.list_incident_types ...'
  end
  # resource path
  local_var_path = '/api/v2/incidents/config/types'

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

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

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

#list_incidents(opts = {}) ⇒ Object

Get a list of incidents.

See Also:



1067
1068
1069
1070
 
# File 'lib/datadog_api_client/v2/api/incidents_api.rb', line 1067

def list_incidents(opts = {})
  data, _status_code, _headers = list_incidents_with_http_info(opts)
  data
end

#list_incidents_with_http_info(opts = {}) ⇒ Array<(IncidentsResponse, Integer, Hash)>

Get a list of incidents.

Get all incidents for the user's organization.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :include (Array<IncidentRelatedObject>) —

    Specifies which types of related objects should be included in the response.

  • :page_size (Integer) —

    Size for a given page. The maximum allowed value is 100.

  • :page_offset (Integer) —

    Specific offset to use as the beginning of the returned page.

Returns:

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

    IncidentsResponse data, response status code and response headers



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
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
 
# File 'lib/datadog_api_client/v2/api/incidents_api.rb', line 1081

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

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: IncidentsAPI.list_incidents ...'
  end
  # resource path
  local_var_path = '/api/v2/incidents'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'include'] = @api_client.build_collection_param(opts[:'include'], :csv) if !opts[:'include'].nil?
  query_params[:'page[size]'] = opts[:'page_size'] if !opts[:'page_size'].nil?
  query_params[:'page[offset]'] = opts[:'page_offset'] if !opts[:'page_offset'].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] || 'IncidentsResponse'

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

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

#list_incidents_with_pagination(opts = {}) {|IncidentResponseData| ... } ⇒ Object

Get a list of incidents.

Provide a paginated version of #list_incidents, returning all items.

To use it you need to use a block: list_incidents_with_pagination { |item| p item }

Yields:



1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
 
# File 'lib/datadog_api_client/v2/api/incidents_api.rb', line 1143

def list_incidents_with_pagination(opts = {})
    api_version = "V2"
    page_size = @api_client.get_attribute_from_path(opts, "page_size", 10)
    @api_client.set_attribute_from_path(api_version, opts, "page_size", Integer, page_size)
    while true do
        response = list_incidents(opts)
        @api_client.get_attribute_from_path(response, "data").each { |item| yield(item) }
        if @api_client.get_attribute_from_path(response, "data").length < page_size
          break
        end
        @api_client.set_attribute_from_path(api_version, opts, "page_offset", Integer, @api_client.get_attribute_from_path(opts, "page_offset", 0) + page_size)
    end
end

#search_incidents(query, opts = {}) ⇒ Object

Search for incidents.

See Also:



1299
1300
1301
1302
 
# File 'lib/datadog_api_client/v2/api/incidents_api.rb', line 1299

def search_incidents(query, opts = {})
  data, _status_code, _headers = search_incidents_with_http_info(query, opts)
  data
end

#search_incidents_with_http_info(query, opts = {}) ⇒ Array<(IncidentSearchResponse, Integer, Hash)>

Search for incidents.

Search for incidents matching a certain query.

Parameters:

  • query (String) —

    Specifies which incidents should be returned. The query can contain any number of incident facets joined by ANDs, along with multiple values for each of those facets joined by ORs. For example: state:active AND severity:(SEV-2 OR SEV-1).

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

    the optional parameters

Options Hash (opts):

  • :include (IncidentRelatedObject) —

    Specifies which types of related objects should be included in the response.

  • :sort (IncidentSearchSortOrder) —

    Specifies the order of returned incidents.

  • :page_size (Integer) —

    Size for a given page. The maximum allowed value is 100.

  • :page_offset (Integer) —

    Specific offset to use as the beginning of the returned page.

Returns:

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

    IncidentSearchResponse data, response status code and response headers



1315
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
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
 
# File 'lib/datadog_api_client/v2/api/incidents_api.rb', line 1315

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

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: IncidentsAPI.search_incidents ...'
  end
  allowable_values = ['users', 'attachments']
  if @api_client.config.client_side_validation && opts[:'include'] && !allowable_values.include?(opts[:'include'])
    fail ArgumentError, "invalid value for \"include\", must be one of #{allowable_values}"
  end
  # verify the required parameter 'query' is set
  if @api_client.config.client_side_validation && query.nil?
    fail ArgumentError, "Missing the required parameter 'query' when calling IncidentsAPI.search_incidents"
  end
  allowable_values = ['created', '-created']
  if @api_client.config.client_side_validation && opts[:'sort'] && !allowable_values.include?(opts[:'sort'])
    fail ArgumentError, "invalid value for \"sort\", must be one of #{allowable_values}"
  end
  # resource path
  local_var_path = '/api/v2/incidents/search'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'query'] = query
  query_params[:'include'] = opts[:'include'] if !opts[:'include'].nil?
  query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
  query_params[:'page[size]'] = opts[:'page_size'] if !opts[:'page_size'].nil?
  query_params[:'page[offset]'] = opts[:'page_offset'] if !opts[:'page_offset'].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] || 'IncidentSearchResponse'

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

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

#search_incidents_with_pagination(query, opts = {}) {|IncidentSearchResponseIncidentsData| ... } ⇒ Object

Search for incidents.

Provide a paginated version of #search_incidents, returning all items.

To use it you need to use a block: search_incidents_with_pagination { |item| p item }

Yields:



1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
 
# File 'lib/datadog_api_client/v2/api/incidents_api.rb', line 1391

def search_incidents_with_pagination(query, opts = {})
    api_version = "V2"
    page_size = @api_client.get_attribute_from_path(opts, "page_size", 10)
    @api_client.set_attribute_from_path(api_version, opts, "page_size", Integer, page_size)
    while true do
        response = search_incidents(query, opts)
        @api_client.get_attribute_from_path(response, "data.attributes.incidents").each { |item| yield(item) }
        if @api_client.get_attribute_from_path(response, "data.attributes.incidents").length < page_size
          break
        end
        @api_client.set_attribute_from_path(api_version, opts, "page_offset", Integer, @api_client.get_attribute_from_path(opts, "page_offset", 0) + page_size)
    end
end

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

Update global incident handle.

See Also:



2986
2987
2988
2989
 
# File 'lib/datadog_api_client/v2/api/incidents_api.rb', line 2986

def update_global_incident_handle(body, opts = {})
  data, _status_code, _headers = update_global_incident_handle_with_http_info(body, opts)
  data
end

#update_global_incident_handle_with_http_info(body, opts = {}) ⇒ Array<(IncidentHandleResponse, Integer, Hash)>

Update global incident handle.

Update an existing global incident handle.

Parameters:

Options Hash (opts):

  • :include (String) —

    Comma-separated list of related resources to include in the response

Returns:

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

    IncidentHandleResponse data, response status code and response headers



2999
3000
3001
3002
3003
3004
3005
3006
3007
3008
3009
3010
3011
3012
3013
3014
3015
3016
3017
3018
3019
3020
3021
3022
3023
3024
3025
3026
3027
3028
3029
3030
3031
3032
3033
3034
3035
3036
3037
3038
3039
3040
3041
3042
3043
3044
3045
3046
3047
3048
3049
3050
3051
3052
3053
3054
3055
3056
 
# File 'lib/datadog_api_client/v2/api/incidents_api.rb', line 2999

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

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: IncidentsAPI.update_global_incident_handle ...'
  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 IncidentsAPI.update_global_incident_handle"
  end
  # resource path
  local_var_path = '/api/v2/incidents/config/global/incident-handles'

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

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

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

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

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

Update global incident settings.

See Also:



3061
3062
3063
3064
 
# File 'lib/datadog_api_client/v2/api/incidents_api.rb', line 3061

def update_global_incident_settings(body, opts = {})
  data, _status_code, _headers = update_global_incident_settings_with_http_info(body, opts)
  data
end

#update_global_incident_settings_with_http_info(body, opts = {}) ⇒ Array<(GlobalIncidentSettingsResponse, Integer, Hash)>

Update global incident settings.

Update global incident settings for the organization.

Parameters:

Returns:



3073
3074
3075
3076
3077
3078
3079
3080
3081
3082
3083
3084
3085
3086
3087
3088
3089
3090
3091
3092
3093
3094
3095
3096
3097
3098
3099
3100
3101
3102
3103
3104
3105
3106
3107
3108
3109
3110
3111
3112
3113
3114
3115
3116
3117
3118
3119
3120
3121
3122
3123
3124
3125
3126
3127
3128
3129
 
# File 'lib/datadog_api_client/v2/api/incidents_api.rb', line 3073

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

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: IncidentsAPI.update_global_incident_settings ...'
  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 IncidentsAPI.update_global_incident_settings"
  end
  # resource path
  local_var_path = '/api/v2/incidents/config/global/settings'

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

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

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

#update_incident(incident_id, body, opts = {}) ⇒ Object

Update an existing incident.

See Also:



1408
1409
1410
1411
 
# File 'lib/datadog_api_client/v2/api/incidents_api.rb', line 1408

def update_incident(incident_id, body, opts = {})
  data, _status_code, _headers = update_incident_with_http_info(incident_id, body, opts)
  data
end

#update_incident_attachment(incident_id, attachment_id, body, opts = {}) ⇒ Object

Update incident attachment.

See Also:



3214
3215
3216
3217
 
# File 'lib/datadog_api_client/v2/api/incidents_api.rb', line 3214

def update_incident_attachment(incident_id, attachment_id, body, opts = {})
  data, _status_code, _headers = update_incident_attachment_with_http_info(incident_id, attachment_id, body, opts)
  data
end

#update_incident_attachment_with_http_info(incident_id, attachment_id, body, opts = {}) ⇒ Array<(Attachment, Integer, Hash)>

Update incident attachment.

Parameters:

  • incident_id (String) —

    The UUID of the incident.

  • attachment_id (String) —

    The ID of the attachment.

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

    the optional parameters

Options Hash (opts):

  • :include (String) —

    Resource to include in the response. Supported value: last_modified_by_user.

Returns:

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

    Attachment data, response status code and response headers



3226
3227
3228
3229
3230
3231
3232
3233
3234
3235
3236
3237
3238
3239
3240
3241
3242
3243
3244
3245
3246
3247
3248
3249
3250
3251
3252
3253
3254
3255
3256
3257
3258
3259
3260
3261
3262
3263
3264
3265
3266
3267
3268
3269
3270
3271
3272
3273
3274
3275
3276
3277
3278
3279
3280
3281
3282
3283
3284
3285
3286
3287
3288
3289
3290
3291
 
# File 'lib/datadog_api_client/v2/api/incidents_api.rb', line 3226

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

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

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

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

#update_incident_attachments(incident_id, body, opts = {}) ⇒ Object

Create, update, and delete incident attachments.

See Also:



1488
1489
1490
1491
 
# File 'lib/datadog_api_client/v2/api/incidents_api.rb', line 1488

def update_incident_attachments(incident_id, body, opts = {})
  data, _status_code, _headers = update_incident_attachments_with_http_info(incident_id, body, opts)
  data
end

#update_incident_attachments_with_http_info(incident_id, body, opts = {}) ⇒ Array<(IncidentAttachmentUpdateResponse, Integer, Hash)>

Create, update, and delete incident attachments.

The bulk update endpoint for creating, updating, and deleting attachments for a given incident.

Parameters:

  • incident_id (String) —

    The UUID of the incident.

  • body (IncidentAttachmentUpdateRequest) —

    Incident Attachment Payload.

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

    the optional parameters

Options Hash (opts):

Returns:



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
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
 
# File 'lib/datadog_api_client/v2/api/incidents_api.rb', line 1502

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

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

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'include'] = @api_client.build_collection_param(opts[:'include'], :csv) 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] || 'IncidentAttachmentUpdateResponse'

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

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

#update_incident_integration(incident_id, integration_metadata_id, body, opts = {}) ⇒ Object

Update an existing incident integration metadata.

See Also:



1568
1569
1570
1571
 
# File 'lib/datadog_api_client/v2/api/incidents_api.rb', line 1568

def update_incident_integration(incident_id, integration_metadata_id, body, opts = {})
  data, _status_code, _headers = update_incident_integration_with_http_info(incident_id, integration_metadata_id, body, opts)
  data
end

#update_incident_integration_with_http_info(incident_id, integration_metadata_id, body, opts = {}) ⇒ Array<(IncidentIntegrationMetadataResponse, Integer, Hash)>

Update an existing incident integration metadata.

Update an existing incident integration metadata.

Parameters:

  • incident_id (String) —

    The UUID of the incident.

  • integration_metadata_id (String) —

    The UUID of the incident integration metadata.

  • body (IncidentIntegrationMetadataPatchRequest) —

    Incident integration metadata payload.

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

    the optional parameters

Returns:



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
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
 
# File 'lib/datadog_api_client/v2/api/incidents_api.rb', line 1582

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

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

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

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

#update_incident_notification_rule(id, body, opts = {}) ⇒ Object

Update an incident notification rule.

See Also:



3379
3380
3381
3382
 
# File 'lib/datadog_api_client/v2/api/incidents_api.rb', line 3379

def update_incident_notification_rule(id, body, opts = {})
  data, _status_code, _headers = update_incident_notification_rule_with_http_info(id, body, opts)
  data
end

#update_incident_notification_rule_with_http_info(id, body, opts = {}) ⇒ Array<(IncidentNotificationRule, Integer, Hash)>

Update an incident notification rule.

Updates an existing notification rule with a complete replacement.

Parameters:

Options Hash (opts):

  • :include (String) —

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

Returns:

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

    IncidentNotificationRule data, response status code and response headers



3393
3394
3395
3396
3397
3398
3399
3400
3401
3402
3403
3404
3405
3406
3407
3408
3409
3410
3411
3412
3413
3414
3415
3416
3417
3418
3419
3420
3421
3422
3423
3424
3425
3426
3427
3428
3429
3430
3431
3432
3433
3434
3435
3436
3437
3438
3439
3440
3441
3442
3443
3444
3445
3446
3447
3448
3449
3450
3451
3452
3453
3454
 
# File 'lib/datadog_api_client/v2/api/incidents_api.rb', line 3393

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

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: IncidentsAPI.update_incident_notification_rule ...'
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling IncidentsAPI.update_incident_notification_rule"
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling IncidentsAPI.update_incident_notification_rule"
  end
  # resource path
  local_var_path = '/api/v2/incidents/config/notification-rules/{id}'.sub('{id}', CGI.escape(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] || 'IncidentNotificationRule'

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

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

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

#update_incident_notification_template(id, body, opts = {}) ⇒ Object

Update incident notification template.

See Also:



3459
3460
3461
3462
 
# File 'lib/datadog_api_client/v2/api/incidents_api.rb', line 3459

def update_incident_notification_template(id, body, opts = {})
  data, _status_code, _headers = update_incident_notification_template_with_http_info(id, body, opts)
  data
end

#update_incident_notification_template_with_http_info(id, body, opts = {}) ⇒ Array<(IncidentNotificationTemplate, Integer, Hash)>

Update incident notification template.

Updates an existing notification template's attributes.

Parameters:

Options Hash (opts):

  • :include (String) —

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

Returns:



3473
3474
3475
3476
3477
3478
3479
3480
3481
3482
3483
3484
3485
3486
3487
3488
3489
3490
3491
3492
3493
3494
3495
3496
3497
3498
3499
3500
3501
3502
3503
3504
3505
3506
3507
3508
3509
3510
3511
3512
3513
3514
3515
3516
3517
3518
3519
3520
3521
3522
3523
3524
3525
3526
3527
3528
3529
3530
3531
3532
3533
3534
 
# File 'lib/datadog_api_client/v2/api/incidents_api.rb', line 3473

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

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: IncidentsAPI.update_incident_notification_template ...'
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling IncidentsAPI.update_incident_notification_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 IncidentsAPI.update_incident_notification_template"
  end
  # resource path
  local_var_path = '/api/v2/incidents/config/notification-templates/{id}'.sub('{id}', CGI.escape(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] || 'IncidentNotificationTemplate'

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

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

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

Update postmortem template.

See Also:



3539
3540
3541
3542
 
# File 'lib/datadog_api_client/v2/api/incidents_api.rb', line 3539

def update_incident_postmortem_template(template_id, body, opts = {})
  data, _status_code, _headers = update_incident_postmortem_template_with_http_info(template_id, body, opts)
  data
end

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

Update postmortem template.

Update an existing postmortem template.

Parameters:

  • template_id (String) —

    The ID of the postmortem template

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

    the optional parameters

Returns:

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

    PostmortemTemplateResponse data, response status code and response headers



3552
3553
3554
3555
3556
3557
3558
3559
3560
3561
3562
3563
3564
3565
3566
3567
3568
3569
3570
3571
3572
3573
3574
3575
3576
3577
3578
3579
3580
3581
3582
3583
3584
3585
3586
3587
3588
3589
3590
3591
3592
3593
3594
3595
3596
3597
3598
3599
3600
3601
3602
3603
3604
3605
3606
3607
3608
3609
3610
3611
3612
 
# File 'lib/datadog_api_client/v2/api/incidents_api.rb', line 3552

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

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: IncidentsAPI.update_incident_postmortem_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 IncidentsAPI.update_incident_postmortem_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 IncidentsAPI.update_incident_postmortem_template"
  end
  # resource path
  local_var_path = '/api/v2/incidents/config/postmortem-templates/{template_id}'.sub('{template_id}', CGI.escape(template_id.to_s).gsub('%2F', '/'))

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

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

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

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

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

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

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

#update_incident_todo(incident_id, todo_id, body, opts = {}) ⇒ Object

Update an incident todo.

See Also:



1651
1652
1653
1654
 
# File 'lib/datadog_api_client/v2/api/incidents_api.rb', line 1651

def update_incident_todo(incident_id, todo_id, body, opts = {})
  data, _status_code, _headers = update_incident_todo_with_http_info(incident_id, todo_id, body, opts)
  data
end

#update_incident_todo_with_http_info(incident_id, todo_id, body, opts = {}) ⇒ Array<(IncidentTodoResponse, Integer, Hash)>

Update an incident todo.

Update an incident todo.

Parameters:

  • incident_id (String) —

    The UUID of the incident.

  • todo_id (String) —

    The UUID of the incident todo.

  • body (IncidentTodoPatchRequest) —

    Incident todo payload.

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

    the optional parameters

Returns:

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

    IncidentTodoResponse data, response status code and response headers



1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
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
 
# File 'lib/datadog_api_client/v2/api/incidents_api.rb', line 1665

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

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

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

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

#update_incident_type(incident_type_id, body, opts = {}) ⇒ Object

Update an incident type.

See Also:



1734
1735
1736
1737
 
# File 'lib/datadog_api_client/v2/api/incidents_api.rb', line 1734

def update_incident_type(incident_type_id, body, opts = {})
  data, _status_code, _headers = update_incident_type_with_http_info(incident_type_id, body, opts)
  data
end

#update_incident_type_with_http_info(incident_type_id, body, opts = {}) ⇒ Array<(IncidentTypeResponse, Integer, Hash)>

Update an incident type.

Update an incident type.

Parameters:

  • incident_type_id (String) —

    The UUID of the incident type.

  • body (IncidentTypePatchRequest) —

    Incident type payload.

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

    the optional parameters

Returns:

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

    IncidentTypeResponse data, response status code and response headers



1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
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
 
# File 'lib/datadog_api_client/v2/api/incidents_api.rb', line 1747

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

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

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

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

#update_incident_with_http_info(incident_id, body, opts = {}) ⇒ Array<(IncidentResponse, Integer, Hash)>

Update an existing incident.

Updates an incident. Provide only the attributes that should be updated as this request is a partial update.

Parameters:

  • incident_id (String) —

    The UUID of the incident.

  • body (IncidentUpdateRequest) —

    Incident Payload.

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

    the optional parameters

Options Hash (opts):

  • :include (Array<IncidentRelatedObject>) —

    Specifies which types of related objects should be included in the response.

Returns:

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

    IncidentResponse 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
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
 
# File 'lib/datadog_api_client/v2/api/incidents_api.rb', line 1422

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

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

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'include'] = @api_client.build_collection_param(opts[:'include'], :csv) 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] || 'IncidentResponse'

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

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