Class: DatadogAPIClient::V1::KeyManagementAPI

Inherits:
Object
  • Object
show all
Defined in:
lib/datadog_api_client/v1/api/key_management_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

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

Returns a new instance of KeyManagementAPI.



22
23
24
 
# File 'lib/datadog_api_client/v1/api/key_management_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/v1/api/key_management_api.rb', line 20

def api_client
  @api_client
end

Instance Method Details

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

Create an API key.

See Also:



30
31
32
33
 
# File 'lib/datadog_api_client/v1/api/key_management_api.rb', line 30

def create_api_key(body, opts = {})
  data, _status_code, _headers = create_api_key_with_http_info(body, opts)
  data
end

#create_api_key_with_http_info(body, opts = {}) ⇒ Array<(ApiKeyResponse, Integer, Hash)>

Create an API key.

Creates an API key with a given name.

Parameters:

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

    the optional parameters

Returns:

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

    ApiKeyResponse 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/v1/api/key_management_api.rb', line 40

def create_api_key_with_http_info(body, opts = {})

  if @api_client.config.unstable_operations.has_key?(:create_api_key)
    unstable_enabled = @api_client.config.unstable_operations[:create_api_key]
    if unstable_enabled
      @api_client.config.logger.warn format("Using unstable operation '%s'", "create_api_key")
    else
      raise APIError.new(message: format("Unstable operation '%s' is disabled", "create_api_key"))
    end
  end

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: KeyManagementAPI.create_api_key ...'
  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 KeyManagementAPI.create_api_key"
  end
  # resource path
  local_var_path = '/api/v1/api_key'

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

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

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

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

Create an application key.

See Also:



105
106
107
108
 
# File 'lib/datadog_api_client/v1/api/key_management_api.rb', line 105

def create_application_key(body, opts = {})
  data, _status_code, _headers = create_application_key_with_http_info(body, opts)
  data
end

#create_application_key_with_http_info(body, opts = {}) ⇒ Array<(ApplicationKeyResponse, Integer, Hash)>

Create an application key.

Create an application key with a given name.

Parameters:

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

    the optional parameters

Returns:

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

    ApplicationKeyResponse data, 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
172
173
 
# File 'lib/datadog_api_client/v1/api/key_management_api.rb', line 115

def create_application_key_with_http_info(body, opts = {})

  if @api_client.config.unstable_operations.has_key?(:create_application_key)
    unstable_enabled = @api_client.config.unstable_operations[:create_application_key]
    if unstable_enabled
      @api_client.config.logger.warn format("Using unstable operation '%s'", "create_application_key")
    else
      raise APIError.new(message: format("Unstable operation '%s' is disabled", "create_application_key"))
    end
  end

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: KeyManagementAPI.create_application_key ...'
  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 KeyManagementAPI.create_application_key"
  end
  # resource path
  local_var_path = '/api/v1/application_key'

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

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

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

#delete_api_key(key, opts = {}) ⇒ Object

Delete an API key.

See Also:



180
181
182
183
 
# File 'lib/datadog_api_client/v1/api/key_management_api.rb', line 180

def delete_api_key(key, opts = {})
  data, _status_code, _headers = delete_api_key_with_http_info(key, opts)
  data
end

#delete_api_key_with_http_info(key, opts = {}) ⇒ Array<(ApiKeyResponse, Integer, Hash)>

Delete an API key.

Delete a given API key.

Parameters:

  • key (String) —

    The specific API key you are working with.

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

    the optional parameters

Returns:

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

    ApiKeyResponse 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
 
# File 'lib/datadog_api_client/v1/api/key_management_api.rb', line 190

def delete_api_key_with_http_info(key, opts = {})

  if @api_client.config.unstable_operations.has_key?(:delete_api_key)
    unstable_enabled = @api_client.config.unstable_operations[:delete_api_key]
    if unstable_enabled
      @api_client.config.logger.warn format("Using unstable operation '%s'", "delete_api_key")
    else
      raise APIError.new(message: format("Unstable operation '%s' is disabled", "delete_api_key"))
    end
  end

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: KeyManagementAPI.delete_api_key ...'
  end
  # verify the required parameter 'key' is set
  if @api_client.config.client_side_validation && key.nil?
    fail ArgumentError, "Missing the required parameter 'key' when calling KeyManagementAPI.delete_api_key"
  end
  # resource path
  local_var_path = '/api/v1/api_key/{key}'.sub('{' + 'key' + '}', CGI.escape(key.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] || 'ApiKeyResponse'

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

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

#delete_application_key(key, opts = {}) ⇒ Object

Delete an application key.

See Also:



253
254
255
256
 
# File 'lib/datadog_api_client/v1/api/key_management_api.rb', line 253

def delete_application_key(key, opts = {})
  data, _status_code, _headers = delete_application_key_with_http_info(key, opts)
  data
end

#delete_application_key_with_http_info(key, opts = {}) ⇒ Array<(ApplicationKeyResponse, Integer, Hash)>

Delete an application key.

Delete a given application key.

Parameters:

  • key (String) —

    The specific APP key you are working with.

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

    the optional parameters

Returns:

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

    ApplicationKeyResponse data, response status code and response headers



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
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
 
# File 'lib/datadog_api_client/v1/api/key_management_api.rb', line 263

def delete_application_key_with_http_info(key, opts = {})

  if @api_client.config.unstable_operations.has_key?(:delete_application_key)
    unstable_enabled = @api_client.config.unstable_operations[:delete_application_key]
    if unstable_enabled
      @api_client.config.logger.warn format("Using unstable operation '%s'", "delete_application_key")
    else
      raise APIError.new(message: format("Unstable operation '%s' is disabled", "delete_application_key"))
    end
  end

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: KeyManagementAPI.delete_application_key ...'
  end
  # verify the required parameter 'key' is set
  if @api_client.config.client_side_validation && key.nil?
    fail ArgumentError, "Missing the required parameter 'key' when calling KeyManagementAPI.delete_application_key"
  end
  # resource path
  local_var_path = '/api/v1/application_key/{key}'.sub('{' + 'key' + '}', CGI.escape(key.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] || 'ApplicationKeyResponse'

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

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

#get_api_key(key, opts = {}) ⇒ Object

Get API key.

See Also:



326
327
328
329
 
# File 'lib/datadog_api_client/v1/api/key_management_api.rb', line 326

def get_api_key(key, opts = {})
  data, _status_code, _headers = get_api_key_with_http_info(key, opts)
  data
end

#get_api_key_with_http_info(key, opts = {}) ⇒ Array<(ApiKeyResponse, Integer, Hash)>

Get API key.

Get a given API key.

Parameters:

  • key (String) —

    The specific API key you are working with.

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

    the optional parameters

Returns:

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

    ApiKeyResponse data, response status code and response headers



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
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
 
# File 'lib/datadog_api_client/v1/api/key_management_api.rb', line 336

def get_api_key_with_http_info(key, opts = {})

  if @api_client.config.unstable_operations.has_key?(:get_api_key)
    unstable_enabled = @api_client.config.unstable_operations[:get_api_key]
    if unstable_enabled
      @api_client.config.logger.warn format("Using unstable operation '%s'", "get_api_key")
    else
      raise APIError.new(message: format("Unstable operation '%s' is disabled", "get_api_key"))
    end
  end

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: KeyManagementAPI.get_api_key ...'
  end
  # verify the required parameter 'key' is set
  if @api_client.config.client_side_validation && key.nil?
    fail ArgumentError, "Missing the required parameter 'key' when calling KeyManagementAPI.get_api_key"
  end
  # resource path
  local_var_path = '/api/v1/api_key/{key}'.sub('{' + 'key' + '}', CGI.escape(key.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] || 'ApiKeyResponse'

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

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

#get_application_key(key, opts = {}) ⇒ Object

Get an application key.

See Also:



399
400
401
402
 
# File 'lib/datadog_api_client/v1/api/key_management_api.rb', line 399

def get_application_key(key, opts = {})
  data, _status_code, _headers = get_application_key_with_http_info(key, opts)
  data
end

#get_application_key_with_http_info(key, opts = {}) ⇒ Array<(ApplicationKeyResponse, Integer, Hash)>

Get an application key.

Get a given application key.

Parameters:

  • key (String) —

    The specific APP key you are working with.

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

    the optional parameters

Returns:

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

    ApplicationKeyResponse data, response status code and response headers



409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
 
# File 'lib/datadog_api_client/v1/api/key_management_api.rb', line 409

def get_application_key_with_http_info(key, opts = {})

  if @api_client.config.unstable_operations.has_key?(:get_application_key)
    unstable_enabled = @api_client.config.unstable_operations[:get_application_key]
    if unstable_enabled
      @api_client.config.logger.warn format("Using unstable operation '%s'", "get_application_key")
    else
      raise APIError.new(message: format("Unstable operation '%s' is disabled", "get_application_key"))
    end
  end

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: KeyManagementAPI.get_application_key ...'
  end
  # verify the required parameter 'key' is set
  if @api_client.config.client_side_validation && key.nil?
    fail ArgumentError, "Missing the required parameter 'key' when calling KeyManagementAPI.get_application_key"
  end
  # resource path
  local_var_path = '/api/v1/application_key/{key}'.sub('{' + 'key' + '}', CGI.escape(key.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] || 'ApplicationKeyResponse'

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

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

#list_api_keys(opts = {}) ⇒ Object

Get all API keys.

See Also:



471
472
473
474
 
# File 'lib/datadog_api_client/v1/api/key_management_api.rb', line 471

def list_api_keys(opts = {})
  data, _status_code, _headers = list_api_keys_with_http_info(opts)
  data
end

#list_api_keys_with_http_info(opts = {}) ⇒ Array<(ApiKeyListResponse, Integer, Hash)>

Get all API keys.

Get all API keys available for your account.

Parameters:

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

    the optional parameters

Returns:

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

    ApiKeyListResponse data, response status code and response headers



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

def list_api_keys_with_http_info(opts = {})

  if @api_client.config.unstable_operations.has_key?(:list_api_keys)
    unstable_enabled = @api_client.config.unstable_operations[:list_api_keys]
    if unstable_enabled
      @api_client.config.logger.warn format("Using unstable operation '%s'", "list_api_keys")
    else
      raise APIError.new(message: format("Unstable operation '%s' is disabled", "list_api_keys"))
    end
  end

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: KeyManagementAPI.list_api_keys ...'
  end
  # resource path
  local_var_path = '/api/v1/api_key'

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

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

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

#list_application_keys(opts = {}) ⇒ Object

Get all application keys.

See Also:



538
539
540
541
 
# File 'lib/datadog_api_client/v1/api/key_management_api.rb', line 538

def list_application_keys(opts = {})
  data, _status_code, _headers = list_application_keys_with_http_info(opts)
  data
end

#list_application_keys_with_http_info(opts = {}) ⇒ Array<(ApplicationKeyListResponse, Integer, Hash)>

Get all application keys.

Get all application keys available for your Datadog account.

Parameters:

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

    the optional parameters

Returns:

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

    ApplicationKeyListResponse data, response status code and response headers



547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
 
# File 'lib/datadog_api_client/v1/api/key_management_api.rb', line 547

def list_application_keys_with_http_info(opts = {})

  if @api_client.config.unstable_operations.has_key?(:list_application_keys)
    unstable_enabled = @api_client.config.unstable_operations[:list_application_keys]
    if unstable_enabled
      @api_client.config.logger.warn format("Using unstable operation '%s'", "list_application_keys")
    else
      raise APIError.new(message: format("Unstable operation '%s' is disabled", "list_application_keys"))
    end
  end

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: KeyManagementAPI.list_application_keys ...'
  end
  # resource path
  local_var_path = '/api/v1/application_key'

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

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

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

#update_api_key(key, body, opts = {}) ⇒ Object

Edit an API key.

See Also:



607
608
609
610
 
# File 'lib/datadog_api_client/v1/api/key_management_api.rb', line 607

def update_api_key(key, body, opts = {})
  data, _status_code, _headers = update_api_key_with_http_info(key, body, opts)
  data
end

#update_api_key_with_http_info(key, body, opts = {}) ⇒ Array<(ApiKeyResponse, Integer, Hash)>

Edit an API key.

Edit an API key name.

Parameters:

  • key (String) —

    The specific API key you are working with.

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

    the optional parameters

Returns:

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

    ApiKeyResponse data, response status code and response headers



618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
 
# File 'lib/datadog_api_client/v1/api/key_management_api.rb', line 618

def update_api_key_with_http_info(key, body, opts = {})

  if @api_client.config.unstable_operations.has_key?(:update_api_key)
    unstable_enabled = @api_client.config.unstable_operations[:update_api_key]
    if unstable_enabled
      @api_client.config.logger.warn format("Using unstable operation '%s'", "update_api_key")
    else
      raise APIError.new(message: format("Unstable operation '%s' is disabled", "update_api_key"))
    end
  end

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: KeyManagementAPI.update_api_key ...'
  end
  # verify the required parameter 'key' is set
  if @api_client.config.client_side_validation && key.nil?
    fail ArgumentError, "Missing the required parameter 'key' when calling KeyManagementAPI.update_api_key"
  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 KeyManagementAPI.update_api_key"
  end
  # resource path
  local_var_path = '/api/v1/api_key/{key}'.sub('{' + 'key' + '}', CGI.escape(key.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] || 'ApiKeyResponse'

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

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

#update_application_key(key, body, opts = {}) ⇒ Object

Edit an application key.

See Also:



688
689
690
691
 
# File 'lib/datadog_api_client/v1/api/key_management_api.rb', line 688

def update_application_key(key, body, opts = {})
  data, _status_code, _headers = update_application_key_with_http_info(key, body, opts)
  data
end

#update_application_key_with_http_info(key, body, opts = {}) ⇒ Array<(ApplicationKeyResponse, Integer, Hash)>

Edit an application key.

Edit an application key name.

Parameters:

  • key (String) —

    The specific APP key you are working with.

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

    the optional parameters

Returns:

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

    ApplicationKeyResponse data, response status code and response headers



699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
 
# File 'lib/datadog_api_client/v1/api/key_management_api.rb', line 699

def update_application_key_with_http_info(key, body, opts = {})

  if @api_client.config.unstable_operations.has_key?(:update_application_key)
    unstable_enabled = @api_client.config.unstable_operations[:update_application_key]
    if unstable_enabled
      @api_client.config.logger.warn format("Using unstable operation '%s'", "update_application_key")
    else
      raise APIError.new(message: format("Unstable operation '%s' is disabled", "update_application_key"))
    end
  end

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: KeyManagementAPI.update_application_key ...'
  end
  # verify the required parameter 'key' is set
  if @api_client.config.client_side_validation && key.nil?
    fail ArgumentError, "Missing the required parameter 'key' when calling KeyManagementAPI.update_application_key"
  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 KeyManagementAPI.update_application_key"
  end
  # resource path
  local_var_path = '/api/v1/application_key/{key}'.sub('{' + 'key' + '}', CGI.escape(key.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] || 'ApplicationKeyResponse'

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

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