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

Create an incident.

See Also:



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

def create_incident(body, opts = {})
  data, _status_code, _headers = create_incident_with_http_info(body, opts)
  data
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_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_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



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

def create_incident_with_http_info(body, opts = {})

  if @api_client.config.unstable_operations.has_key?(:create_incident)
    unstable_enabled = @api_client.config.unstable_operations[:create_incident]
    if unstable_enabled
      @api_client.config.logger.warn format("Using unstable operation '%s'", "create_incident")
    else
      raise APIError.new(message: format("Unstable operation '%s' is disabled", "create_incident"))
    end
  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] || [:AuthZ, :apiKeyAuth, :appKeyAuth]

  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
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: IncidentsAPI#create_incident\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:



105
106
107
108
 
# File 'lib/datadog_api_client/v2/api/incidents_api.rb', line 105

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

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

Delete an incident integration metadata.

See Also:



329
330
331
332
 
# File 'lib/datadog_api_client/v2/api/incidents_api.rb', line 329

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



342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
 
# File 'lib/datadog_api_client/v2/api/incidents_api.rb', line 342

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_todo(incident_id, todo_id, opts = {}) ⇒ Object

Delete an incident todo.

See Also:



405
406
407
408
 
# File 'lib/datadog_api_client/v2/api/incidents_api.rb', line 405

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



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

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



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

def delete_incident_with_http_info(incident_id, opts = {})

  if @api_client.config.unstable_operations.has_key?(:delete_incident)
    unstable_enabled = @api_client.config.unstable_operations[:delete_incident]
    if unstable_enabled
      @api_client.config.logger.warn format("Using unstable operation '%s'", "delete_incident")
    else
      raise APIError.new(message: format("Unstable operation '%s' is disabled", "delete_incident"))
    end
  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))

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

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

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

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

  # return_type
  return_type = opts[:debug_return_type]

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

  new_options = opts.merge(
    :operation => :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
  )

  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: IncidentsAPI#delete_incident\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:



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

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:



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

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:



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
621
622
623
624
625
 
# File 'lib/datadog_api_client/v2/api/incidents_api.rb', line 567

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_todo(incident_id, todo_id, opts = {}) ⇒ Object

Get incident todo details.

See Also:



630
631
632
633
 
# File 'lib/datadog_api_client/v2/api/incidents_api.rb', line 630

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



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
694
695
696
697
698
699
700
701
 
# File 'lib/datadog_api_client/v2/api/incidents_api.rb', line 643

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



190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
 
# File 'lib/datadog_api_client/v2/api/incidents_api.rb', line 190

def get_incident_with_http_info(incident_id, opts = {})

  if @api_client.config.unstable_operations.has_key?(:get_incident)
    unstable_enabled = @api_client.config.unstable_operations[:get_incident]
    if unstable_enabled
      @api_client.config.logger.warn format("Using unstable operation '%s'", "get_incident")
    else
      raise APIError.new(message: format("Unstable operation '%s' is disabled", "get_incident"))
    end
  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))

  # 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] || [:AuthZ, :apiKeyAuth, :appKeyAuth]

  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
  )

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

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

Get a list of attachments.

See Also:



706
707
708
709
 
# File 'lib/datadog_api_client/v2/api/incidents_api.rb', line 706

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

Get a list of attachments.

Get all attachments for a given incident.

Parameters:

  • incident_id (String) —

    The UUID of the incident.

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

    the optional parameters

Options Hash (opts):

Returns:

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

    IncidentAttachmentsResponse data, response status code and response headers



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
770
771
772
773
774
775
776
 
# File 'lib/datadog_api_client/v2/api/incidents_api.rb', line 720

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, :AuthZ]

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

Get a list of an incident's integration metadata.

See Also:



781
782
783
784
 
# File 'lib/datadog_api_client/v2/api/incidents_api.rb', line 781

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:



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

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

Get a list of an incident's todos.

See Also:



945
946
947
948
 
# File 'lib/datadog_api_client/v2/api/incidents_api.rb', line 945

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



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
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
 
# File 'lib/datadog_api_client/v2/api/incidents_api.rb', line 957

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

Get a list of incidents.

See Also:



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

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



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

def list_incidents_with_http_info(opts = {})

  if @api_client.config.unstable_operations.has_key?(:list_incidents)
    unstable_enabled = @api_client.config.unstable_operations[:list_incidents]
    if unstable_enabled
      @api_client.config.logger.warn format("Using unstable operation '%s'", "list_incidents")
    else
      raise APIError.new(message: format("Unstable operation '%s' is disabled", "list_incidents"))
    end
  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] || [:AuthZ, :apiKeyAuth, :appKeyAuth]

  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
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: 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:



928
929
930
931
932
933
934
935
936
937
938
939
940
 
# File 'lib/datadog_api_client/v2/api/incidents_api.rb', line 928

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:



1016
1017
1018
1019
 
# File 'lib/datadog_api_client/v2/api/incidents_api.rb', line 1016

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



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
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
 
# File 'lib/datadog_api_client/v2/api/incidents_api.rb', line 1032

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:



1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
 
# File 'lib/datadog_api_client/v2/api/incidents_api.rb', line 1108

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

Update an existing incident.

See Also:



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

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

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

Create, update, and delete incident attachments.

See Also:



1205
1206
1207
1208
 
# File 'lib/datadog_api_client/v2/api/incidents_api.rb', line 1205

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:



1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
 
# File 'lib/datadog_api_client/v2/api/incidents_api.rb', line 1219

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:



1285
1286
1287
1288
 
# File 'lib/datadog_api_client/v2/api/incidents_api.rb', line 1285

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:



1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
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
 
# File 'lib/datadog_api_client/v2/api/incidents_api.rb', line 1299

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_todo(incident_id, todo_id, body, opts = {}) ⇒ Object

Update an incident todo.

See Also:



1368
1369
1370
1371
 
# File 'lib/datadog_api_client/v2/api/incidents_api.rb', line 1368

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



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
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
 
# File 'lib/datadog_api_client/v2/api/incidents_api.rb', line 1382

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



342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
 
# File 'lib/datadog_api_client/v2/api/incidents_api.rb', line 342

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

  if @api_client.config.unstable_operations.has_key?(:update_incident)
    unstable_enabled = @api_client.config.unstable_operations[:update_incident]
    if unstable_enabled
      @api_client.config.logger.warn format("Using unstable operation '%s'", "update_incident")
    else
      raise APIError.new(message: format("Unstable operation '%s' is disabled", "update_incident"))
    end
  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))

  # 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] || [:AuthZ, :apiKeyAuth, :appKeyAuth]

  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
  )

  data, status_code, headers = @api_client.call_api(: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