docs/v1/KeyManagementAPI.md in datadog_api_client-1.4.0 vs docs/v1/KeyManagementAPI.md in datadog_api_client-1.5.0
- old
+ new
@@ -1,23 +1,22 @@
# DatadogAPIClient::V1::KeyManagementAPI
All URIs are relative to *https://api.datadoghq.com*
-| Method | HTTP request | Description |
-| ------ | ------------ | ----------- |
-| [**create_api_key**](KeyManagementAPI.md#create_api_key) | **POST** /api/v1/api_key | Create an API key |
-| [**create_application_key**](KeyManagementAPI.md#create_application_key) | **POST** /api/v1/application_key | Create an application key |
-| [**delete_api_key**](KeyManagementAPI.md#delete_api_key) | **DELETE** /api/v1/api_key/{key} | Delete an API key |
+| Method | HTTP request | Description |
+| ------------------------------------------------------------------------ | ---------------------------------------- | ------------------------- |
+| [**create_api_key**](KeyManagementAPI.md#create_api_key) | **POST** /api/v1/api_key | Create an API key |
+| [**create_application_key**](KeyManagementAPI.md#create_application_key) | **POST** /api/v1/application_key | Create an application key |
+| [**delete_api_key**](KeyManagementAPI.md#delete_api_key) | **DELETE** /api/v1/api_key/{key} | Delete an API key |
| [**delete_application_key**](KeyManagementAPI.md#delete_application_key) | **DELETE** /api/v1/application_key/{key} | Delete an application key |
-| [**get_api_key**](KeyManagementAPI.md#get_api_key) | **GET** /api/v1/api_key/{key} | Get API key |
-| [**get_application_key**](KeyManagementAPI.md#get_application_key) | **GET** /api/v1/application_key/{key} | Get an application key |
-| [**list_api_keys**](KeyManagementAPI.md#list_api_keys) | **GET** /api/v1/api_key | Get all API keys |
-| [**list_application_keys**](KeyManagementAPI.md#list_application_keys) | **GET** /api/v1/application_key | Get all application keys |
-| [**update_api_key**](KeyManagementAPI.md#update_api_key) | **PUT** /api/v1/api_key/{key} | Edit an API key |
-| [**update_application_key**](KeyManagementAPI.md#update_application_key) | **PUT** /api/v1/application_key/{key} | Edit an application key |
+| [**get_api_key**](KeyManagementAPI.md#get_api_key) | **GET** /api/v1/api_key/{key} | Get API key |
+| [**get_application_key**](KeyManagementAPI.md#get_application_key) | **GET** /api/v1/application_key/{key} | Get an application key |
+| [**list_api_keys**](KeyManagementAPI.md#list_api_keys) | **GET** /api/v1/api_key | Get all API keys |
+| [**list_application_keys**](KeyManagementAPI.md#list_application_keys) | **GET** /api/v1/application_key | Get all application keys |
+| [**update_api_key**](KeyManagementAPI.md#update_api_key) | **PUT** /api/v1/api_key/{key} | Edit an API key |
+| [**update_application_key**](KeyManagementAPI.md#update_application_key) | **PUT** /api/v1/application_key/{key} | Edit an application key |
-
## create_api_key
> <ApiKeyResponse> create_api_key(body)
Creates an API key with a given name.
@@ -25,11 +24,11 @@
### Examples
```ruby
require 'datadog_api_client'
api_instance = DatadogAPIClient::V1::KeyManagementAPI.new
-body = DatadogAPIClient::V1::ApiKey.new # ApiKey |
+body = DatadogAPIClient::V1::ApiKey.new # ApiKey |
begin
# Create an API key
result = api_instance.create_api_key(body)
p result
@@ -56,13 +55,13 @@
end
```
### Parameters
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **body** | [**ApiKey**](ApiKey.md) | | |
+| Name | Type | Description | Notes |
+| -------- | ----------------------- | ----------- | ----- |
+| **body** | [**ApiKey**](ApiKey.md) | | |
### Return type
[**ApiKeyResponse**](ApiKeyResponse.md)
@@ -73,11 +72,10 @@
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json
-
## create_application_key
> <ApplicationKeyResponse> create_application_key(body)
Create an application key with a given name.
@@ -85,11 +83,11 @@
### Examples
```ruby
require 'datadog_api_client'
api_instance = DatadogAPIClient::V1::KeyManagementAPI.new
-body = DatadogAPIClient::V1::ApplicationKey.new # ApplicationKey |
+body = DatadogAPIClient::V1::ApplicationKey.new # ApplicationKey |
begin
# Create an application key
result = api_instance.create_application_key(body)
p result
@@ -116,13 +114,13 @@
end
```
### Parameters
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **body** | [**ApplicationKey**](ApplicationKey.md) | | |
+| Name | Type | Description | Notes |
+| -------- | --------------------------------------- | ----------- | ----- |
+| **body** | [**ApplicationKey**](ApplicationKey.md) | | |
### Return type
[**ApplicationKeyResponse**](ApplicationKeyResponse.md)
@@ -133,11 +131,10 @@
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json
-
## delete_api_key
> <ApiKeyResponse> delete_api_key(key)
Delete a given API key.
@@ -176,13 +173,13 @@
end
```
### Parameters
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **key** | **String** | The specific API key you are working with. | |
+| Name | Type | Description | Notes |
+| ------- | ---------- | ------------------------------------------ | ----- |
+| **key** | **String** | The specific API key you are working with. | |
### Return type
[**ApiKeyResponse**](ApiKeyResponse.md)
@@ -193,11 +190,10 @@
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
-
## delete_application_key
> <ApplicationKeyResponse> delete_application_key(key)
Delete a given application key.
@@ -236,13 +232,13 @@
end
```
### Parameters
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **key** | **String** | The specific APP key you are working with. | |
+| Name | Type | Description | Notes |
+| ------- | ---------- | ------------------------------------------ | ----- |
+| **key** | **String** | The specific APP key you are working with. | |
### Return type
[**ApplicationKeyResponse**](ApplicationKeyResponse.md)
@@ -253,11 +249,10 @@
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
-
## get_api_key
> <ApiKeyResponse> get_api_key(key)
Get a given API key.
@@ -296,13 +291,13 @@
end
```
### Parameters
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **key** | **String** | The specific API key you are working with. | |
+| Name | Type | Description | Notes |
+| ------- | ---------- | ------------------------------------------ | ----- |
+| **key** | **String** | The specific API key you are working with. | |
### Return type
[**ApiKeyResponse**](ApiKeyResponse.md)
@@ -313,11 +308,10 @@
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
-
## get_application_key
> <ApplicationKeyResponse> get_application_key(key)
Get a given application key.
@@ -356,13 +350,13 @@
end
```
### Parameters
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **key** | **String** | The specific APP key you are working with. | |
+| Name | Type | Description | Notes |
+| ------- | ---------- | ------------------------------------------ | ----- |
+| **key** | **String** | The specific APP key you are working with. | |
### Return type
[**ApplicationKeyResponse**](ApplicationKeyResponse.md)
@@ -373,11 +367,10 @@
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
-
## list_api_keys
> <ApiKeyListResponse> list_api_keys
Get all API keys available for your account.
@@ -430,11 +423,10 @@
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
-
## list_application_keys
> <ApplicationKeyListResponse> list_application_keys
Get all application keys available for your Datadog account.
@@ -487,11 +479,10 @@
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
-
## update_api_key
> <ApiKeyResponse> update_api_key(key, body)
Edit an API key name.
@@ -500,11 +491,11 @@
```ruby
require 'datadog_api_client'
api_instance = DatadogAPIClient::V1::KeyManagementAPI.new
key = 'key_example' # String | The specific API key you are working with.
-body = DatadogAPIClient::V1::ApiKey.new # ApiKey |
+body = DatadogAPIClient::V1::ApiKey.new # ApiKey |
begin
# Edit an API key
result = api_instance.update_api_key(key, body)
p result
@@ -531,14 +522,14 @@
end
```
### Parameters
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **key** | **String** | The specific API key you are working with. | |
-| **body** | [**ApiKey**](ApiKey.md) | | |
+| Name | Type | Description | Notes |
+| -------- | ----------------------- | ------------------------------------------ | ----- |
+| **key** | **String** | The specific API key you are working with. | |
+| **body** | [**ApiKey**](ApiKey.md) | | |
### Return type
[**ApiKeyResponse**](ApiKeyResponse.md)
@@ -549,11 +540,10 @@
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json
-
## update_application_key
> <ApplicationKeyResponse> update_application_key(key, body)
Edit an application key name.
@@ -562,11 +552,11 @@
```ruby
require 'datadog_api_client'
api_instance = DatadogAPIClient::V1::KeyManagementAPI.new
key = 'key_example' # String | The specific APP key you are working with.
-body = DatadogAPIClient::V1::ApplicationKey.new # ApplicationKey |
+body = DatadogAPIClient::V1::ApplicationKey.new # ApplicationKey |
begin
# Edit an application key
result = api_instance.update_application_key(key, body)
p result
@@ -593,14 +583,14 @@
end
```
### Parameters
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **key** | **String** | The specific APP key you are working with. | |
-| **body** | [**ApplicationKey**](ApplicationKey.md) | | |
+| Name | Type | Description | Notes |
+| -------- | --------------------------------------- | ------------------------------------------ | ----- |
+| **key** | **String** | The specific APP key you are working with. | |
+| **body** | [**ApplicationKey**](ApplicationKey.md) | | |
### Return type
[**ApplicationKeyResponse**](ApplicationKeyResponse.md)
@@ -610,6 +600,5 @@
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json
-