Class: DatadogAPIClient::V2::AppBuilderAPI

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

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

Returns a new instance of AppBuilderAPI.



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

def api_client
  @api_client
end

Instance Method Details

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

Create App.

See Also:



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

def create_app(body, opts = {})
  data, _status_code, _headers = create_app_with_http_info(body, opts)
  data
end

#create_app_with_http_info(body, opts = {}) ⇒ Array<(CreateAppResponse, Integer, Hash)>

Create App.

Create a new app, returning the app ID. This API requires a registered application key. Alternatively, you can configure these permissions in the UI.

Parameters:

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

    the optional parameters

Returns:

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

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

def create_app_with_http_info(body, opts = {})

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AppBuilderAPI.create_app ...'
  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 AppBuilderAPI.create_app"
  end
  # resource path
  local_var_path = '/api/v2/app-builder/apps'

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

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

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

#create_publish_request(app_id, body, opts = {}) ⇒ Object

Create Publish Request.

See Also:



96
97
98
99
 
# File 'lib/datadog_api_client/v2/api/app_builder_api.rb', line 96

def create_publish_request(app_id, body, opts = {})
  data, _status_code, _headers = create_publish_request_with_http_info(app_id, body, opts)
  data
end

#create_publish_request_with_http_info(app_id, body, opts = {}) ⇒ Array<(PublishAppResponse, Integer, Hash)>

Create Publish Request.

Create a publish request to ask for approval to publish an app whose protection level is approval_required. Publishing happens automatically once the request is approved by a user with the appropriate permissions.

Parameters:

Returns:

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

    PublishAppResponse data, response status code and response headers



109
110
111
112
113
114
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
 
# File 'lib/datadog_api_client/v2/api/app_builder_api.rb', line 109

def create_publish_request_with_http_info(app_id, body, opts = {})

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AppBuilderAPI.create_publish_request ...'
  end
  # verify the required parameter 'app_id' is set
  if @api_client.config.client_side_validation && app_id.nil?
    fail ArgumentError, "Missing the required parameter 'app_id' when calling AppBuilderAPI.create_publish_request"
  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 AppBuilderAPI.create_publish_request"
  end
  # resource path
  local_var_path = '/api/v2/app-builder/apps/{app_id}/publish-request'.sub('{app_id}', CGI.escape(app_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] || 'PublishAppResponse'

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

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

#delete_app(app_id, opts = {}) ⇒ Object

Delete App.

See Also:



168
169
170
171
 
# File 'lib/datadog_api_client/v2/api/app_builder_api.rb', line 168

def delete_app(app_id, opts = {})
  data, _status_code, _headers = delete_app_with_http_info(app_id, opts)
  data
end

#delete_app_with_http_info(app_id, opts = {}) ⇒ Array<(DeleteAppResponse, Integer, Hash)>

Delete App.

Delete a single app. This API requires a registered application key. Alternatively, you can configure these permissions in the UI.

Parameters:

  • app_id (UUID) —

    The ID of the app to delete.

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

    the optional parameters

Returns:

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

    DeleteAppResponse data, response status code and response headers



180
181
182
183
184
185
186
187
188
189
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
 
# File 'lib/datadog_api_client/v2/api/app_builder_api.rb', line 180

def delete_app_with_http_info(app_id, opts = {})

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AppBuilderAPI.delete_app ...'
  end
  # verify the required parameter 'app_id' is set
  if @api_client.config.client_side_validation && app_id.nil?
    fail ArgumentError, "Missing the required parameter 'app_id' when calling AppBuilderAPI.delete_app"
  end
  # resource path
  local_var_path = '/api/v2/app-builder/apps/{app_id}'.sub('{app_id}', CGI.escape(app_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] || 'DeleteAppResponse'

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

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

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

Delete Multiple Apps.

See Also:



233
234
235
236
 
# File 'lib/datadog_api_client/v2/api/app_builder_api.rb', line 233

def delete_apps(body, opts = {})
  data, _status_code, _headers = delete_apps_with_http_info(body, opts)
  data
end

#delete_apps_with_http_info(body, opts = {}) ⇒ Array<(DeleteAppsResponse, Integer, Hash)>

Delete Multiple Apps.

Delete multiple apps in a single request from a list of app IDs. This API requires a registered application key. Alternatively, you can configure these permissions in the UI.

Parameters:

Returns:

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

    DeleteAppsResponse data, response status code and response headers



245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
 
# File 'lib/datadog_api_client/v2/api/app_builder_api.rb', line 245

def delete_apps_with_http_info(body, opts = {})

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AppBuilderAPI.delete_apps ...'
  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 AppBuilderAPI.delete_apps"
  end
  # resource path
  local_var_path = '/api/v2/app-builder/apps'

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

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

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

#get_app(app_id, opts = {}) ⇒ Object

Get App.

See Also:



300
301
302
303
 
# File 'lib/datadog_api_client/v2/api/app_builder_api.rb', line 300

def get_app(app_id, opts = {})
  data, _status_code, _headers = get_app_with_http_info(app_id, opts)
  data
end

#get_app_with_http_info(app_id, opts = {}) ⇒ Array<(GetAppResponse, Integer, Hash)>

Get App.

Get the full definition of an app. This API requires a registered application key. Alternatively, you can configure these permissions in the UI.

Parameters:

  • app_id (UUID) —

    The ID of the app to retrieve.

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

    the optional parameters

Options Hash (opts):

  • :version (String) —

    The version number of the app to retrieve. If not specified, the latest version is returned. Version numbers start at 1 and increment with each update. The special values latest and deployed can be used to retrieve the latest version or the published version, respectively.

Returns:

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

    GetAppResponse data, response status code and response headers



313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
 
# File 'lib/datadog_api_client/v2/api/app_builder_api.rb', line 313

def get_app_with_http_info(app_id, opts = {})

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

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

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

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

#get_blueprint(blueprint_id, opts = {}) ⇒ Object

Get Blueprint.

See Also:



367
368
369
370
 
# File 'lib/datadog_api_client/v2/api/app_builder_api.rb', line 367

def get_blueprint(blueprint_id, opts = {})
  data, _status_code, _headers = get_blueprint_with_http_info(blueprint_id, opts)
  data
end

#get_blueprint_with_http_info(blueprint_id, opts = {}) ⇒ Array<(GetBlueprintResponse, Integer, Hash)>

Get Blueprint.

Retrieve an app blueprint by its ID.

Parameters:

  • blueprint_id (UUID) —

    The ID of the blueprint to retrieve.

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

    the optional parameters

Returns:

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

    GetBlueprintResponse data, response status code and response headers



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
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
 
# File 'lib/datadog_api_client/v2/api/app_builder_api.rb', line 379

def get_blueprint_with_http_info(blueprint_id, opts = {})

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AppBuilderAPI.get_blueprint ...'
  end
  # verify the required parameter 'blueprint_id' is set
  if @api_client.config.client_side_validation && blueprint_id.nil?
    fail ArgumentError, "Missing the required parameter 'blueprint_id' when calling AppBuilderAPI.get_blueprint"
  end
  # resource path
  local_var_path = '/api/v2/app-builder/blueprint/{blueprint_id}'.sub('{blueprint_id}', CGI.escape(blueprint_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] || 'GetBlueprintResponse'

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

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

#get_blueprints_by_integration_id(integration_id, opts = {}) ⇒ Object

Get Blueprints by Integration ID.

See Also:



432
433
434
435
 
# File 'lib/datadog_api_client/v2/api/app_builder_api.rb', line 432

def get_blueprints_by_integration_id(integration_id, opts = {})
  data, _status_code, _headers = get_blueprints_by_integration_id_with_http_info(integration_id, opts)
  data
end

#get_blueprints_by_integration_id_with_http_info(integration_id, opts = {}) ⇒ Array<(GetBlueprintsResponse, Integer, Hash)>

Get Blueprints by Integration ID.

List app blueprints associated with a specific integration ID.

Parameters:

  • integration_id (String) —

    The integration ID to filter blueprints by.

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

    the optional parameters

Returns:

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

    GetBlueprintsResponse data, response status code and response headers



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
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
 
# File 'lib/datadog_api_client/v2/api/app_builder_api.rb', line 444

def get_blueprints_by_integration_id_with_http_info(integration_id, opts = {})

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AppBuilderAPI.get_blueprints_by_integration_id ...'
  end
  # verify the required parameter 'integration_id' is set
  if @api_client.config.client_side_validation && integration_id.nil?
    fail ArgumentError, "Missing the required parameter 'integration_id' when calling AppBuilderAPI.get_blueprints_by_integration_id"
  end
  # resource path
  local_var_path = '/api/v2/app-builder/blueprints/integration-id/{integration_id}'.sub('{integration_id}', CGI.escape(integration_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] || 'GetBlueprintsResponse'

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

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

#get_blueprints_by_slugs(slugs, opts = {}) ⇒ Object

Get Blueprints by Slugs.

See Also:



497
498
499
500
 
# File 'lib/datadog_api_client/v2/api/app_builder_api.rb', line 497

def get_blueprints_by_slugs(slugs, opts = {})
  data, _status_code, _headers = get_blueprints_by_slugs_with_http_info(slugs, opts)
  data
end

#get_blueprints_by_slugs_with_http_info(slugs, opts = {}) ⇒ Array<(GetBlueprintsResponse, Integer, Hash)>

Get Blueprints by Slugs.

Retrieve app blueprints by their slugs.

Parameters:

  • slugs (String) —

    A comma-separated list of blueprint slugs.

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

    the optional parameters

Returns:

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

    GetBlueprintsResponse data, response status code and response headers



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
551
552
553
554
555
556
557
 
# File 'lib/datadog_api_client/v2/api/app_builder_api.rb', line 509

def get_blueprints_by_slugs_with_http_info(slugs, opts = {})

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

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

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

#list_app_versions(app_id, opts = {}) ⇒ Object

List App Versions.

See Also:



644
645
646
647
 
# File 'lib/datadog_api_client/v2/api/app_builder_api.rb', line 644

def list_app_versions(app_id, opts = {})
  data, _status_code, _headers = list_app_versions_with_http_info(app_id, opts)
  data
end

#list_app_versions_with_http_info(app_id, opts = {}) ⇒ Array<(ListAppVersionsResponse, Integer, Hash)>

List App Versions.

List the versions of an app. This endpoint is paginated.

Parameters:

  • app_id (UUID) —

    The ID of the app.

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

    the optional parameters

Options Hash (opts):

  • :limit (Integer) —

    The number of versions to return per page.

  • :page (Integer) —

    The page number to return.

Returns:

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

    ListAppVersionsResponse data, response status code and response headers



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
706
707
708
 
# File 'lib/datadog_api_client/v2/api/app_builder_api.rb', line 658

def list_app_versions_with_http_info(app_id, opts = {})

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

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

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

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

#list_apps(opts = {}) ⇒ Object

List Apps.

See Also:



562
563
564
565
 
# File 'lib/datadog_api_client/v2/api/app_builder_api.rb', line 562

def list_apps(opts = {})
  data, _status_code, _headers = list_apps_with_http_info(opts)
  data
end

#list_apps_with_http_info(opts = {}) ⇒ Array<(ListAppsResponse, Integer, Hash)>

List Apps.

List all apps, with optional filters and sorting. This endpoint is paginated. Only basic app information such as the app ID, name, and description is returned by this endpoint. This API requires a registered application key. Alternatively, you can configure these permissions in the UI.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :limit (Integer) —

    The number of apps to return per page.

  • :page (Integer) —

    The page number to return.

  • :filter_user_name (String) —

    Filter apps by the app creator. Usually the user's email.

  • :filter_user_uuid (UUID) —

    Filter apps by the app creator's UUID.

  • :filter_name (String) —

    Filter by app name.

  • :filter_query (String) —

    Filter apps by the app name or the app creator.

  • :filter_deployed (Boolean) —

    Filter apps by whether they are published.

  • :filter_tags (String) —

    Filter apps by tags.

  • :filter_favorite (Boolean) —

    Filter apps by whether you have added them to your favorites.

  • :filter_self_service (Boolean) —

    Filter apps by whether they are enabled for self-service.

  • :sort (Array<AppsSortField>) —

    The fields and direction to sort apps by.

Returns:

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

    ListAppsResponse data, response status code and response headers



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
633
634
635
636
637
638
639
 
# File 'lib/datadog_api_client/v2/api/app_builder_api.rb', line 584

def list_apps_with_http_info(opts = {})

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AppBuilderAPI.list_apps ...'
  end
  # resource path
  local_var_path = '/api/v2/app-builder/apps'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'filter[user_name]'] = opts[:'filter_user_name'] if !opts[:'filter_user_name'].nil?
  query_params[:'filter[user_uuid]'] = opts[:'filter_user_uuid'] if !opts[:'filter_user_uuid'].nil?
  query_params[:'filter[name]'] = opts[:'filter_name'] if !opts[:'filter_name'].nil?
  query_params[:'filter[query]'] = opts[:'filter_query'] if !opts[:'filter_query'].nil?
  query_params[:'filter[deployed]'] = opts[:'filter_deployed'] if !opts[:'filter_deployed'].nil?
  query_params[:'filter[tags]'] = opts[:'filter_tags'] if !opts[:'filter_tags'].nil?
  query_params[:'filter[favorite]'] = opts[:'filter_favorite'] if !opts[:'filter_favorite'].nil?
  query_params[:'filter[self_service]'] = opts[:'filter_self_service'] if !opts[:'filter_self_service'].nil?
  query_params[:'sort'] = @api_client.build_collection_param(opts[:'sort'], :csv) if !opts[:'sort'].nil?

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

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

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

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

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

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

#list_blueprints(opts = {}) ⇒ Object

List Blueprints.

See Also:



713
714
715
716
 
# File 'lib/datadog_api_client/v2/api/app_builder_api.rb', line 713

def list_blueprints(opts = {})
  data, _status_code, _headers = list_blueprints_with_http_info(opts)
  data
end

#list_blueprints_with_http_info(opts = {}) ⇒ Array<(ListBlueprintsResponse, Integer, Hash)>

List Blueprints.

List available app blueprints.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :limit (Integer) —

    The number of blueprints to return per page. Defaults to 10. Maximum is 100.

  • :page (Integer) —

    The page of results to return. Starts at 0.

Returns:

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

    ListBlueprintsResponse data, response status code and response headers



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

def list_blueprints_with_http_info(opts = {})

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AppBuilderAPI.list_blueprints ...'
  end
  # resource path
  local_var_path = '/api/v2/app-builder/blueprints'

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

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

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

#list_tags(opts = {}) ⇒ Object

List Tags.

See Also:



777
778
779
780
 
# File 'lib/datadog_api_client/v2/api/app_builder_api.rb', line 777

def list_tags(opts = {})
  data, _status_code, _headers = list_tags_with_http_info(opts)
  data
end

#list_tags_with_http_info(opts = {}) ⇒ Array<(AppBuilderListTagsResponse, Integer, Hash)>

List Tags.

List all tags associated with the authenticated user's apps.

Parameters:

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

    the optional parameters

Returns:

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

    AppBuilderListTagsResponse data, response status code and response headers



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

def list_tags_with_http_info(opts = {})

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AppBuilderAPI.list_tags ...'
  end
  # resource path
  local_var_path = '/api/v2/app-builder/tags'

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

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

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

#publish_app(app_id, opts = {}) ⇒ Object

Publish App.

See Also:



837
838
839
840
 
# File 'lib/datadog_api_client/v2/api/app_builder_api.rb', line 837

def publish_app(app_id, opts = {})
  data, _status_code, _headers = publish_app_with_http_info(app_id, opts)
  data
end

#publish_app_with_http_info(app_id, opts = {}) ⇒ Array<(PublishAppResponse, Integer, Hash)>

Publish App.

Publish an app for use by other users. To ensure the app is accessible to the correct users, you also need to set a Restriction Policy on the app if a policy does not yet exist. This API requires a registered application key. Alternatively, you can configure these permissions in the UI.

Parameters:

  • app_id (UUID) —

    The ID of the app to publish.

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

    the optional parameters

Returns:

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

    PublishAppResponse data, response status code and response headers



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

def publish_app_with_http_info(app_id, opts = {})

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AppBuilderAPI.publish_app ...'
  end
  # verify the required parameter 'app_id' is set
  if @api_client.config.client_side_validation && app_id.nil?
    fail ArgumentError, "Missing the required parameter 'app_id' when calling AppBuilderAPI.publish_app"
  end
  # resource path
  local_var_path = '/api/v2/app-builder/apps/{app_id}/deployment'.sub('{app_id}', CGI.escape(app_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] || 'PublishAppResponse'

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

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

#revert_app(app_id, version, opts = {}) ⇒ Object

Revert App.

See Also:



902
903
904
905
 
# File 'lib/datadog_api_client/v2/api/app_builder_api.rb', line 902

def revert_app(app_id, version, opts = {})
  data, _status_code, _headers = revert_app_with_http_info(app_id, version, opts)
  data
end

#revert_app_with_http_info(app_id, version, opts = {}) ⇒ Array<(UpdateAppResponse, Integer, Hash)>

Revert App.

Revert an app to a previous version. The version to revert to is selected through the version query parameter. The reverted version becomes the new latest version of the app.

Parameters:

  • app_id (UUID) —

    The ID of the app.

  • version (String) —

    The version number of the app to revert to. Cannot be latest. The special value deployed can be used to revert to the currently published version.

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

    the optional parameters

Returns:

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

    UpdateAppResponse data, response status code and response headers



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

def revert_app_with_http_info(app_id, version, opts = {})

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AppBuilderAPI.revert_app ...'
  end
  # verify the required parameter 'app_id' is set
  if @api_client.config.client_side_validation && app_id.nil?
    fail ArgumentError, "Missing the required parameter 'app_id' when calling AppBuilderAPI.revert_app"
  end
  # verify the required parameter 'version' is set
  if @api_client.config.client_side_validation && version.nil?
    fail ArgumentError, "Missing the required parameter 'version' when calling AppBuilderAPI.revert_app"
  end
  # resource path
  local_var_path = '/api/v2/app-builder/apps/{app_id}/revert'.sub('{app_id}', CGI.escape(app_id.to_s).gsub('%2F', '/'))

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

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

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

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

#unpublish_app(app_id, opts = {}) ⇒ Object

Unpublish App.

See Also:



973
974
975
976
 
# File 'lib/datadog_api_client/v2/api/app_builder_api.rb', line 973

def unpublish_app(app_id, opts = {})
  data, _status_code, _headers = unpublish_app_with_http_info(app_id, opts)
  data
end

#unpublish_app_with_http_info(app_id, opts = {}) ⇒ Array<(UnpublishAppResponse, Integer, Hash)>

Unpublish App.

Unpublish an app, removing the live version of the app. Unpublishing creates a new instance of a deployment object on the app, with a nil app_version_id (00000000-0000-0000-0000-000000000000). The app can still be updated and published again in the future. This API requires a registered application key. Alternatively, you can configure these permissions in the UI.

Parameters:

  • app_id (UUID) —

    The ID of the app to unpublish.

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

    the optional parameters

Returns:

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

    UnpublishAppResponse data, response status code and response headers



985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
 
# File 'lib/datadog_api_client/v2/api/app_builder_api.rb', line 985

def unpublish_app_with_http_info(app_id, opts = {})

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AppBuilderAPI.unpublish_app ...'
  end
  # verify the required parameter 'app_id' is set
  if @api_client.config.client_side_validation && app_id.nil?
    fail ArgumentError, "Missing the required parameter 'app_id' when calling AppBuilderAPI.unpublish_app"
  end
  # resource path
  local_var_path = '/api/v2/app-builder/apps/{app_id}/deployment'.sub('{app_id}', CGI.escape(app_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] || 'UnpublishAppResponse'

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

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

#update_app(app_id, body, opts = {}) ⇒ Object

Update App.

See Also:



1038
1039
1040
1041
 
# File 'lib/datadog_api_client/v2/api/app_builder_api.rb', line 1038

def update_app(app_id, body, opts = {})
  data, _status_code, _headers = update_app_with_http_info(app_id, body, opts)
  data
end

#update_app_favorite(app_id, body, opts = {}) ⇒ Object

Update App Favorite Status.

See Also:



1110
1111
1112
1113
 
# File 'lib/datadog_api_client/v2/api/app_builder_api.rb', line 1110

def update_app_favorite(app_id, body, opts = {})
  update_app_favorite_with_http_info(app_id, body, opts)
  nil
end

#update_app_favorite_with_http_info(app_id, body, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Update App Favorite Status.

Add or remove an app from the current user's favorites. Favorited apps can be filtered for using the filter[favorite] query parameter on the List Apps endpoint.

Parameters:

  • app_id (UUID) —

    The ID of the app.

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
 
# File 'lib/datadog_api_client/v2/api/app_builder_api.rb', line 1123

def update_app_favorite_with_http_info(app_id, body, opts = {})

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

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

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

#update_app_self_service(app_id, body, opts = {}) ⇒ Object

Update App Self-Service Status.

See Also:



1182
1183
1184
1185
 
# File 'lib/datadog_api_client/v2/api/app_builder_api.rb', line 1182

def update_app_self_service(app_id, body, opts = {})
  update_app_self_service_with_http_info(app_id, body, opts)
  nil
end

#update_app_self_service_with_http_info(app_id, body, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Update App Self-Service Status.

Enable or disable self-service for an app. Self-service apps can be discovered and run by users in your organization without explicit access being granted.

Parameters:

Returns:

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

    nil, response status code and response headers



1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
 
# File 'lib/datadog_api_client/v2/api/app_builder_api.rb', line 1195

def update_app_self_service_with_http_info(app_id, body, opts = {})

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AppBuilderAPI.update_app_self_service ...'
  end
  # verify the required parameter 'app_id' is set
  if @api_client.config.client_side_validation && app_id.nil?
    fail ArgumentError, "Missing the required parameter 'app_id' when calling AppBuilderAPI.update_app_self_service"
  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 AppBuilderAPI.update_app_self_service"
  end
  # resource path
  local_var_path = '/api/v2/app-builder/apps/{app_id}/self-service'.sub('{app_id}', CGI.escape(app_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(['*/*'])
  # 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]

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

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

#update_app_tags(app_id, body, opts = {}) ⇒ Object

Update App Tags.

See Also:



1254
1255
1256
1257
 
# File 'lib/datadog_api_client/v2/api/app_builder_api.rb', line 1254

def update_app_tags(app_id, body, opts = {})
  update_app_tags_with_http_info(app_id, body, opts)
  nil
end

#update_app_tags_with_http_info(app_id, body, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Update App Tags.

Replace the tags on an app. The provided list overwrites the existing tags entirely; tags not present in the request body are removed.

Parameters:

  • app_id (UUID) —

    The ID of the app.

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
 
# File 'lib/datadog_api_client/v2/api/app_builder_api.rb', line 1267

def update_app_tags_with_http_info(app_id, body, opts = {})

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

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

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

#update_app_version_name(app_id, version, body, opts = {}) ⇒ Object

Name App Version.

See Also:



1326
1327
1328
1329
 
# File 'lib/datadog_api_client/v2/api/app_builder_api.rb', line 1326

def update_app_version_name(app_id, version, body, opts = {})
  update_app_version_name_with_http_info(app_id, version, body, opts)
  nil
end

#update_app_version_name_with_http_info(app_id, version, body, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Name App Version.

Assign a human-readable name to a specific version of an app. The version is selected through the version query parameter.

Parameters:

  • app_id (UUID) —

    The ID of the app.

  • version (String) —

    The version number of the app to name. The special values latest and deployed can also be used to target the latest or currently published version.

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



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
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
 
# File 'lib/datadog_api_client/v2/api/app_builder_api.rb', line 1340

def update_app_version_name_with_http_info(app_id, version, body, opts = {})

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

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

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['*/*'])
  # 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]

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

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

#update_app_with_http_info(app_id, body, opts = {}) ⇒ Array<(UpdateAppResponse, Integer, Hash)>

Update App.

Update an existing app. This creates a new version of the app. This API requires a registered application key. Alternatively, you can configure these permissions in the UI.

Parameters:

  • app_id (UUID) —

    The ID of the app to update.

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

    the optional parameters

Returns:

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

    UpdateAppResponse data, response status code and response headers



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
1100
1101
1102
1103
1104
1105
 
# File 'lib/datadog_api_client/v2/api/app_builder_api.rb', line 1051

def update_app_with_http_info(app_id, body, opts = {})

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AppBuilderAPI.update_app ...'
  end
  # verify the required parameter 'app_id' is set
  if @api_client.config.client_side_validation && app_id.nil?
    fail ArgumentError, "Missing the required parameter 'app_id' when calling AppBuilderAPI.update_app"
  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 AppBuilderAPI.update_app"
  end
  # resource path
  local_var_path = '/api/v2/app-builder/apps/{app_id}'.sub('{app_id}', CGI.escape(app_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] || 'UpdateAppResponse'

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

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

#update_protection_level(app_id, body, opts = {}) ⇒ Object

Update App Protection Level.

See Also:



1404
1405
1406
1407
 
# File 'lib/datadog_api_client/v2/api/app_builder_api.rb', line 1404

def update_protection_level(app_id, body, opts = {})
  data, _status_code, _headers = update_protection_level_with_http_info(app_id, body, opts)
  data
end

#update_protection_level_with_http_info(app_id, body, opts = {}) ⇒ Array<(UpdateAppResponse, Integer, Hash)>

Update App Protection Level.

Update the publication protection level of an app. When set to approval_required, future publishes must go through an approval workflow before going live.

Parameters:

Returns:

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

    UpdateAppResponse data, response status code and response headers



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
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
 
# File 'lib/datadog_api_client/v2/api/app_builder_api.rb', line 1417

def update_protection_level_with_http_info(app_id, body, opts = {})

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AppBuilderAPI.update_protection_level ...'
  end
  # verify the required parameter 'app_id' is set
  if @api_client.config.client_side_validation && app_id.nil?
    fail ArgumentError, "Missing the required parameter 'app_id' when calling AppBuilderAPI.update_protection_level"
  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 AppBuilderAPI.update_protection_level"
  end
  # resource path
  local_var_path = '/api/v2/app-builder/apps/{app_id}/protection-level'.sub('{app_id}', CGI.escape(app_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] || 'UpdateAppResponse'

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

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