datadog_api_client 1.1.0 → 1.2.0

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
 
@@ -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
@@ -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
 
@@ -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/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

data/docs/v2/README.md

@@ -57,6 +57,7 @@ Class | Method | HTTP request | Description
 *DatadogAPIClient::V2::KeyManagementAPI* | [**delete_application_key**](KeyManagementAPI.md#delete_application_key) | **DELETE** /api/v2/application_keys/{app_key_id} | Delete an application key
 *DatadogAPIClient::V2::KeyManagementAPI* | [**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
 *DatadogAPIClient::V2::KeyManagementAPI* | [**get_api_key**](KeyManagementAPI.md#get_api_key) | **GET** /api/v2/api_keys/{api_key_id} | Get API key
+*DatadogAPIClient::V2::KeyManagementAPI* | [**get_application_key**](KeyManagementAPI.md#get_application_key) | **GET** /api/v2/application_keys/{app_key_id} | Get an application key
 *DatadogAPIClient::V2::KeyManagementAPI* | [**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
 *DatadogAPIClient::V2::KeyManagementAPI* | [**list_api_keys**](KeyManagementAPI.md#list_api_keys) | **GET** /api/v2/api_keys | Get all API keys
 *DatadogAPIClient::V2::KeyManagementAPI* | [**list_application_keys**](KeyManagementAPI.md#list_application_keys) | **GET** /api/v2/application_keys | Get all application keys
@@ -381,7 +382,6 @@ Class | Method | HTTP request | Description
  - [DatadogAPIClient::V2::SecurityFilterCreateAttributes](SecurityFilterCreateAttributes.md)
  - [DatadogAPIClient::V2::SecurityFilterCreateData](SecurityFilterCreateData.md)
  - [DatadogAPIClient::V2::SecurityFilterCreateRequest](SecurityFilterCreateRequest.md)
- - [DatadogAPIClient::V2::SecurityFilterDeleteResponse](SecurityFilterDeleteResponse.md)
  - [DatadogAPIClient::V2::SecurityFilterExclusionFilter](SecurityFilterExclusionFilter.md)
  - [DatadogAPIClient::V2::SecurityFilterExclusionFilterResponse](SecurityFilterExclusionFilterResponse.md)
  - [DatadogAPIClient::V2::SecurityFilterFilteredDataType](SecurityFilterFilteredDataType.md)

data/docs/v2/RolesAPI.md

@@ -22,8 +22,6 @@ All URIs are relative to *https://api.datadoghq.com*
 
 > <PermissionsResponse> add_permission_to_role(role_id, body)
 
-Grant permission to a role
-
 Adds a permission to a role.
 
 ### Examples
@@ -86,8 +84,6 @@ end
 
 > <UsersResponse> add_user_to_role(role_id, body)
 
-Add a user to a role
-
 Adds a user to a role.
 
 ### Examples
@@ -150,8 +146,6 @@ end
 
 > <RoleCreateResponse> create_role(body)
 
-Create role
-
 Create a new role for your organization.
 
 ### Examples
@@ -212,8 +206,6 @@ end
 
 > delete_role(role_id)
 
-Delete role
-
 Disables a role.
 
 ### Examples
@@ -273,8 +265,6 @@ nil (empty response body)
 
 > <RoleResponse> get_role(role_id)
 
-Get a role
-
 Get a role in the organization specified by the role’s `role_id`.
 
 ### Examples
@@ -335,8 +325,6 @@ end
 
 > <PermissionsResponse> list_permissions
 
-List permissions
-
 Returns a list of all permissions, including name, description, and ID.
 
 ### Examples
@@ -394,8 +382,6 @@ This endpoint does not need any parameter.
 
 > <PermissionsResponse> list_role_permissions(role_id)
 
-List permissions for a role
-
 Returns a list of all permissions for a single role.
 
 ### Examples
@@ -456,8 +442,6 @@ end
 
 > <UsersResponse> list_role_users(role_id, opts)
 
-Get all users of a role
-
 Gets all users of a role.
 
 ### Examples
@@ -528,8 +512,6 @@ end
 
 > <RolesResponse> list_roles(opts)
 
-List roles
-
 Returns all roles, including their names and IDs.
 
 ### Examples
@@ -598,8 +580,6 @@ end
 
 > <PermissionsResponse> remove_permission_from_role(role_id, body)
 
-Revoke permission
-
 Removes a permission from a role.
 
 ### Examples
@@ -662,8 +642,6 @@ end
 
 > <UsersResponse> remove_user_from_role(role_id, body)
 
-Remove a user from a role
-
 Removes a user from a role.
 
 ### Examples
@@ -726,8 +704,6 @@ end
 
 > <RoleUpdateResponse> update_role(role_id, body)
 
-Update a role
-
 Edit a role. Can only be used with application keys belonging to administrators.
 
 ### Examples

data/docs/v2/SecurityMonitoringAPI.md

@@ -22,9 +22,10 @@ All URIs are relative to *https://api.datadoghq.com*
 
 > <SecurityFilterResponse> create_security_filter(body)
 
-Create a security filter
+Create a security filter.
 
-Create a security filter.  See the [security filter guide](https://docs.datadoghq.com/security_platform/guide/how-to-setup-security-filters-using-security-monitoring-api/) for more examples.
+See the [security filter guide](https://docs.datadoghq.com/security_platform/guide/how-to-setup-security-filters-using-security-monitoring-api/)
+for more examples.
 
 ### Examples
 
@@ -84,8 +85,6 @@ end
 
 > <SecurityMonitoringRuleResponse> create_security_monitoring_rule(body)
 
-Create a detection rule
-
 Create a detection rule.
 
 ### Examples
@@ -93,7 +92,7 @@ Create a detection rule.
 ```ruby
 require 'datadog_api_client'
 api_instance = DatadogAPIClient::V2::SecurityMonitoringAPI.new
-body = DatadogAPIClient::V2::SecurityMonitoringRuleCreatePayload.new({cases: [DatadogAPIClient::V2::SecurityMonitoringRuleCaseCreate.new({status: DatadogAPIClient::V2::SecurityMonitoringRuleSeverity::INFO})], is_enabled: true, message: 'message_example', name: 'name_example', options: DatadogAPIClient::V2::SecurityMonitoringRuleOptions.new, queries: [DatadogAPIClient::V2::SecurityMonitoringRuleQueryCreate.new({query: 'a < 3'})]}) # SecurityMonitoringRuleCreatePayload | 
+body = DatadogAPIClient::V2::SecurityMonitoringRuleCreatePayload.new({cases: [DatadogAPIClient::V2::SecurityMonitoringRuleCaseCreate.new({status: DatadogAPIClient::V2::SecurityMonitoringRuleSeverity::INFO})], is_enabled: true, message: 'message_example', name: 'My security monitoring rule.', options: DatadogAPIClient::V2::SecurityMonitoringRuleOptions.new, queries: [DatadogAPIClient::V2::SecurityMonitoringRuleQueryCreate.new({query: 'a > 3'})]}) # SecurityMonitoringRuleCreatePayload | 
 
 begin
   # Create a detection rule
@@ -144,9 +143,7 @@ end
 
 ## delete_security_filter
 
-> <SecurityFilterDeleteResponse> delete_security_filter(security_filter_id)
-
-Delete a security filter
+> delete_security_filter(security_filter_id)
 
 Delete a specific security filter.
 
@@ -159,8 +156,7 @@ security_filter_id = 'security_filter_id_example' # String | The ID of the secur
 
 begin
   # Delete a security filter
-  result = api_instance.delete_security_filter(security_filter_id)
-  p result
+  api_instance.delete_security_filter(security_filter_id)
 rescue DatadogAPIClient::V2::APIError => e
   puts "Error when calling SecurityMonitoringAPI->delete_security_filter: #{e}"
 end
@@ -168,9 +164,9 @@ end
 
 #### Using the delete_security_filter_with_http_info variant
 
-This returns an Array which contains the response data, status code and headers.
+This returns an Array which contains the response data (`nil` in this case), status code and headers.
 
-> <Array(<SecurityFilterDeleteResponse>, Integer, Hash)> delete_security_filter_with_http_info(security_filter_id)
+> <Array(nil, Integer, Hash)> delete_security_filter_with_http_info(security_filter_id)
 
 ```ruby
 begin
@@ -178,7 +174,7 @@ begin
   data, status_code, headers = api_instance.delete_security_filter_with_http_info(security_filter_id)
   p status_code # => 2xx
   p headers # => { ... }
-  p data # => <SecurityFilterDeleteResponse>
+  p data # => nil
 rescue DatadogAPIClient::V2::APIError => e
   puts "Error when calling SecurityMonitoringAPI->delete_security_filter_with_http_info: #{e}"
 end
@@ -192,7 +188,7 @@ end
 
 ### Return type
 
-[**SecurityFilterDeleteResponse**](SecurityFilterDeleteResponse.md)
+nil (empty response body)
 
 ### Authorization
 
@@ -208,8 +204,6 @@ end
 
 > delete_security_monitoring_rule(rule_id)
 
-Delete an existing rule
-
 Delete an existing rule. Default rules cannot be deleted.
 
 ### Examples
@@ -269,9 +263,10 @@ nil (empty response body)
 
 > <SecurityFilterResponse> get_security_filter(security_filter_id)
 
-Get a security filter
+Get the details of a specific security filter.
 
-Get the details of a specific security filter.  See the [security filter guide](https://docs.datadoghq.com/security_platform/guide/how-to-setup-security-filters-using-security-monitoring-api/) for more examples.
+See the [security filter guide](https://docs.datadoghq.com/security_platform/guide/how-to-setup-security-filters-using-security-monitoring-api/)
+for more examples.
 
 ### Examples
 
@@ -331,8 +326,6 @@ end
 
 > <SecurityMonitoringRuleResponse> get_security_monitoring_rule(rule_id)
 
-Get a rule's details
-
 Get a rule's details.
 
 ### Examples
@@ -393,8 +386,6 @@ end
 
 > <SecurityFiltersResponse> list_security_filters
 
-Get all security filters
-
 Get the list of configured security filters with their definitions.
 
 ### Examples
@@ -452,8 +443,6 @@ This endpoint does not need any parameter.
 
 > <SecurityMonitoringListRulesResponse> list_security_monitoring_rules(opts)
 
-List rules
-
 List rules.
 
 ### Examples
@@ -518,9 +507,9 @@ end
 
 > <SecurityMonitoringSignalsListResponse> list_security_monitoring_signals(opts)
 
-Get a quick list of security signals
-
-The list endpoint returns security signals that match a search query. Both this endpoint and the POST endpoint can be used interchangeably when listing security signals.
+The list endpoint returns security signals that match a search query.
+Both this endpoint and the POST endpoint can be used interchangeably when listing
+security signals.
 
 ### Examples
 
@@ -597,9 +586,9 @@ end
 
 > <SecurityMonitoringSignalsListResponse> search_security_monitoring_signals(opts)
 
-Get a list of security signals
-
-Returns security signals that match a search query. Both this endpoint and the GET endpoint can be used interchangeably for listing security signals.
+Returns security signals that match a search query.
+Both this endpoint and the GET endpoint can be used interchangeably for listing
+security signals.
 
 ### Examples
 
@@ -666,9 +655,8 @@ end
 
 > <SecurityFilterResponse> update_security_filter(security_filter_id, body)
 
-Update a security filter
-
-Update a specific security filter. Returns the security filter object when the request is successful.
+Update a specific security filter.
+Returns the security filter object when the request is successful.
 
 ### Examples
 
@@ -730,9 +718,9 @@ end
 
 > <SecurityMonitoringRuleResponse> update_security_monitoring_rule(rule_id, body)
 
-Update an existing rule
-
-Update an existing rule. When updating `cases`, `queries` or `options`, the whole field must be included. For example, when modifying a query all queries must be included. Default rules can only be updated to be enabled and to change notifications.
+Update an existing rule. When updating `cases`, `queries` or `options`, the whole field
+must be included. For example, when modifying a query all queries must be included.
+Default rules can only be updated to be enabled and to change notifications.
 
 ### Examples