datadog_api_client 1.0.0 → 1.4.0

data/docs/v2/KeyManagementAPI.md

@@ -10,6 +10,7 @@ All URIs are relative to *https://api.datadoghq.com*
 | [**delete_application_key**](KeyManagementAPI.md#delete_application_key) | **DELETE** /api/v2/application_keys/{app_key_id} | Delete an application key |
 | [**delete_current_user_application_key**](KeyManagementAPI.md#delete_current_user_application_key) | **DELETE** /api/v2/current_user/application_keys/{app_key_id} | Delete an application key owned by current user |
 | [**get_api_key**](KeyManagementAPI.md#get_api_key) | **GET** /api/v2/api_keys/{api_key_id} | Get API key |
+| [**get_application_key**](KeyManagementAPI.md#get_application_key) | **GET** /api/v2/application_keys/{app_key_id} | Get an application key |
 | [**get_current_user_application_key**](KeyManagementAPI.md#get_current_user_application_key) | **GET** /api/v2/current_user/application_keys/{app_key_id} | Get one application key owned by current user |
 | [**list_api_keys**](KeyManagementAPI.md#list_api_keys) | **GET** /api/v2/api_keys | Get all API keys |
 | [**list_application_keys**](KeyManagementAPI.md#list_application_keys) | **GET** /api/v2/application_keys | Get all application keys |
@@ -23,8 +24,6 @@ All URIs are relative to *https://api.datadoghq.com*
 
 > <APIKeyResponse> create_api_key(body)
 
-Create an API key
-
 Create an API key.
 
 ### Examples
@@ -87,8 +86,6 @@ end
 
 Create an application key for current user
 
-Create an application key for current user
-
 ### Examples
 
 ```ruby
@@ -147,8 +144,6 @@ end
 
 > delete_api_key(api_key_id)
 
-Delete an API key
-
 Delete an API key.
 
 ### Examples
@@ -210,8 +205,6 @@ nil (empty response body)
 
 Delete an application key
 
-Delete an application key
-
 ### Examples
 
 ```ruby
@@ -271,8 +264,6 @@ nil (empty response body)
 
 Delete an application key owned by current user
 
-Delete an application key owned by current user
-
 ### Examples
 
 ```ruby
@@ -330,8 +321,6 @@ nil (empty response body)
 
 > <APIKeyResponse> get_api_key(api_key_id, opts)
 
-Get API key
-
 Get an API key.
 
 ### Examples
@@ -392,12 +381,74 @@ end
 - **Accept**: application/json
 
 
+## get_application_key
+
+> <ApplicationKeyResponse> get_application_key(app_key_id, opts)
+
+Get an application key for your org.
+
+### Examples
+
+```ruby
+require 'datadog_api_client'
+api_instance = DatadogAPIClient::V2::KeyManagementAPI.new
+app_key_id = 'app_key_id_example' # String | The ID of the application key.
+opts = {
+  include: 'owned_by' # String | Resource path for related resources to include in the response. Only `owned_by` is supported.
+}
+
+begin
+  # Get an application key
+  result = api_instance.get_application_key(app_key_id, opts)
+  p result
+rescue DatadogAPIClient::V2::APIError => e
+  puts "Error when calling KeyManagementAPI->get_application_key: #{e}"
+end
+```
+
+#### Using the get_application_key_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<ApplicationKeyResponse>, Integer, Hash)> get_application_key_with_http_info(app_key_id, opts)
+
+```ruby
+begin
+  # Get an application key
+  data, status_code, headers = api_instance.get_application_key_with_http_info(app_key_id, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <ApplicationKeyResponse>
+rescue DatadogAPIClient::V2::APIError => e
+  puts "Error when calling KeyManagementAPI->get_application_key_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **app_key_id** | **String** | The ID of the application key. |  |
+| **include** | **String** | Resource path for related resources to include in the response. Only &#x60;owned_by&#x60; is supported. | [optional] |
+
+### Return type
+
+[**ApplicationKeyResponse**](ApplicationKeyResponse.md)
+
+### Authorization
+
+[apiKeyAuth](README.md#apiKeyAuth), [appKeyAuth](README.md#appKeyAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
 ## get_current_user_application_key
 
 > <ApplicationKeyResponse> get_current_user_application_key(app_key_id)
 
-Get one application key owned by current user
-
 Get an application key owned by current user
 
 ### Examples
@@ -458,8 +509,6 @@ end
 
 > <APIKeysResponse> list_api_keys(opts)
 
-Get all API keys
-
 List all API keys available for your account.
 
 ### Examples
@@ -468,8 +517,8 @@ List all API keys available for your account.
 require 'datadog_api_client'
 api_instance = DatadogAPIClient::V2::KeyManagementAPI.new
 opts = {
-  page_size: 789, # Integer | Size for a given page.
-  page_number: 789, # Integer | Specific page number to return.
+  page_size: 10, # Integer | Size for a given page.
+  page_number: 0, # Integer | Specific page number to return.
   sort: DatadogAPIClient::V2::APIKeysSort::CREATED_AT_ASCENDING, # APIKeysSort | API key attribute used to sort results. Sort order is ascending by default. In order to specify a descending sort, prefix the attribute with a minus sign.
   filter: 'filter_example', # String | Filter API keys by the specified string.
   filter_created_at_start: '2020-11-24T18:46:21+00:00', # String | Only include API keys created on or after the specified date.
@@ -538,8 +587,6 @@ end
 
 > <ListApplicationKeysResponse> list_application_keys(opts)
 
-Get all application keys
-
 List all application keys available for your org
 
 ### Examples
@@ -548,8 +595,8 @@ List all application keys available for your org
 require 'datadog_api_client'
 api_instance = DatadogAPIClient::V2::KeyManagementAPI.new
 opts = {
-  page_size: 789, # Integer | Size for a given page.
-  page_number: 789, # Integer | Specific page number to return.
+  page_size: 10, # Integer | Size for a given page.
+  page_number: 0, # Integer | Specific page number to return.
   sort: DatadogAPIClient::V2::ApplicationKeysSort::CREATED_AT_ASCENDING, # ApplicationKeysSort | Application key attribute used to sort results. Sort order is ascending by default. In order to specify a descending sort, prefix the attribute with a minus sign.
   filter: 'filter_example', # String | Filter application keys by the specified string.
   filter_created_at_start: '2020-11-24T18:46:21+00:00', # String | Only include application keys created on or after the specified date.
@@ -612,8 +659,6 @@ end
 
 > <ListApplicationKeysResponse> list_current_user_application_keys(opts)
 
-Get all application keys owned by current user
-
 List all application keys available for current user
 
 ### Examples
@@ -622,8 +667,8 @@ List all application keys available for current user
 require 'datadog_api_client'
 api_instance = DatadogAPIClient::V2::KeyManagementAPI.new
 opts = {
-  page_size: 789, # Integer | Size for a given page.
-  page_number: 789, # Integer | Specific page number to return.
+  page_size: 10, # Integer | Size for a given page.
+  page_number: 0, # Integer | Specific page number to return.
   sort: DatadogAPIClient::V2::ApplicationKeysSort::CREATED_AT_ASCENDING, # ApplicationKeysSort | Application key attribute used to sort results. Sort order is ascending by default. In order to specify a descending sort, prefix the attribute with a minus sign.
   filter: 'filter_example', # String | Filter application keys by the specified string.
   filter_created_at_start: '2020-11-24T18:46:21+00:00', # String | Only include application keys created on or after the specified date.
@@ -686,8 +731,6 @@ end
 
 > <APIKeyResponse> update_api_key(api_key_id, body)
 
-Edit an API key
-
 Update an API key.
 
 ### Examples
@@ -752,8 +795,6 @@ end
 
 Edit an application key
 
-Edit an application key
-
 ### Examples
 
 ```ruby
@@ -816,8 +857,6 @@ end
 
 Edit an application key owned by current user
 
-Edit an application key owned by current user
-
 ### Examples
 
 ```ruby

data/docs/v2/LogsAPI.md

@@ -13,8 +13,6 @@ All URIs are relative to *https://api.datadoghq.com*
 
 > <LogsAggregateResponse> aggregate_logs(body)
 
-Aggregate events
-
 The API endpoint to aggregate events into buckets and compute metrics and timeseries.
 
 ### Examples
@@ -75,9 +73,17 @@ end
 
 > <LogsListResponse> list_logs(opts)
 
-Search logs
+List endpoint returns logs that match a log search query.
+[Results are paginated][1].
+
+Use this endpoint to build complex logs filtering and search.
+
+**If you are considering archiving logs for your organization,
+consider use of the Datadog archive capabilities instead of the log list API.
+See [Datadog Logs Archive documentation][2].**
 
-List endpoint returns logs that match a log search query. [Results are paginated][1].  Use this endpoint to build complex logs filtering and search.  **If you are considering archiving logs for your organization, consider use of the Datadog archive capabilities instead of the log list API. See [Datadog Logs Archive documentation][2].**  [1]: /logs/guide/collect-multiple-logs-with-pagination [2]: https://docs.datadoghq.com/logs/archives
+[1]: /logs/guide/collect-multiple-logs-with-pagination
+[2]: https://docs.datadoghq.com/logs/archives
 
 ### Examples
 
@@ -139,9 +145,17 @@ end
 
 > <LogsListResponse> list_logs_get(opts)
 
-Get a list of logs
+List endpoint returns logs that match a log search query.
+[Results are paginated][1].
+
+Use this endpoint to see your latest logs.
+
+**If you are considering archiving logs for your organization,
+consider use of the Datadog archive capabilities instead of the log list API.
+See [Datadog Logs Archive documentation][2].**
 
-List endpoint returns logs that match a log search query. [Results are paginated][1].  Use this endpoint to see your latest logs.  **If you are considering archiving logs for your organization, consider use of the Datadog archive capabilities instead of the log list API. See [Datadog Logs Archive documentation][2].**  [1]: /logs/guide/collect-multiple-logs-with-pagination [2]: https://docs.datadoghq.com/logs/archives
+[1]: /logs/guide/collect-multiple-logs-with-pagination
+[2]: https://docs.datadoghq.com/logs/archives
 
 ### Examples
 

data/docs/v2/LogsArchivesAPI.md

@@ -20,8 +20,6 @@ All URIs are relative to *https://api.datadoghq.com*
 
 > add_read_role_to_archive(archive_id, body)
 
-Grant role to an archive
-
 Adds a read role to an archive. ([Roles API](https://docs.datadoghq.com/api/v2/roles/))
 
 ### Examples
@@ -83,8 +81,6 @@ nil (empty response body)
 
 > <LogsArchive> create_logs_archive(body)
 
-Create an archive
-
 Create an archive in your organization.
 
 ### Examples
@@ -145,8 +141,6 @@ end
 
 > delete_logs_archive(archive_id)
 
-Delete an archive
-
 Delete a given archive from your organization.
 
 ### Examples
@@ -206,8 +200,6 @@ nil (empty response body)
 
 > <LogsArchive> get_logs_archive(archive_id)
 
-Get an archive
-
 Get a specific archive from your organization.
 
 ### Examples
@@ -268,9 +260,8 @@ end
 
 > <LogsArchiveOrder> get_logs_archive_order
 
-Get archive order
-
-Get the current order of your archives. This endpoint takes no JSON arguments.
+Get the current order of your archives.
+This endpoint takes no JSON arguments.
 
 ### Examples
 
@@ -327,8 +318,6 @@ This endpoint does not need any parameter.
 
 > <RolesResponse> list_archive_read_roles(archive_id)
 
-List read roles for an archive
-
 Returns all read roles a given archive is restricted to.
 
 ### Examples
@@ -389,8 +378,6 @@ end
 
 > <LogsArchives> list_logs_archives
 
-Get all archives
-
 Get the list of configured logs archives with their definitions.
 
 ### Examples
@@ -448,8 +435,6 @@ This endpoint does not need any parameter.
 
 > remove_role_from_archive(archive_id, body)
 
-Revoke role from an archive
-
 Removes a role from an archive. ([Roles API](https://docs.datadoghq.com/api/v2/roles/))
 
 ### Examples
@@ -511,9 +496,10 @@ nil (empty response body)
 
 > <LogsArchive> update_logs_archive(archive_id, body)
 
-Update an archive
+Update a given archive configuration.
 
-Update a given archive configuration.  **Note**: Using this method updates your archive configuration by **replacing** your current configuration with the new one sent to your Datadog organization.
+**Note**: Using this method updates your archive configuration by **replacing**
+your current configuration with the new one sent to your Datadog organization.
 
 ### Examples
 
@@ -575,9 +561,11 @@ end
 
 > <LogsArchiveOrder> update_logs_archive_order(body)
 
-Update archive order
+Update the order of your archives. Since logs are processed sequentially, reordering an archive may change
+the structure and content of the data processed by other archives.
 
-Update the order of your archives. Since logs are processed sequentially, reordering an archive may change the structure and content of the data processed by other archives.  **Note**: Using the `PUT` method updates your archive's order by replacing the current order with the new one.
+**Note**: Using the `PUT` method updates your archive's order by replacing the current order
+with the new one.
 
 ### Examples
 

data/docs/v2/LogsMetricsAPI.md

@@ -15,9 +15,8 @@ All URIs are relative to *https://api.datadoghq.com*
 
 > <LogsMetricResponse> create_logs_metric(body)
 
-Create a log-based metric
-
-Create a metric based on your ingested logs in your organization. Returns the log-based metric object from the request body when the request is successful.
+Create a metric based on your ingested logs in your organization.
+Returns the log-based metric object from the request body when the request is successful.
 
 ### Examples
 
@@ -77,8 +76,6 @@ end
 
 > delete_logs_metric(metric_id)
 
-Delete a log-based metric
-
 Delete a specific log-based metric from your organization.
 
 ### Examples
@@ -138,8 +135,6 @@ nil (empty response body)
 
 > <LogsMetricResponse> get_logs_metric(metric_id)
 
-Get a log-based metric
-
 Get a specific log-based metric from your organization.
 
 ### Examples
@@ -200,8 +195,6 @@ end
 
 > <LogsMetricsResponse> list_logs_metrics
 
-Get all log-based metrics
-
 Get the list of configured log-based metrics with their definitions.
 
 ### Examples
@@ -259,9 +252,8 @@ This endpoint does not need any parameter.
 
 > <LogsMetricResponse> update_logs_metric(metric_id, body)
 
-Update a log-based metric
-
-Update a specific log-based metric from your organization. Returns the log-based metric object from the request body when the request is successful.
+Update a specific log-based metric from your organization.
+Returns the log-based metric object from the request body when the request is successful.
 
 ### Examples
 

data/docs/v2/MetricsAPI.md

@@ -17,9 +17,8 @@ All URIs are relative to *https://api.datadoghq.com*
 
 > <MetricTagConfigurationResponse> create_tag_configuration(metric_name, body)
 
-Create a tag configuration
-
-Create and define a list of queryable tag keys for an existing count/gauge/rate/distribution metric. Optionally, include percentile aggregations on any distribution metric. Can only be used with application keys of users with the `Manage Tags for Metrics` permission.
+Create and define a list of queryable tag keys for an existing count/gauge/rate/distribution metric. Optionally, include percentile aggregations on any distribution metric.
+Can only be used with application keys of users with the `Manage Tags for Metrics` permission.
 
 ### Examples
 
@@ -86,9 +85,8 @@ end
 
 > delete_tag_configuration(metric_name)
 
-Delete a tag configuration
-
-Deletes a metric's tag configuration. Can only be used with application keys from users with the `Manage Tags for Metrics` permission.
+Deletes a metric's tag configuration. Can only be used with application
+keys from users with the `Manage Tags for Metrics` permission.
 
 ### Examples
 
@@ -152,8 +150,6 @@ nil (empty response body)
 
 > <MetricTagConfigurationResponse> list_tag_configuration_by_name(metric_name)
 
-List tag configuration by name
-
 Returns the tag configuration for the given metric name.
 
 ### Examples
@@ -219,9 +215,8 @@ end
 
 > <MetricsAndMetricTagConfigurationsResponse> list_tag_configurations(opts)
 
-List tag configurations
-
-Returns all configured count/gauge/rate/distribution metric names (with additional filters if specified).
+Returns all configured count/gauge/rate/distribution metric names
+(with additional filters if specified).
 
 ### Examples
 
@@ -286,7 +281,7 @@ end
 
 ### Authorization
 
-[apiKeyAuth](README.md#apiKeyAuth), [appKeyAuth](README.md#appKeyAuth)
+[AuthZ](README.md#AuthZ), [apiKeyAuth](README.md#apiKeyAuth), [appKeyAuth](README.md#appKeyAuth)
 
 ### HTTP request headers
 
@@ -298,8 +293,6 @@ end
 
 > <MetricAllTagsResponse> list_tags_by_metric_name(metric_name)
 
-List tags by metric name
-
 View indexed tag key-value pairs for a given metric name.
 
 ### Examples
@@ -348,7 +341,7 @@ end
 
 ### Authorization
 
-[apiKeyAuth](README.md#apiKeyAuth), [appKeyAuth](README.md#appKeyAuth)
+[AuthZ](README.md#AuthZ), [apiKeyAuth](README.md#apiKeyAuth), [appKeyAuth](README.md#appKeyAuth)
 
 ### HTTP request headers
 
@@ -360,9 +353,11 @@ end
 
 > <MetricVolumesResponse> list_volumes_by_metric_name(metric_name)
 
-List distinct metric volumes by metric name
+View distinct metrics volumes for the given metric name.
 
-View distinct metrics volumes for the given metric name.  Custom distribution metrics will return both ingested and indexed custom metric volumes. For Metrics without Limits&trade; beta customers, all metrics will return both ingested/indexed volumes. Custom metrics generated in-app from other products will return `null` for ingested volumes.
+Custom distribution metrics will return both ingested and indexed custom metric volumes.
+For Metrics without Limits&trade; beta customers, all metrics will return both ingested/indexed volumes.
+Custom metrics generated in-app from other products will return `null` for ingested volumes.
 
 ### Examples
 
@@ -410,7 +405,7 @@ end
 
 ### Authorization
 
-[apiKeyAuth](README.md#apiKeyAuth), [appKeyAuth](README.md#appKeyAuth)
+[AuthZ](README.md#AuthZ), [apiKeyAuth](README.md#apiKeyAuth), [appKeyAuth](README.md#appKeyAuth)
 
 ### HTTP request headers
 
@@ -422,9 +417,8 @@ end
 
 > <MetricTagConfigurationResponse> update_tag_configuration(metric_name, body)
 
-Update a tag configuration
-
-Update the tag configuration of a metric or percentile aggregations of a distribution metric. Can only be used with application keys from users with the `Manage Tags for Metrics` permission.
+Update the tag configuration of a metric or percentile aggregations of a distribution metric. Can only be used with
+application keys from users with the `Manage Tags for Metrics` permission.
 
 ### Examples
 

data/docs/v2/PartialApplicationKeyResponse.md

@@ -0,0 +1,20 @@
+# DatadogAPIClient::V2::PartialApplicationKeyResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **data** | [**PartialApplicationKey**](PartialApplicationKey.md) |  | [optional] |
+| **included** | [**Array<ApplicationKeyResponseIncludedItem>**](ApplicationKeyResponseIncludedItem.md) | Array of objects related to the application key. | [optional] |
+
+## Example
+
+```ruby
+require 'datadog_api_client/v2'
+
+instance = DatadogAPIClient::V2::PartialApplicationKeyResponse.new(
+  data: null,
+  included: null
+)
+```
+

data/docs/v2/ProcessesAPI.md

@@ -11,8 +11,6 @@ All URIs are relative to *https://api.datadoghq.com*
 
 > <ProcessSummariesResponse> list_processes(opts)
 
-Get all processes
-
 Get all processes for your organization.
 
 ### Examples
@@ -73,7 +71,7 @@ end
 
 ### Authorization
 
-[apiKeyAuth](README.md#apiKeyAuth), [appKeyAuth](README.md#appKeyAuth)
+[AuthZ](README.md#AuthZ), [apiKeyAuth](README.md#apiKeyAuth), [appKeyAuth](README.md#appKeyAuth)
 
 ### HTTP request headers