datadog_api_client 1.1.0 → 1.2.0

data/docs/v1/EventsAPI.md

@@ -13,9 +13,8 @@ All URIs are relative to *https://api.datadoghq.com*
 
 > <EventCreateResponse> create_event(body)
 
-Post an event
-
-This endpoint allows you to post events to the stream. Tag them, set priority and event aggregate them with other events.
+This endpoint allows you to post events to the stream.
+Tag them, set priority and event aggregate them with other events.
 
 ### Examples
 
@@ -75,9 +74,10 @@ end
 
 > <EventResponse> get_event(event_id)
 
-Get an event
+This endpoint allows you to query for event details.
 
-This endpoint allows you to query for event details.  **Note**: If the event you’re querying contains markdown formatting of any kind, you may see characters such as `%`,`\\`,`n` in your output.
+**Note**: If the event you’re querying contains markdown formatting of any kind,
+you may see characters such as `%`,`\`,`n` in your output.
 
 ### Examples
 
@@ -137,9 +137,15 @@ end
 
 > <EventListResponse> list_events(start, _end, opts)
 
-Query the event stream
+The event stream can be queried and filtered by time, priority, sources and tags.
+
+**Notes**:
+- If the event you’re querying contains markdown formatting of any kind,
+you may see characters such as `%`,`\`,`n` in your output.
 
-The event stream can be queried and filtered by time, priority, sources and tags.  **Notes**: - If the event you’re querying contains markdown formatting of any kind, you may see characters such as `%`,`\\`,`n` in your output.  - This endpoint returns a maximum of `1000` most recent results. To return additional results, identify the last timestamp of the last result and set that as the `end` query time to paginate the results. You can also use the page parameter to specify which set of `1000` results to return.
+- This endpoint returns a maximum of `1000` most recent results. To return additional results,
+identify the last timestamp of the last result and set that as the `end` query time to
+paginate the results. You can also use the page parameter to specify which set of `1000` results to return.
 
 ### Examples
 

data/docs/v1/GCPIntegrationAPI.md

@@ -14,8 +14,6 @@ All URIs are relative to *https://api.datadoghq.com*
 
 > Object create_gcp_integration(body)
 
-Create a GCP integration
-
 Create a Datadog-GCP integration.
 
 ### Examples
@@ -76,8 +74,6 @@ end
 
 > Object delete_gcp_integration(body)
 
-Delete a GCP integration
-
 Delete a given Datadog-GCP integration.
 
 ### Examples
@@ -138,8 +134,6 @@ end
 
 > <Array<GCPAccount>> list_gcp_integration
 
-List all GCP integrations
-
 List all Datadog-GCP integrations configured in your Datadog account.
 
 ### Examples
@@ -197,9 +191,10 @@ This endpoint does not need any parameter.
 
 > Object update_gcp_integration(body)
 
-Update a GCP integration
-
-Update a Datadog-GCP integrations host_filters and/or auto-mute. Requires a `project_id` and `client_email`, however these fields cannot be updated. If you need to update these fields, delete and use the create (`POST`) endpoint. The unspecified fields will keep their original values.
+Update a Datadog-GCP integrations host_filters and/or auto-mute.
+Requires a `project_id` and `client_email`, however these fields cannot be updated.
+If you need to update these fields, delete and use the create (`POST`) endpoint.
+The unspecified fields will keep their original values.
 
 ### Examples
 

data/docs/v1/HTTPLogError.md

@@ -14,7 +14,7 @@ require 'datadog_api_client/v1'
 
 instance = DatadogAPIClient::V1::HTTPLogError.new(
   code: 0,
-  message: 
+  message: Your browser sent an invalid request.
 )
 ```
 

data/docs/v1/HostsAPI.md

@@ -14,9 +14,8 @@ All URIs are relative to *https://api.datadoghq.com*
 
 > <HostTotals> get_host_totals(opts)
 
-Get the total number of active hosts
-
-This endpoint returns the total number of active and up hosts in your Datadog account. Active means the host has reported in the past hour, and up means it has reported in the past two hours.
+This endpoint returns the total number of active and up hosts in your Datadog account.
+Active means the host has reported in the past hour, and up means it has reported in the past two hours.
 
 ### Examples
 
@@ -78,9 +77,10 @@ end
 
 > <HostListResponse> list_hosts(opts)
 
-Get all hosts for your organization
-
-This endpoint allows searching for hosts by name, alias, or tag. Hosts live within the past 3 hours are included by default. Retention is 7 days. Results are paginated with a max of 1000 results at a time.
+This endpoint allows searching for hosts by name, alias, or tag.
+Hosts live within the past 3 hours are included by default.
+Retention is 7 days.
+Results are paginated with a max of 1000 results at a time.
 
 ### Examples
 
@@ -156,8 +156,6 @@ end
 
 > <HostMuteResponse> mute_host(host_name, body)
 
-Mute a host
-
 Mute a host.
 
 ### Examples
@@ -220,8 +218,6 @@ end
 
 > <HostMuteResponse> unmute_host(host_name)
 
-Unmute a host
-
 Unmutes a host. This endpoint takes no JSON arguments.
 
 ### Examples

data/docs/v1/IPRangesAPI.md

@@ -11,8 +11,6 @@ All URIs are relative to *https://api.datadoghq.com*
 
 > <IPRanges> get_ip_ranges
 
-List IP Ranges
-
 Get information about Datadog IP ranges.
 
 ### Examples

data/docs/v1/KeyManagementAPI.md

@@ -20,8 +20,6 @@ All URIs are relative to *https://api.datadoghq.com*
 
 > <ApiKeyResponse> create_api_key(body)
 
-Create an API key
-
 Creates an API key with a given name.
 
 ### Examples
@@ -82,8 +80,6 @@ end
 
 > <ApplicationKeyResponse> create_application_key(body)
 
-Create an application key
-
 Create an application key with a given name.
 
 ### Examples
@@ -144,8 +140,6 @@ end
 
 > <ApiKeyResponse> delete_api_key(key)
 
-Delete an API key
-
 Delete a given API key.
 
 ### Examples
@@ -206,8 +200,6 @@ end
 
 > <ApplicationKeyResponse> delete_application_key(key)
 
-Delete an application key
-
 Delete a given application key.
 
 ### Examples
@@ -268,8 +260,6 @@ end
 
 > <ApiKeyResponse> get_api_key(key)
 
-Get API key
-
 Get a given API key.
 
 ### Examples
@@ -330,8 +320,6 @@ end
 
 > <ApplicationKeyResponse> get_application_key(key)
 
-Get an application key
-
 Get a given application key.
 
 ### Examples
@@ -392,8 +380,6 @@ end
 
 > <ApiKeyListResponse> list_api_keys
 
-Get all API keys
-
 Get all API keys available for your account.
 
 ### Examples
@@ -451,8 +437,6 @@ This endpoint does not need any parameter.
 
 > <ApplicationKeyListResponse> list_application_keys
 
-Get all application keys
-
 Get all application keys available for your Datadog account.
 
 ### Examples
@@ -510,8 +494,6 @@ This endpoint does not need any parameter.
 
 > <ApiKeyResponse> update_api_key(key, body)
 
-Edit an API key
-
 Edit an API key name.
 
 ### Examples
@@ -574,8 +556,6 @@ end
 
 > <ApplicationKeyResponse> update_application_key(key, body)
 
-Edit an application key
-
 Edit an application key name.
 
 ### Examples

data/docs/v1/LogsAPI.md

@@ -12,9 +12,15 @@ All URIs are relative to *https://api.datadoghq.com*
 
 > <LogsListResponse> list_logs(body)
 
-Search logs
+List endpoint returns logs that match a log search query.
+[Results are paginated][1].
 
-List endpoint returns logs that match a log search query. [Results are paginated][1].  **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
+**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
 
 ### Examples
 
@@ -74,9 +80,25 @@ end
 
 > Object submit_log(body, opts)
 
-Send logs
+Send your logs to your Datadog platform over HTTP. Limits per HTTP request are:
+
+- Maximum content size per payload (uncompressed): 5MB
+- Maximum size for a single log: 1MB
+- Maximum array size if sending multiple logs in an array: 1000 entries
+
+Any log exceeding 1MB is accepted and truncated by Datadog:
+- For a single log request, the API truncates the log at 1MB and returns a 2xx.
+- For a multi-logs request, the API processes all logs, truncates only logs larger than 1MB, and returns a 2xx.
+
+Datadog recommends sending your logs compressed.
+Add the `Content-Encoding: gzip` header to the request when sending compressed logs.
 
-Send your logs to your Datadog platform over HTTP. Limits per HTTP request are:  - Maximum content size per payload (uncompressed): 5MB - Maximum size for a single log: 1MB - Maximum array size if sending multiple logs in an array: 1000 entries  Any log exceeding 1MB is accepted and truncated by Datadog: - For a single log request, the API truncates the log at 1MB and returns a 2xx. - For a multi-logs request, the API processes all logs, truncates only logs larger than 1MB, and returns a 2xx.  Datadog recommends sending your logs compressed. Add the `Content-Encoding: gzip` header to the request when sending compressed logs.  The status codes answered by the HTTP API are: - 200: OK - 400: Bad request (likely an issue in the payload formatting) - 403: Permission issue (likely using an invalid API Key) - 413: Payload too large (batch is above 5MB uncompressed) - 5xx: Internal error, request should be retried after some time
+The status codes answered by the HTTP API are:
+- 200: OK
+- 400: Bad request (likely an issue in the payload formatting)
+- 403: Permission issue (likely using an invalid API Key)
+- 413: Payload too large (batch is above 5MB uncompressed)
+- 5xx: Internal error, request should be retried after some time
 
 ### Examples
 

data/docs/v1/LogsIndexesAPI.md

@@ -16,8 +16,6 @@ All URIs are relative to *https://api.datadoghq.com*
 
 > <LogsIndex> create_logs_index(body)
 
-Create an index
-
 Creates a new index. Returns the Index object passed in the request body when the request is successful.
 
 ### Examples
@@ -78,8 +76,6 @@ end
 
 > <LogsIndex> get_logs_index(name)
 
-Get an index
-
 Get one log index from your organization. This endpoint takes no JSON arguments.
 
 ### Examples
@@ -140,8 +136,6 @@ end
 
 > <LogsIndexesOrder> get_logs_index_order
 
-Get indexes order
-
 Get the current order of your log indexes. This endpoint takes no JSON arguments.
 
 ### Examples
@@ -199,9 +193,8 @@ This endpoint does not need any parameter.
 
 > <LogsIndexListResponse> list_log_indexes
 
-Get all indexes
-
-The Index object describes the configuration of a log index. This endpoint returns an array of the `LogIndex` objects of your organization.
+The Index object describes the configuration of a log index.
+This endpoint returns an array of the `LogIndex` objects of your organization.
 
 ### Examples
 
@@ -258,9 +251,11 @@ This endpoint does not need any parameter.
 
 > <LogsIndex> update_logs_index(name, body)
 
-Update an index
+Update an index as identified by its name.
+Returns the Index object passed in the request body when the request is successful.
 
-Update an index as identified by its name. Returns the Index object passed in the request body when the request is successful.  Using the `PUT` method updates your index’s configuration by **replacing** your current configuration with the new one sent to your Datadog organization.
+Using the `PUT` method updates your index’s configuration by **replacing**
+your current configuration with the new one sent to your Datadog organization.
 
 ### Examples
 
@@ -322,9 +317,8 @@ end
 
 > <LogsIndexesOrder> update_logs_index_order(body)
 
-Update indexes order
-
-This endpoint updates the index order of your organization. It returns the index order object passed in the request body when the request is successful.
+This endpoint updates the index order of your organization.
+It returns the index order object passed in the request body when the request is successful.
 
 ### Examples
 

data/docs/v1/LogsPipelinesAPI.md

@@ -17,8 +17,6 @@ All URIs are relative to *https://api.datadoghq.com*
 
 > <LogsPipeline> create_logs_pipeline(body)
 
-Create a pipeline
-
 Create a pipeline in your organization.
 
 ### Examples
@@ -79,9 +77,8 @@ end
 
 > delete_logs_pipeline(pipeline_id)
 
-Delete a pipeline
-
-Delete a given pipeline from your organization. This endpoint takes no JSON arguments.
+Delete a given pipeline from your organization.
+This endpoint takes no JSON arguments.
 
 ### Examples
 
@@ -140,9 +137,8 @@ nil (empty response body)
 
 > <LogsPipeline> get_logs_pipeline(pipeline_id)
 
-Get a pipeline
-
-Get a specific pipeline from your organization. This endpoint takes no JSON arguments.
+Get a specific pipeline from your organization.
+This endpoint takes no JSON arguments.
 
 ### Examples
 
@@ -202,9 +198,8 @@ end
 
 > <LogsPipelinesOrder> get_logs_pipeline_order
 
-Get pipeline order
-
-Get the current order of your pipelines. This endpoint takes no JSON arguments.
+Get the current order of your pipelines.
+This endpoint takes no JSON arguments.
 
 ### Examples
 
@@ -261,9 +256,8 @@ This endpoint does not need any parameter.
 
 > <Array<LogsPipeline>> list_logs_pipelines
 
-Get all pipelines
-
-Get all pipelines from your organization. This endpoint takes no JSON arguments.
+Get all pipelines from your organization.
+This endpoint takes no JSON arguments.
 
 ### Examples
 
@@ -320,9 +314,10 @@ This endpoint does not need any parameter.
 
 > <LogsPipeline> update_logs_pipeline(pipeline_id, body)
 
-Update a pipeline
+Update a given pipeline configuration to change it’s processors or their order.
 
-Update a given pipeline configuration to change it’s processors or their order.  **Note**: Using this method updates your pipeline configuration by **replacing** your current configuration with the new one sent to your Datadog organization.
+**Note**: Using this method updates your pipeline configuration by **replacing**
+your current configuration with the new one sent to your Datadog organization.
 
 ### Examples
 
@@ -384,9 +379,11 @@ end
 
 > <LogsPipelinesOrder> update_logs_pipeline_order(body)
 
-Update pipeline order
+Update the order of your pipelines. Since logs are processed sequentially, reordering a pipeline may change
+the structure and content of the data processed by other pipelines and their processors.
 
-Update the order of your pipelines. Since logs are processed sequentially, reordering a pipeline may change the structure and content of the data processed by other pipelines and their processors.  **Note**: Using the `PUT` method updates your pipeline order by replacing your current order with the new one sent to your Datadog organization.
+**Note**: Using the `PUT` method updates your pipeline order by replacing your current order
+with the new one sent to your Datadog organization.
 
 ### Examples
 

data/docs/v1/MetricsAPI.md

@@ -16,8 +16,6 @@ All URIs are relative to *https://api.datadoghq.com*
 
 > <MetricMetadata> get_metric_metadata(metric_name)
 
-Get metric metadata
-
 Get metadata about a specific metric.
 
 ### Examples
@@ -78,8 +76,6 @@ end
 
 > <MetricsListResponse> list_active_metrics(from, opts)
 
-Get active metrics list
-
 Get the list of actively reporting metrics from a given time until now.
 
 ### Examples
@@ -146,8 +142,6 @@ end
 
 > <MetricSearchResponse> list_metrics(q)
 
-Search metrics
-
 Search for metrics from the last 24 hours in Datadog.
 
 ### Examples
@@ -208,8 +202,6 @@ end
 
 > <MetricsQueryResponse> query_metrics(from, to, query)
 
-Query timeseries points
-
 Query timeseries points.
 
 ### Examples
@@ -274,9 +266,17 @@ end
 
 > <IntakePayloadAccepted> submit_metrics(body)
 
-Submit metrics
+The metrics end-point allows you to post time-series data that can be graphed on Datadog’s dashboards.
+The maximum payload size is 3.2 megabytes (3200000 bytes). Compressed payloads must have a decompressed size of less than 62 megabytes (62914560 bytes).
+
+If you’re submitting metrics directly to the Datadog API without using DogStatsD, expect:
 
-The metrics end-point allows you to post time-series data that can be graphed on Datadog’s dashboards. The maximum payload size is 3.2 megabytes (3200000 bytes). Compressed payloads must have a decompressed size of less than 62 megabytes (62914560 bytes).  If you’re submitting metrics directly to the Datadog API without using DogStatsD, expect:  - 64 bits for the timestamp - 32 bits for the value - 20 bytes for the metric names - 50 bytes for the timeseries - The full payload is approximately 100 bytes. However, with the DogStatsD API, compression is applied, which reduces the payload size.
+- 64 bits for the timestamp
+- 32 bits for the value
+- 20 bytes for the metric names
+- 50 bytes for the timeseries
+- The full payload is approximately 100 bytes. However, with the DogStatsD API,
+compression is applied, which reduces the payload size.
 
 ### Examples
 
@@ -336,8 +336,6 @@ end
 
 > <MetricMetadata> update_metric_metadata(metric_name, body)
 
-Edit metric metadata
-
 Edit metadata of a specific metric. Find out more about [supported types](https://docs.datadoghq.com/developers/metrics).
 
 ### Examples