Class: DatadogAPIClient::V1::KeyManagementAPI
- Inherits:
-
Object
- Object
- DatadogAPIClient::V1::KeyManagementAPI
- Defined in:
- lib/datadog_api_client/v1/api/key_management_api.rb
Instance Attribute Summary collapse
-
#api_client ⇒ Object
Returns the value of attribute api_client.
Instance Method Summary collapse
-
#create_api_key(body, opts = {}) ⇒ Object
Create an API key.
-
#create_api_key_with_http_info(body, opts = {}) ⇒ Array<(ApiKeyResponse, Integer, Hash)>
deprecated
Deprecated.
This API is deprecated.
-
#create_application_key(body, opts = {}) ⇒ Object
Create an application key.
-
#create_application_key_with_http_info(body, opts = {}) ⇒ Array<(ApplicationKeyResponse, Integer, Hash)>
deprecated
Deprecated.
This API is deprecated.
-
#delete_api_key(key, opts = {}) ⇒ Object
Delete an API key.
-
#delete_api_key_with_http_info(key, opts = {}) ⇒ Array<(ApiKeyResponse, Integer, Hash)>
deprecated
Deprecated.
This API is deprecated.
-
#delete_application_key(key, opts = {}) ⇒ Object
Delete an application key.
-
#delete_application_key_with_http_info(key, opts = {}) ⇒ Array<(ApplicationKeyResponse, Integer, Hash)>
deprecated
Deprecated.
This API is deprecated.
-
#get_api_key(key, opts = {}) ⇒ Object
Get API key.
-
#get_api_key_with_http_info(key, opts = {}) ⇒ Array<(ApiKeyResponse, Integer, Hash)>
deprecated
Deprecated.
This API is deprecated.
-
#get_application_key(key, opts = {}) ⇒ Object
Get an application key.
-
#get_application_key_with_http_info(key, opts = {}) ⇒ Array<(ApplicationKeyResponse, Integer, Hash)>
deprecated
Deprecated.
This API is deprecated.
-
#initialize(api_client = DatadogAPIClient::APIClient.default) ⇒ KeyManagementAPI
constructor
A new instance of KeyManagementAPI.
-
#list_api_keys(opts = {}) ⇒ Object
Get all API keys.
-
#list_api_keys_with_http_info(opts = {}) ⇒ Array<(ApiKeyListResponse, Integer, Hash)>
deprecated
Deprecated.
This API is deprecated.
-
#list_application_keys(opts = {}) ⇒ Object
Get all application keys.
-
#list_application_keys_with_http_info(opts = {}) ⇒ Array<(ApplicationKeyListResponse, Integer, Hash)>
deprecated
Deprecated.
This API is deprecated.
-
#update_api_key(key, body, opts = {}) ⇒ Object
Edit an API key.
-
#update_api_key_with_http_info(key, body, opts = {}) ⇒ Array<(ApiKeyResponse, Integer, Hash)>
deprecated
Deprecated.
This API is deprecated.
-
#update_application_key(key, body, opts = {}) ⇒ Object
Edit an application key.
-
#update_application_key_with_http_info(key, body, opts = {}) ⇒ Array<(ApplicationKeyResponse, Integer, Hash)>
deprecated
Deprecated.
This API is deprecated.
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 = 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/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.
29 30 31 32 |
# File 'lib/datadog_api_client/v1/api/key_management_api.rb', line 29 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)>
This API is deprecated.
Create an API key.
This endpoint is deprecated. Use Create an API key (POST /api/v2/api_keys) instead.
Creates an API key with a given name.
Note: This endpoint is disabled for the Government sites (US1-FED and US2-FED). Use the V2 Key Management endpoints instead.
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 47 def create_api_key_with_http_info(body, opts = {}) warn "[DEPRECATION] `CreateAPIKey` is deprecated." 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, :AuthZ] = 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, :api_version => "V1" ) data, status_code, headers = @api_client.call_api(Net::HTTP::Post, local_var_path, ) 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.
103 104 105 106 |
# File 'lib/datadog_api_client/v1/api/key_management_api.rb', line 103 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)>
This API is deprecated.
Create an application key.
This endpoint is deprecated. Use Create an application key for current user (POST /api/v2/current_user/application_keys) instead.
Create an application key with a given name. This endpoint is disabled for organizations in One-Time Read mode.
Note: This endpoint is disabled for the Government sites (US1-FED and US2-FED). Use the V2 Key Management endpoints instead.
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 122 def create_application_key_with_http_info(body, opts = {}) warn "[DEPRECATION] `CreateApplicationKey` is deprecated." 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, :AuthZ] = 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, :api_version => "V1" ) data, status_code, headers = @api_client.call_api(Net::HTTP::Post, local_var_path, ) 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.
178 179 180 181 |
# File 'lib/datadog_api_client/v1/api/key_management_api.rb', line 178 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)>
This API is deprecated.
Delete an API key.
This endpoint is deprecated. Use Delete an API key (DELETE /api/v2/api_keys/{api_key_id}) instead.
Delete a given API key.
Note: This endpoint is disabled for the Government sites (US1-FED and US2-FED). Use the V2 Key Management endpoints instead.
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 |
# File 'lib/datadog_api_client/v1/api/key_management_api.rb', line 196 def delete_api_key_with_http_info(key, opts = {}) warn "[DEPRECATION] `DeleteAPIKey` is deprecated." 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).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] || 'ApiKeyResponse' # auth_names auth_names = opts[:debug_auth_names] || [:apiKeyAuth, :appKeyAuth, :AuthZ] = 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, :api_version => "V1" ) data, status_code, headers = @api_client.call_api(Net::HTTP::Delete, local_var_path, ) 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.
250 251 252 253 |
# File 'lib/datadog_api_client/v1/api/key_management_api.rb', line 250 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)>
This API is deprecated.
Delete an application key.
This endpoint is deprecated. To delete your own application key, use
Delete an application key owned by current user
(DELETE /api/v2/current_user/application_keys/{app_key_id}), which requires the user_app_keys permission.
To delete an application key for your organization, use
Delete an application key
(DELETE /api/v2/application_keys/{app_key_id}), which requires the org_app_keys_write permission.
Delete a given application key. This endpoint is disabled for organizations in One-Time Read mode.
Note: This endpoint is disabled for the Government sites (US1-FED and US2-FED). Use the V2 Key Management endpoints instead.
274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 |
# File 'lib/datadog_api_client/v1/api/key_management_api.rb', line 274 def delete_application_key_with_http_info(key, opts = {}) warn "[DEPRECATION] `DeleteApplicationKey` is deprecated." 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).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] || 'ApplicationKeyResponse' # auth_names auth_names = opts[:debug_auth_names] || [:apiKeyAuth, :appKeyAuth, :AuthZ] = 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, :api_version => "V1" ) data, status_code, headers = @api_client.call_api(Net::HTTP::Delete, local_var_path, ) 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.
328 329 330 331 |
# File 'lib/datadog_api_client/v1/api/key_management_api.rb', line 328 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)>
This API is deprecated.
Get API key.
This endpoint is deprecated. Use Get API key (GET /api/v2/api_keys/{api_key_id}) instead.
Get a given API key.
Note: This endpoint is disabled for the Government sites (US1-FED and US2-FED). Use the V2 Key Management endpoints instead.
346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 |
# File 'lib/datadog_api_client/v1/api/key_management_api.rb', line 346 def get_api_key_with_http_info(key, opts = {}) warn "[DEPRECATION] `GetAPIKey` is deprecated." 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).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] || 'ApiKeyResponse' # auth_names auth_names = opts[:debug_auth_names] || [:apiKeyAuth, :appKeyAuth, :AuthZ] = 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, :api_version => "V1" ) data, status_code, headers = @api_client.call_api(Net::HTTP::Get, local_var_path, ) 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.
400 401 402 403 |
# File 'lib/datadog_api_client/v1/api/key_management_api.rb', line 400 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)>
This API is deprecated.
Get an application key.
This endpoint is deprecated. To get your own application key, use
Get one application key owned by current user
(GET /api/v2/current_user/application_keys/{app_key_id}), which requires the user_app_keys permission.
To get an application key for your organization, use
Get an application key
(GET /api/v2/application_keys/{app_key_id}), which requires the org_app_keys_read permission.
Get a given application key. This endpoint is disabled for organizations in One-Time Read mode.
Note: This endpoint is disabled for the Government sites (US1-FED and US2-FED). Use the V2 Key Management endpoints instead.
424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 |
# File 'lib/datadog_api_client/v1/api/key_management_api.rb', line 424 def get_application_key_with_http_info(key, opts = {}) warn "[DEPRECATION] `GetApplicationKey` is deprecated." 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).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] || 'ApplicationKeyResponse' # auth_names auth_names = opts[:debug_auth_names] || [:apiKeyAuth, :appKeyAuth, :AuthZ] = 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, :api_version => "V1" ) data, status_code, headers = @api_client.call_api(Net::HTTP::Get, local_var_path, ) 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.
478 479 480 481 |
# File 'lib/datadog_api_client/v1/api/key_management_api.rb', line 478 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)>
This API is deprecated.
Get all API keys.
This endpoint is deprecated. Use Get all API keys (GET /api/v2/api_keys) instead.
Get all API keys available for your account.
Note: This endpoint is disabled for the Government sites (US1-FED and US2-FED). Use the V2 Key Management endpoints instead.
495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 |
# File 'lib/datadog_api_client/v1/api/key_management_api.rb', line 495 def list_api_keys_with_http_info(opts = {}) warn "[DEPRECATION] `ListAPIKeys` is deprecated." 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, :AuthZ] = 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, :api_version => "V1" ) data, status_code, headers = @api_client.call_api(Net::HTTP::Get, local_var_path, ) 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.
545 546 547 548 |
# File 'lib/datadog_api_client/v1/api/key_management_api.rb', line 545 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)>
This API is deprecated.
Get all application keys.
This endpoint is deprecated. To list your own application keys, use
Get all application keys owned by current user
(GET /api/v2/current_user/application_keys), which requires the user_app_keys permission.
To list application keys across your organization, use
Get all application keys
(GET /api/v2/application_keys), which requires the org_app_keys_read permission.
Get all application keys available for your Datadog account. This endpoint is disabled for organizations in One-Time Read mode.
Note: This endpoint is disabled for the Government sites (US1-FED and US2-FED). Use the V2 Key Management endpoints instead.
568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 |
# File 'lib/datadog_api_client/v1/api/key_management_api.rb', line 568 def list_application_keys_with_http_info(opts = {}) warn "[DEPRECATION] `ListApplicationKeys` is deprecated." 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, :AuthZ] = 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, :api_version => "V1" ) data, status_code, headers = @api_client.call_api(Net::HTTP::Get, local_var_path, ) 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.
618 619 620 621 |
# File 'lib/datadog_api_client/v1/api/key_management_api.rb', line 618 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)>
This API is deprecated.
Edit an API key.
This endpoint is deprecated. Use Edit an API key (PATCH /api/v2/api_keys/{api_key_id}) instead.
Edit an API key name.
Note: This endpoint is disabled for the Government sites (US1-FED and US2-FED). Use the V2 Key Management endpoints instead.
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 681 682 683 684 685 686 687 688 689 690 691 692 |
# File 'lib/datadog_api_client/v1/api/key_management_api.rb', line 637 def update_api_key_with_http_info(key, body, opts = {}) warn "[DEPRECATION] `UpdateAPIKey` is deprecated." 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).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] || 'ApiKeyResponse' # auth_names auth_names = opts[:debug_auth_names] || [:apiKeyAuth, :appKeyAuth, :AuthZ] = 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, :api_version => "V1" ) data, status_code, headers = @api_client.call_api(Net::HTTP::Put, local_var_path, ) 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.
697 698 699 700 |
# File 'lib/datadog_api_client/v1/api/key_management_api.rb', line 697 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)>
This API is deprecated.
Edit an application key.
This endpoint is deprecated. To edit your own application key, use
Edit an application key owned by current user
(PATCH /api/v2/current_user/application_keys/{app_key_id}), which requires the user_app_keys permission.
To edit an application key for your organization, use
Edit an application key
(PATCH /api/v2/application_keys/{app_key_id}), which requires the org_app_keys_write permission.
Edit an application key name. This endpoint is disabled for organizations in One-Time Read mode.
Note: This endpoint is disabled for the Government sites (US1-FED and US2-FED). Use the V2 Key Management endpoints instead.
722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 |
# File 'lib/datadog_api_client/v1/api/key_management_api.rb', line 722 def update_application_key_with_http_info(key, body, opts = {}) warn "[DEPRECATION] `UpdateApplicationKey` is deprecated." 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).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] || 'ApplicationKeyResponse' # auth_names auth_names = opts[:debug_auth_names] || [:apiKeyAuth, :appKeyAuth, :AuthZ] = 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, :api_version => "V1" ) data, status_code, headers = @api_client.call_api(Net::HTTP::Put, local_var_path, ) 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 |