datadog_api_client 1.0.0.beta.3 → 1.0.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/.apigentools-info +4 -4
- data/.azure-pipelines/all.yml +0 -1
- data/.rubocop.yml +1 -1
- data/CHANGELOG.md +23 -0
- data/Gemfile +1 -1
- data/LICENSE-3rdparty.csv +0 -1
- data/check-examples.sh +7 -2
- data/data/v1/openapi.yaml +1963 -245
- data/data/v2/openapi.yaml +67 -13
- data/docs/v1/DashboardsAPI.md +10 -5
- data/docs/v1/DistributionWidgetDefinition.md +9 -3
- data/docs/v1/DistributionWidgetXAxis.md +24 -0
- data/docs/v1/DistributionWidgetYAxis.md +26 -0
- data/docs/v1/EventsAPI.md +7 -3
- data/docs/v1/GroupWidgetDefinition.md +8 -0
- data/docs/v1/ImageWidgetDefinition.md +11 -1
- data/docs/v1/LogsByRetention.md +22 -0
- data/docs/v1/LogsByRetentionMonthlyUsage.md +20 -0
- data/docs/v1/LogsByRetentionOrgUsage.md +18 -0
- data/docs/v1/LogsByRetentionOrgs.md +18 -0
- data/docs/v1/LogsRetentionAggSumUsage.md +24 -0
- data/docs/v1/LogsRetentionSumUsage.md +24 -0
- data/docs/v1/MonitorsAPI.md +1 -1
- data/docs/v1/NoteWidgetDefinition.md +5 -1
- data/docs/v1/NotebookAbsoluteTime.md +22 -0
- data/docs/v1/NotebookAuthor.md +34 -0
- data/docs/v1/NotebookCellCreateRequest.md +20 -0
- data/docs/v1/NotebookCellCreateRequestAttributes.md +57 -0
- data/docs/v1/NotebookCellResourceType.md +15 -0
- data/docs/v1/NotebookCellResponse.md +22 -0
- data/docs/v1/NotebookCellResponseAttributes.md +57 -0
- data/docs/v1/NotebookCellTime.md +49 -0
- data/docs/v1/NotebookCellUpdateRequest.md +22 -0
- data/docs/v1/NotebookCellUpdateRequestAttributes.md +57 -0
- data/docs/v1/NotebookCreateData.md +20 -0
- data/docs/v1/NotebookCreateDataAttributes.md +24 -0
- data/docs/v1/NotebookCreateRequest.md +18 -0
- data/docs/v1/NotebookDistributionCellAttributes.md +24 -0
- data/docs/v1/NotebookGlobalTime.md +49 -0
- data/docs/v1/NotebookGraphSize.md +15 -0
- data/docs/v1/NotebookHeatMapCellAttributes.md +24 -0
- data/docs/v1/NotebookLogStreamCellAttributes.md +22 -0
- data/docs/v1/NotebookMarkdownCellAttributes.md +18 -0
- data/docs/v1/NotebookMarkdownCellDefinition.md +21 -0
- data/docs/v1/NotebookMarkdownCellDefinitionType.md +15 -0
- data/docs/v1/NotebookRelativeTime.md +18 -0
- data/docs/v1/NotebookResourceType.md +15 -0
- data/docs/v1/NotebookResponse.md +18 -0
- data/docs/v1/NotebookResponseData.md +22 -0
- data/docs/v1/NotebookResponseDataAttributes.md +30 -0
- data/docs/v1/NotebookSplitBy.md +20 -0
- data/docs/v1/NotebookStatus.md +15 -0
- data/docs/v1/NotebookTimeseriesCellAttributes.md +24 -0
- data/docs/v1/NotebookToplistCellAttributes.md +24 -0
- data/docs/v1/NotebookUpdateCell.md +49 -0
- data/docs/v1/NotebookUpdateData.md +20 -0
- data/docs/v1/NotebookUpdateDataAttributes.md +24 -0
- data/docs/v1/NotebookUpdateRequest.md +18 -0
- data/docs/v1/NotebooksAPI.md +339 -0
- data/docs/v1/NotebooksResponse.md +20 -0
- data/docs/v1/NotebooksResponseMeta.md +18 -0
- data/docs/v1/NotebooksResponsePage.md +20 -0
- data/docs/v1/README.md +66 -9
- data/docs/v1/SLOListResponse.md +3 -1
- data/docs/v1/SLOListResponseMetadata.md +18 -0
- data/docs/v1/SLOListResponseMetadataPage.md +20 -0
- data/docs/v1/SLOResponse.md +1 -1
- data/docs/v1/SLOResponseData.md +44 -0
- data/docs/v1/ServiceLevelObjectivesAPI.md +8 -4
- data/docs/v1/SyntheticsAPI.md +28 -156
- data/docs/v1/SyntheticsAPIStep.md +4 -0
- data/docs/v1/SyntheticsBrowserTestConfig.md +2 -0
- data/docs/v1/SyntheticsTestConfig.md +1 -1
- data/docs/v1/SyntheticsTestOptions.md +1 -1
- data/docs/v1/SyntheticsTestRequest.md +6 -0
- data/docs/v1/UsageAttributionSupportedMetrics.md +15 -0
- data/docs/v1/UsageAttributionValues.md +8 -0
- data/docs/v1/UsageHostHour.md +3 -1
- data/docs/v1/UsageIoTHour.md +1 -1
- data/docs/v1/UsageLogsByRetentionHour.md +24 -0
- data/docs/v1/UsageLogsByRetentionResponse.md +18 -0
- data/docs/v1/UsageMeteringAPI.md +69 -2
- data/docs/v1/UsageSummaryDate.md +11 -9
- data/docs/v1/UsageSummaryDateOrg.md +3 -1
- data/docs/v1/UsageSummaryResponse.md +5 -1
- data/docs/v1/WidgetHorizontalAlign.md +15 -0
- data/docs/v1/WidgetLayout.md +2 -0
- data/docs/v1/WidgetMarker.md +1 -1
- data/docs/v1/WidgetVerticalAlign.md +15 -0
- data/docs/v2/IncidentServiceUpdateData.md +1 -1
- data/docs/v2/IncidentServicesAPI.md +1 -1
- data/docs/v2/IncidentTeamUpdateData.md +1 -1
- data/docs/v2/IncidentTeamsAPI.md +1 -1
- data/docs/v2/MetricsAPI.md +1 -11
- data/extract-code-blocks.sh +6 -2
- data/lib/datadog_api_client/v1.rb +54 -0
- data/lib/datadog_api_client/v1/api/dashboards_api.rb +3 -0
- data/lib/datadog_api_client/v1/api/events_api.rb +14 -4
- data/lib/datadog_api_client/v1/api/monitors_api.rb +2 -2
- data/lib/datadog_api_client/v1/api/notebooks_api.rb +418 -0
- data/lib/datadog_api_client/v1/api/service_level_objectives_api.rb +3 -0
- data/lib/datadog_api_client/v1/api/synthetics_api.rb +14 -170
- data/lib/datadog_api_client/v1/api/usage_metering_api.rb +79 -2
- data/lib/datadog_api_client/v1/models/distribution_widget_definition.rb +36 -6
- data/lib/datadog_api_client/v1/models/distribution_widget_x_axis.rb +259 -0
- data/lib/datadog_api_client/v1/models/distribution_widget_y_axis.rb +269 -0
- data/lib/datadog_api_client/v1/models/group_widget_definition.rb +42 -1
- data/lib/datadog_api_client/v1/models/image_widget_definition.rb +56 -4
- data/lib/datadog_api_client/v1/models/logs_by_retention.rb +243 -0
- data/lib/datadog_api_client/v1/models/logs_by_retention_monthly_usage.rb +235 -0
- data/lib/datadog_api_client/v1/models/logs_by_retention_org_usage.rb +225 -0
- data/lib/datadog_api_client/v1/models/logs_by_retention_orgs.rb +225 -0
- data/lib/datadog_api_client/v1/models/logs_retention_agg_sum_usage.rb +253 -0
- data/lib/datadog_api_client/v1/models/logs_retention_sum_usage.rb +253 -0
- data/lib/datadog_api_client/v1/models/note_widget_definition.rb +25 -4
- data/lib/datadog_api_client/v1/models/notebook_absolute_time.rb +253 -0
- data/lib/datadog_api_client/v1/models/notebook_author.rb +303 -0
- data/lib/datadog_api_client/v1/models/notebook_cell_create_request.rb +243 -0
- data/lib/datadog_api_client/v1/models/notebook_cell_create_request_attributes.rb +113 -0
- data/lib/datadog_api_client/v1/models/notebook_cell_resource_type.rb +39 -0
- data/lib/datadog_api_client/v1/models/notebook_cell_response.rb +258 -0
- data/lib/datadog_api_client/v1/models/notebook_cell_response_attributes.rb +113 -0
- data/lib/datadog_api_client/v1/models/notebook_cell_time.rb +109 -0
- data/lib/datadog_api_client/v1/models/notebook_cell_update_request.rb +258 -0
- data/lib/datadog_api_client/v1/models/notebook_cell_update_request_attributes.rb +113 -0
- data/lib/datadog_api_client/v1/models/notebook_create_data.rb +243 -0
- data/lib/datadog_api_client/v1/models/notebook_create_data_attributes.rb +298 -0
- data/lib/datadog_api_client/v1/models/notebook_create_request.rb +227 -0
- data/lib/datadog_api_client/v1/models/notebook_distribution_cell_attributes.rb +255 -0
- data/lib/datadog_api_client/v1/models/notebook_global_time.rb +109 -0
- data/lib/datadog_api_client/v1/models/notebook_graph_size.rb +43 -0
- data/lib/datadog_api_client/v1/models/notebook_heat_map_cell_attributes.rb +255 -0
- data/lib/datadog_api_client/v1/models/notebook_log_stream_cell_attributes.rb +246 -0
- data/lib/datadog_api_client/v1/models/notebook_markdown_cell_attributes.rb +227 -0
- data/lib/datadog_api_client/v1/models/notebook_markdown_cell_definition.rb +244 -0
- data/lib/datadog_api_client/v1/models/notebook_markdown_cell_definition_type.rb +39 -0
- data/lib/datadog_api_client/v1/models/notebook_relative_time.rb +227 -0
- data/lib/datadog_api_client/v1/models/notebook_resource_type.rb +39 -0
- data/lib/datadog_api_client/v1/models/notebook_response.rb +222 -0
- data/lib/datadog_api_client/v1/models/notebook_response_data.rb +258 -0
- data/lib/datadog_api_client/v1/models/notebook_response_data_attributes.rb +327 -0
- data/lib/datadog_api_client/v1/models/notebook_split_by.rb +247 -0
- data/lib/datadog_api_client/v1/models/notebook_status.rb +39 -0
- data/lib/datadog_api_client/v1/models/notebook_timeseries_cell_attributes.rb +255 -0
- data/lib/datadog_api_client/v1/models/notebook_toplist_cell_attributes.rb +255 -0
- data/lib/datadog_api_client/v1/models/notebook_update_cell.rb +109 -0
- data/lib/datadog_api_client/v1/models/notebook_update_data.rb +243 -0
- data/lib/datadog_api_client/v1/models/notebook_update_data_attributes.rb +298 -0
- data/lib/datadog_api_client/v1/models/notebook_update_request.rb +227 -0
- data/lib/datadog_api_client/v1/models/notebooks_response.rb +234 -0
- data/lib/datadog_api_client/v1/models/notebooks_response_meta.rb +222 -0
- data/lib/datadog_api_client/v1/models/notebooks_response_page.rb +233 -0
- data/lib/datadog_api_client/v1/models/slo_list_response.rb +13 -4
- data/lib/datadog_api_client/v1/models/slo_list_response_metadata.rb +222 -0
- data/lib/datadog_api_client/v1/models/slo_list_response_metadata_page.rb +233 -0
- data/lib/datadog_api_client/v1/models/slo_response.rb +1 -1
- data/lib/datadog_api_client/v1/models/slo_response_data.rb +363 -0
- data/lib/datadog_api_client/v1/models/synthetics_api_step.rb +21 -1
- data/lib/datadog_api_client/v1/models/synthetics_assertion_type.rb +4 -0
- data/lib/datadog_api_client/v1/models/synthetics_browser_test_config.rb +11 -1
- data/lib/datadog_api_client/v1/models/synthetics_test_config.rb +0 -5
- data/lib/datadog_api_client/v1/models/synthetics_test_details_sub_type.rb +1 -0
- data/lib/datadog_api_client/v1/models/synthetics_test_options.rb +1 -1
- data/lib/datadog_api_client/v1/models/synthetics_test_request.rb +79 -1
- data/lib/datadog_api_client/v1/models/synthetics_tick_interval.rb +1 -0
- data/lib/datadog_api_client/v1/models/usage_attribution_supported_metrics.rb +67 -0
- data/lib/datadog_api_client/v1/models/usage_attribution_values.rb +41 -1
- data/lib/datadog_api_client/v1/models/usage_host_hour.rb +14 -4
- data/lib/datadog_api_client/v1/models/usage_io_t_hour.rb +1 -1
- data/lib/datadog_api_client/v1/models/usage_logs_by_retention_hour.rb +253 -0
- data/lib/datadog_api_client/v1/models/usage_logs_by_retention_response.rb +225 -0
- data/lib/datadog_api_client/v1/models/usage_summary_date.rb +38 -28
- data/lib/datadog_api_client/v1/models/usage_summary_date_org.rb +14 -4
- data/lib/datadog_api_client/v1/models/usage_summary_response.rb +23 -4
- data/lib/datadog_api_client/v1/models/widget.rb +1 -1
- data/lib/datadog_api_client/v1/models/widget_horizontal_align.rb +41 -0
- data/lib/datadog_api_client/v1/models/widget_image_sizing.rb +5 -0
- data/lib/datadog_api_client/v1/models/widget_layout.rb +12 -2
- data/lib/datadog_api_client/v1/models/widget_margin.rb +3 -0
- data/lib/datadog_api_client/v1/models/widget_marker.rb +1 -1
- data/lib/datadog_api_client/v1/models/widget_vertical_align.rb +41 -0
- data/lib/datadog_api_client/v2/api/metrics_api.rb +2 -2
- data/lib/datadog_api_client/v2/configuration.rb +0 -2
- data/lib/datadog_api_client/v2/models/incident_service_update_data.rb +0 -5
- data/lib/datadog_api_client/v2/models/incident_team_update_data.rb +0 -5
- data/lib/datadog_api_client/v2/models/metric_tag_configuration_metric_types.rb +1 -0
- data/lib/datadog_api_client/v2/models/security_monitoring_rule_detection_method.rb +1 -0
- data/lib/datadog_api_client/version.rb +1 -1
- data/run-tests.sh +0 -6
- data/spec/v1/api/notebooks_api_spec.rb +106 -0
- data/spec/v1/models/distribution_widget_x_axis_spec.rb +55 -0
- data/spec/v1/models/distribution_widget_y_axis_spec.rb +61 -0
- data/spec/v1/models/logs_by_retention_monthly_usage_spec.rb +43 -0
- data/spec/v1/models/logs_by_retention_org_usage_spec.rb +37 -0
- data/spec/v1/models/logs_by_retention_orgs_spec.rb +37 -0
- data/spec/v1/models/logs_by_retention_spec.rb +49 -0
- data/spec/v1/models/logs_retention_agg_sum_usage_spec.rb +55 -0
- data/spec/v1/models/logs_retention_sum_usage_spec.rb +55 -0
- data/spec/v1/models/notebook_absolute_time_spec.rb +49 -0
- data/spec/v1/models/notebook_author_spec.rb +85 -0
- data/spec/v1/models/notebook_cell_create_request_attributes_spec.rb +34 -0
- data/spec/v1/models/notebook_cell_create_request_spec.rb +43 -0
- data/spec/v1/models/notebook_cell_resource_type_spec.rb +31 -0
- data/spec/v1/models/notebook_cell_response_attributes_spec.rb +34 -0
- data/spec/v1/models/notebook_cell_response_spec.rb +49 -0
- data/spec/v1/models/notebook_cell_time_spec.rb +34 -0
- data/spec/v1/models/notebook_cell_update_request_attributes_spec.rb +34 -0
- data/spec/v1/models/notebook_cell_update_request_spec.rb +49 -0
- data/spec/v1/models/notebook_create_data_attributes_spec.rb +55 -0
- data/spec/v1/models/notebook_create_data_spec.rb +43 -0
- data/spec/v1/models/notebook_create_request_spec.rb +37 -0
- data/spec/v1/models/notebook_distribution_cell_attributes_spec.rb +55 -0
- data/spec/v1/models/notebook_global_time_spec.rb +34 -0
- data/spec/v1/models/notebook_graph_size_spec.rb +31 -0
- data/spec/v1/models/notebook_heat_map_cell_attributes_spec.rb +55 -0
- data/spec/v1/models/notebook_log_stream_cell_attributes_spec.rb +49 -0
- data/spec/v1/models/notebook_markdown_cell_attributes_spec.rb +37 -0
- data/spec/v1/models/notebook_markdown_cell_definition_spec.rb +43 -0
- data/spec/v1/models/notebook_markdown_cell_definition_type_spec.rb +31 -0
- data/spec/v1/models/notebook_relative_time_spec.rb +37 -0
- data/spec/v1/models/notebook_resource_type_spec.rb +31 -0
- data/spec/v1/models/notebook_response_data_attributes_spec.rb +73 -0
- data/spec/v1/models/notebook_response_data_spec.rb +49 -0
- data/spec/v1/models/notebook_response_spec.rb +37 -0
- data/spec/v1/models/notebook_split_by_spec.rb +43 -0
- data/spec/v1/models/notebook_status_spec.rb +31 -0
- data/spec/v1/models/notebook_timeseries_cell_attributes_spec.rb +55 -0
- data/spec/v1/models/notebook_toplist_cell_attributes_spec.rb +55 -0
- data/spec/v1/models/notebook_update_cell_spec.rb +34 -0
- data/spec/v1/models/notebook_update_data_attributes_spec.rb +55 -0
- data/spec/v1/models/notebook_update_data_spec.rb +43 -0
- data/spec/v1/models/notebook_update_request_spec.rb +37 -0
- data/spec/v1/models/notebooks_response_meta_spec.rb +37 -0
- data/spec/v1/models/notebooks_response_page_spec.rb +43 -0
- data/spec/v1/models/notebooks_response_spec.rb +43 -0
- data/spec/v1/models/slo_list_response_metadata_page_spec.rb +43 -0
- data/spec/v1/models/slo_list_response_metadata_spec.rb +37 -0
- data/spec/v1/models/slo_response_data_spec.rb +115 -0
- data/spec/v1/models/usage_attribution_supported_metrics_spec.rb +31 -0
- data/spec/v1/models/usage_logs_by_retention_hour_spec.rb +55 -0
- data/spec/v1/models/usage_logs_by_retention_response_spec.rb +37 -0
- data/spec/v1/models/widget_horizontal_align_spec.rb +31 -0
- data/spec/v1/models/widget_vertical_align_spec.rb +31 -0
- metadata +220 -4
@@ -0,0 +1,339 @@
|
|
1
|
+
# DatadogAPIClient::V1::NotebooksAPI
|
2
|
+
|
3
|
+
All URIs are relative to *https://api.datadoghq.com*
|
4
|
+
|
5
|
+
| Method | HTTP request | Description |
|
6
|
+
| ------ | ------------ | ----------- |
|
7
|
+
| [**create_notebook**](NotebooksAPI.md#create_notebook) | **POST** /api/v1/notebooks | Create a notebook |
|
8
|
+
| [**delete_notebook**](NotebooksAPI.md#delete_notebook) | **DELETE** /api/v1/notebooks/{notebook_id} | Delete a notebook |
|
9
|
+
| [**get_notebook**](NotebooksAPI.md#get_notebook) | **GET** /api/v1/notebooks/{notebook_id} | Get a notebook |
|
10
|
+
| [**list_notebooks**](NotebooksAPI.md#list_notebooks) | **GET** /api/v1/notebooks | Get all notebooks |
|
11
|
+
| [**update_notebook**](NotebooksAPI.md#update_notebook) | **PUT** /api/v1/notebooks/{notebook_id} | Update a notebook |
|
12
|
+
|
13
|
+
|
14
|
+
## create_notebook
|
15
|
+
|
16
|
+
> <NotebookResponse> create_notebook(body)
|
17
|
+
|
18
|
+
Create a notebook
|
19
|
+
|
20
|
+
Create a notebook using the specified options.
|
21
|
+
|
22
|
+
### Examples
|
23
|
+
|
24
|
+
```ruby
|
25
|
+
require 'datadog_api_client'
|
26
|
+
api_instance = DatadogAPIClient::V1::NotebooksAPI.new
|
27
|
+
body = DatadogAPIClient::V1::NotebookCreateRequest.new({data: DatadogAPIClient::V1::NotebookCreateData.new({attributes: DatadogAPIClient::V1::NotebookCreateDataAttributes.new({cells: [DatadogAPIClient::V1::NotebookCellCreateRequest.new({attributes: DatadogAPIClient::V1::NotebookDistributionCellAttributes.new({definition: DatadogAPIClient::V1::DistributionWidgetDefinition.new({requests: [DatadogAPIClient::V1::DistributionWidgetRequest.new], type: DatadogAPIClient::V1::DistributionWidgetDefinitionType::DISTRIBUTION})}), type: DatadogAPIClient::V1::NotebookCellResourceType::NOTEBOOK_CELLS})], name: 'Example Notebook', time: DatadogAPIClient::V1::NotebookAbsoluteTime.new({_end: Time.parse('2021-02-24T20:18:28Z'), start: Time.parse('2021-02-24T19:18:28Z')})}), type: DatadogAPIClient::V1::NotebookResourceType::NOTEBOOKS})}) # NotebookCreateRequest | The JSON description of the notebook you want to create.
|
28
|
+
|
29
|
+
begin
|
30
|
+
# Create a notebook
|
31
|
+
result = api_instance.create_notebook(body)
|
32
|
+
p result
|
33
|
+
rescue DatadogAPIClient::V1::APIError => e
|
34
|
+
puts "Error when calling NotebooksAPI->create_notebook: #{e}"
|
35
|
+
end
|
36
|
+
```
|
37
|
+
|
38
|
+
#### Using the create_notebook_with_http_info variant
|
39
|
+
|
40
|
+
This returns an Array which contains the response data, status code and headers.
|
41
|
+
|
42
|
+
> <Array(<NotebookResponse>, Integer, Hash)> create_notebook_with_http_info(body)
|
43
|
+
|
44
|
+
```ruby
|
45
|
+
begin
|
46
|
+
# Create a notebook
|
47
|
+
data, status_code, headers = api_instance.create_notebook_with_http_info(body)
|
48
|
+
p status_code # => 2xx
|
49
|
+
p headers # => { ... }
|
50
|
+
p data # => <NotebookResponse>
|
51
|
+
rescue DatadogAPIClient::V1::APIError => e
|
52
|
+
puts "Error when calling NotebooksAPI->create_notebook_with_http_info: #{e}"
|
53
|
+
end
|
54
|
+
```
|
55
|
+
|
56
|
+
### Parameters
|
57
|
+
|
58
|
+
| Name | Type | Description | Notes |
|
59
|
+
| ---- | ---- | ----------- | ----- |
|
60
|
+
| **body** | [**NotebookCreateRequest**](NotebookCreateRequest.md) | The JSON description of the notebook you want to create. | |
|
61
|
+
|
62
|
+
### Return type
|
63
|
+
|
64
|
+
[**NotebookResponse**](NotebookResponse.md)
|
65
|
+
|
66
|
+
### Authorization
|
67
|
+
|
68
|
+
[apiKeyAuth](README.md#apiKeyAuth), [appKeyAuth](README.md#appKeyAuth)
|
69
|
+
|
70
|
+
### HTTP request headers
|
71
|
+
|
72
|
+
- **Content-Type**: application/json
|
73
|
+
- **Accept**: application/json
|
74
|
+
|
75
|
+
|
76
|
+
## delete_notebook
|
77
|
+
|
78
|
+
> delete_notebook(notebook_id)
|
79
|
+
|
80
|
+
Delete a notebook
|
81
|
+
|
82
|
+
Delete a notebook using the specified ID.
|
83
|
+
|
84
|
+
### Examples
|
85
|
+
|
86
|
+
```ruby
|
87
|
+
require 'datadog_api_client'
|
88
|
+
api_instance = DatadogAPIClient::V1::NotebooksAPI.new
|
89
|
+
notebook_id = 789 # Integer | Unique ID, assigned when you create the notebook.
|
90
|
+
|
91
|
+
begin
|
92
|
+
# Delete a notebook
|
93
|
+
api_instance.delete_notebook(notebook_id)
|
94
|
+
rescue DatadogAPIClient::V1::APIError => e
|
95
|
+
puts "Error when calling NotebooksAPI->delete_notebook: #{e}"
|
96
|
+
end
|
97
|
+
```
|
98
|
+
|
99
|
+
#### Using the delete_notebook_with_http_info variant
|
100
|
+
|
101
|
+
This returns an Array which contains the response data (`nil` in this case), status code and headers.
|
102
|
+
|
103
|
+
> <Array(nil, Integer, Hash)> delete_notebook_with_http_info(notebook_id)
|
104
|
+
|
105
|
+
```ruby
|
106
|
+
begin
|
107
|
+
# Delete a notebook
|
108
|
+
data, status_code, headers = api_instance.delete_notebook_with_http_info(notebook_id)
|
109
|
+
p status_code # => 2xx
|
110
|
+
p headers # => { ... }
|
111
|
+
p data # => nil
|
112
|
+
rescue DatadogAPIClient::V1::APIError => e
|
113
|
+
puts "Error when calling NotebooksAPI->delete_notebook_with_http_info: #{e}"
|
114
|
+
end
|
115
|
+
```
|
116
|
+
|
117
|
+
### Parameters
|
118
|
+
|
119
|
+
| Name | Type | Description | Notes |
|
120
|
+
| ---- | ---- | ----------- | ----- |
|
121
|
+
| **notebook_id** | **Integer** | Unique ID, assigned when you create the notebook. | |
|
122
|
+
|
123
|
+
### Return type
|
124
|
+
|
125
|
+
nil (empty response body)
|
126
|
+
|
127
|
+
### Authorization
|
128
|
+
|
129
|
+
[apiKeyAuth](README.md#apiKeyAuth), [appKeyAuth](README.md#appKeyAuth)
|
130
|
+
|
131
|
+
### HTTP request headers
|
132
|
+
|
133
|
+
- **Content-Type**: Not defined
|
134
|
+
- **Accept**: application/json
|
135
|
+
|
136
|
+
|
137
|
+
## get_notebook
|
138
|
+
|
139
|
+
> <NotebookResponse> get_notebook(notebook_id)
|
140
|
+
|
141
|
+
Get a notebook
|
142
|
+
|
143
|
+
Get a notebook using the specified notebook ID.
|
144
|
+
|
145
|
+
### Examples
|
146
|
+
|
147
|
+
```ruby
|
148
|
+
require 'datadog_api_client'
|
149
|
+
api_instance = DatadogAPIClient::V1::NotebooksAPI.new
|
150
|
+
notebook_id = 789 # Integer | Unique ID, assigned when you create the notebook.
|
151
|
+
|
152
|
+
begin
|
153
|
+
# Get a notebook
|
154
|
+
result = api_instance.get_notebook(notebook_id)
|
155
|
+
p result
|
156
|
+
rescue DatadogAPIClient::V1::APIError => e
|
157
|
+
puts "Error when calling NotebooksAPI->get_notebook: #{e}"
|
158
|
+
end
|
159
|
+
```
|
160
|
+
|
161
|
+
#### Using the get_notebook_with_http_info variant
|
162
|
+
|
163
|
+
This returns an Array which contains the response data, status code and headers.
|
164
|
+
|
165
|
+
> <Array(<NotebookResponse>, Integer, Hash)> get_notebook_with_http_info(notebook_id)
|
166
|
+
|
167
|
+
```ruby
|
168
|
+
begin
|
169
|
+
# Get a notebook
|
170
|
+
data, status_code, headers = api_instance.get_notebook_with_http_info(notebook_id)
|
171
|
+
p status_code # => 2xx
|
172
|
+
p headers # => { ... }
|
173
|
+
p data # => <NotebookResponse>
|
174
|
+
rescue DatadogAPIClient::V1::APIError => e
|
175
|
+
puts "Error when calling NotebooksAPI->get_notebook_with_http_info: #{e}"
|
176
|
+
end
|
177
|
+
```
|
178
|
+
|
179
|
+
### Parameters
|
180
|
+
|
181
|
+
| Name | Type | Description | Notes |
|
182
|
+
| ---- | ---- | ----------- | ----- |
|
183
|
+
| **notebook_id** | **Integer** | Unique ID, assigned when you create the notebook. | |
|
184
|
+
|
185
|
+
### Return type
|
186
|
+
|
187
|
+
[**NotebookResponse**](NotebookResponse.md)
|
188
|
+
|
189
|
+
### Authorization
|
190
|
+
|
191
|
+
[apiKeyAuth](README.md#apiKeyAuth), [appKeyAuth](README.md#appKeyAuth)
|
192
|
+
|
193
|
+
### HTTP request headers
|
194
|
+
|
195
|
+
- **Content-Type**: Not defined
|
196
|
+
- **Accept**: application/json
|
197
|
+
|
198
|
+
|
199
|
+
## list_notebooks
|
200
|
+
|
201
|
+
> <NotebooksResponse> list_notebooks(opts)
|
202
|
+
|
203
|
+
Get all notebooks
|
204
|
+
|
205
|
+
Get all notebooks. This can also be used to search for notebooks with a particular `query` in the notebook `name` or author `handle`.
|
206
|
+
|
207
|
+
### Examples
|
208
|
+
|
209
|
+
```ruby
|
210
|
+
require 'datadog_api_client'
|
211
|
+
api_instance = DatadogAPIClient::V1::NotebooksAPI.new
|
212
|
+
opts = {
|
213
|
+
author_handle: 'test@datadoghq.com', # String | Return notebooks created by the given `author_handle`.
|
214
|
+
exclude_author_handle: 'test@datadoghq.com', # String | Return notebooks not created by the given `author_handle`.
|
215
|
+
start: 0, # Integer | The index of the first notebook you want returned.
|
216
|
+
count: 5, # Integer | The number of notebooks to be returned.
|
217
|
+
sort_field: 'modified', # String | Sort by field `modified` or `name`.
|
218
|
+
sort_dir: 'desc', # String | Sort by direction `asc` or `desc`.
|
219
|
+
query: 'postmortem', # String | Return only notebooks with `query` string in notebook name or author handle.
|
220
|
+
include_cells: false # Boolean | Value of `false` excludes the `cells` and global `time` for each notebook.
|
221
|
+
}
|
222
|
+
|
223
|
+
begin
|
224
|
+
# Get all notebooks
|
225
|
+
result = api_instance.list_notebooks(opts)
|
226
|
+
p result
|
227
|
+
rescue DatadogAPIClient::V1::APIError => e
|
228
|
+
puts "Error when calling NotebooksAPI->list_notebooks: #{e}"
|
229
|
+
end
|
230
|
+
```
|
231
|
+
|
232
|
+
#### Using the list_notebooks_with_http_info variant
|
233
|
+
|
234
|
+
This returns an Array which contains the response data, status code and headers.
|
235
|
+
|
236
|
+
> <Array(<NotebooksResponse>, Integer, Hash)> list_notebooks_with_http_info(opts)
|
237
|
+
|
238
|
+
```ruby
|
239
|
+
begin
|
240
|
+
# Get all notebooks
|
241
|
+
data, status_code, headers = api_instance.list_notebooks_with_http_info(opts)
|
242
|
+
p status_code # => 2xx
|
243
|
+
p headers # => { ... }
|
244
|
+
p data # => <NotebooksResponse>
|
245
|
+
rescue DatadogAPIClient::V1::APIError => e
|
246
|
+
puts "Error when calling NotebooksAPI->list_notebooks_with_http_info: #{e}"
|
247
|
+
end
|
248
|
+
```
|
249
|
+
|
250
|
+
### Parameters
|
251
|
+
|
252
|
+
| Name | Type | Description | Notes |
|
253
|
+
| ---- | ---- | ----------- | ----- |
|
254
|
+
| **author_handle** | **String** | Return notebooks created by the given `author_handle`. | [optional] |
|
255
|
+
| **exclude_author_handle** | **String** | Return notebooks not created by the given `author_handle`. | [optional] |
|
256
|
+
| **start** | **Integer** | The index of the first notebook you want returned. | [optional] |
|
257
|
+
| **count** | **Integer** | The number of notebooks to be returned. | [optional] |
|
258
|
+
| **sort_field** | **String** | Sort by field `modified` or `name`. | [optional][default to 'modified'] |
|
259
|
+
| **sort_dir** | **String** | Sort by direction `asc` or `desc`. | [optional][default to 'desc'] |
|
260
|
+
| **query** | **String** | Return only notebooks with `query` string in notebook name or author handle. | [optional] |
|
261
|
+
| **include_cells** | **Boolean** | Value of `false` excludes the `cells` and global `time` for each notebook. | [optional][default to true] |
|
262
|
+
|
263
|
+
### Return type
|
264
|
+
|
265
|
+
[**NotebooksResponse**](NotebooksResponse.md)
|
266
|
+
|
267
|
+
### Authorization
|
268
|
+
|
269
|
+
[apiKeyAuth](README.md#apiKeyAuth), [appKeyAuth](README.md#appKeyAuth)
|
270
|
+
|
271
|
+
### HTTP request headers
|
272
|
+
|
273
|
+
- **Content-Type**: Not defined
|
274
|
+
- **Accept**: application/json
|
275
|
+
|
276
|
+
|
277
|
+
## update_notebook
|
278
|
+
|
279
|
+
> <NotebookResponse> update_notebook(notebook_id, body)
|
280
|
+
|
281
|
+
Update a notebook
|
282
|
+
|
283
|
+
Update a notebook using the specified ID.
|
284
|
+
|
285
|
+
### Examples
|
286
|
+
|
287
|
+
```ruby
|
288
|
+
require 'datadog_api_client'
|
289
|
+
api_instance = DatadogAPIClient::V1::NotebooksAPI.new
|
290
|
+
notebook_id = 789 # Integer | Unique ID, assigned when you create the notebook.
|
291
|
+
body = DatadogAPIClient::V1::NotebookUpdateRequest.new({data: DatadogAPIClient::V1::NotebookUpdateData.new({attributes: DatadogAPIClient::V1::NotebookUpdateDataAttributes.new({cells: [DatadogAPIClient::V1::NotebookCellCreateRequest.new({attributes: DatadogAPIClient::V1::NotebookDistributionCellAttributes.new({definition: DatadogAPIClient::V1::DistributionWidgetDefinition.new({requests: [DatadogAPIClient::V1::DistributionWidgetRequest.new], type: DatadogAPIClient::V1::DistributionWidgetDefinitionType::DISTRIBUTION})}), type: DatadogAPIClient::V1::NotebookCellResourceType::NOTEBOOK_CELLS})], name: 'Example Notebook', time: DatadogAPIClient::V1::NotebookAbsoluteTime.new({_end: Time.parse('2021-02-24T20:18:28Z'), start: Time.parse('2021-02-24T19:18:28Z')})}), type: DatadogAPIClient::V1::NotebookResourceType::NOTEBOOKS})}) # NotebookUpdateRequest | Update notebook request body.
|
292
|
+
|
293
|
+
begin
|
294
|
+
# Update a notebook
|
295
|
+
result = api_instance.update_notebook(notebook_id, body)
|
296
|
+
p result
|
297
|
+
rescue DatadogAPIClient::V1::APIError => e
|
298
|
+
puts "Error when calling NotebooksAPI->update_notebook: #{e}"
|
299
|
+
end
|
300
|
+
```
|
301
|
+
|
302
|
+
#### Using the update_notebook_with_http_info variant
|
303
|
+
|
304
|
+
This returns an Array which contains the response data, status code and headers.
|
305
|
+
|
306
|
+
> <Array(<NotebookResponse>, Integer, Hash)> update_notebook_with_http_info(notebook_id, body)
|
307
|
+
|
308
|
+
```ruby
|
309
|
+
begin
|
310
|
+
# Update a notebook
|
311
|
+
data, status_code, headers = api_instance.update_notebook_with_http_info(notebook_id, body)
|
312
|
+
p status_code # => 2xx
|
313
|
+
p headers # => { ... }
|
314
|
+
p data # => <NotebookResponse>
|
315
|
+
rescue DatadogAPIClient::V1::APIError => e
|
316
|
+
puts "Error when calling NotebooksAPI->update_notebook_with_http_info: #{e}"
|
317
|
+
end
|
318
|
+
```
|
319
|
+
|
320
|
+
### Parameters
|
321
|
+
|
322
|
+
| Name | Type | Description | Notes |
|
323
|
+
| ---- | ---- | ----------- | ----- |
|
324
|
+
| **notebook_id** | **Integer** | Unique ID, assigned when you create the notebook. | |
|
325
|
+
| **body** | [**NotebookUpdateRequest**](NotebookUpdateRequest.md) | Update notebook request body. | |
|
326
|
+
|
327
|
+
### Return type
|
328
|
+
|
329
|
+
[**NotebookResponse**](NotebookResponse.md)
|
330
|
+
|
331
|
+
### Authorization
|
332
|
+
|
333
|
+
[apiKeyAuth](README.md#apiKeyAuth), [appKeyAuth](README.md#appKeyAuth)
|
334
|
+
|
335
|
+
### HTTP request headers
|
336
|
+
|
337
|
+
- **Content-Type**: application/json
|
338
|
+
- **Accept**: application/json
|
339
|
+
|
@@ -0,0 +1,20 @@
|
|
1
|
+
# DatadogAPIClient::V1::NotebooksResponse
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **data** | [**Array<NotebookResponseData>**](NotebookResponseData.md) | List of notebook definitions. | [optional] |
|
8
|
+
| **meta** | [**NotebooksResponseMeta**](NotebooksResponseMeta.md) | | [optional] |
|
9
|
+
|
10
|
+
## Example
|
11
|
+
|
12
|
+
```ruby
|
13
|
+
require 'datadog_api_client/v1'
|
14
|
+
|
15
|
+
instance = DatadogAPIClient::V1::NotebooksResponse.new(
|
16
|
+
data: null,
|
17
|
+
meta: null
|
18
|
+
)
|
19
|
+
```
|
20
|
+
|
@@ -0,0 +1,18 @@
|
|
1
|
+
# DatadogAPIClient::V1::NotebooksResponseMeta
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **page** | [**NotebooksResponsePage**](NotebooksResponsePage.md) | | [optional] |
|
8
|
+
|
9
|
+
## Example
|
10
|
+
|
11
|
+
```ruby
|
12
|
+
require 'datadog_api_client/v1'
|
13
|
+
|
14
|
+
instance = DatadogAPIClient::V1::NotebooksResponseMeta.new(
|
15
|
+
page: null
|
16
|
+
)
|
17
|
+
```
|
18
|
+
|
@@ -0,0 +1,20 @@
|
|
1
|
+
# DatadogAPIClient::V1::NotebooksResponsePage
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **total_count** | **Integer** | The total number of notebooks that would be returned if the request was not filtered by `start` and `count` parameters. | [optional] |
|
8
|
+
| **total_filtered_count** | **Integer** | The total number of notebooks returned. | [optional] |
|
9
|
+
|
10
|
+
## Example
|
11
|
+
|
12
|
+
```ruby
|
13
|
+
require 'datadog_api_client/v1'
|
14
|
+
|
15
|
+
instance = DatadogAPIClient::V1::NotebooksResponsePage.new(
|
16
|
+
total_count: null,
|
17
|
+
total_filtered_count: null
|
18
|
+
)
|
19
|
+
```
|
20
|
+
|
data/docs/v1/README.md
CHANGED
@@ -120,6 +120,11 @@ Class | Method | HTTP request | Description
|
|
120
120
|
*DatadogAPIClient::V1::MonitorsAPI* | [**list_monitors**](MonitorsAPI.md#list_monitors) | **GET** /api/v1/monitor | Get all monitor details
|
121
121
|
*DatadogAPIClient::V1::MonitorsAPI* | [**update_monitor**](MonitorsAPI.md#update_monitor) | **PUT** /api/v1/monitor/{monitor_id} | Edit a monitor
|
122
122
|
*DatadogAPIClient::V1::MonitorsAPI* | [**validate_monitor**](MonitorsAPI.md#validate_monitor) | **POST** /api/v1/monitor/validate | Validate a monitor
|
123
|
+
*DatadogAPIClient::V1::NotebooksAPI* | [**create_notebook**](NotebooksAPI.md#create_notebook) | **POST** /api/v1/notebooks | Create a notebook
|
124
|
+
*DatadogAPIClient::V1::NotebooksAPI* | [**delete_notebook**](NotebooksAPI.md#delete_notebook) | **DELETE** /api/v1/notebooks/{notebook_id} | Delete a notebook
|
125
|
+
*DatadogAPIClient::V1::NotebooksAPI* | [**get_notebook**](NotebooksAPI.md#get_notebook) | **GET** /api/v1/notebooks/{notebook_id} | Get a notebook
|
126
|
+
*DatadogAPIClient::V1::NotebooksAPI* | [**list_notebooks**](NotebooksAPI.md#list_notebooks) | **GET** /api/v1/notebooks | Get all notebooks
|
127
|
+
*DatadogAPIClient::V1::NotebooksAPI* | [**update_notebook**](NotebooksAPI.md#update_notebook) | **PUT** /api/v1/notebooks/{notebook_id} | Update a notebook
|
123
128
|
*DatadogAPIClient::V1::OrganizationsAPI* | [**create_child_org**](OrganizationsAPI.md#create_child_org) | **POST** /api/v1/org | Create a child organization
|
124
129
|
*DatadogAPIClient::V1::OrganizationsAPI* | [**get_org**](OrganizationsAPI.md#get_org) | **GET** /api/v1/org/{public_id} | Get organization information
|
125
130
|
*DatadogAPIClient::V1::OrganizationsAPI* | [**list_orgs**](OrganizationsAPI.md#list_orgs) | **GET** /api/v1/org | List your managed organizations
|
@@ -153,27 +158,25 @@ Class | Method | HTTP request | Description
|
|
153
158
|
*DatadogAPIClient::V1::SyntheticsAPI* | [**create_private_location**](SyntheticsAPI.md#create_private_location) | **POST** /api/v1/synthetics/private-locations | Create a private location
|
154
159
|
*DatadogAPIClient::V1::SyntheticsAPI* | [**create_synthetics_api_test**](SyntheticsAPI.md#create_synthetics_api_test) | **POST** /api/v1/synthetics/tests/api | Create an API test
|
155
160
|
*DatadogAPIClient::V1::SyntheticsAPI* | [**create_synthetics_browser_test**](SyntheticsAPI.md#create_synthetics_browser_test) | **POST** /api/v1/synthetics/tests/browser | Create a browser test
|
156
|
-
*DatadogAPIClient::V1::SyntheticsAPI* | [**create_test**](SyntheticsAPI.md#create_test) | **POST** /api/v1/synthetics/tests | Create a test
|
157
161
|
*DatadogAPIClient::V1::SyntheticsAPI* | [**delete_global_variable**](SyntheticsAPI.md#delete_global_variable) | **DELETE** /api/v1/synthetics/variables/{variable_id} | Delete a global variable
|
158
162
|
*DatadogAPIClient::V1::SyntheticsAPI* | [**delete_private_location**](SyntheticsAPI.md#delete_private_location) | **DELETE** /api/v1/synthetics/private-locations/{location_id} | Delete a private location
|
159
163
|
*DatadogAPIClient::V1::SyntheticsAPI* | [**delete_tests**](SyntheticsAPI.md#delete_tests) | **POST** /api/v1/synthetics/tests/delete | Delete tests
|
160
164
|
*DatadogAPIClient::V1::SyntheticsAPI* | [**edit_global_variable**](SyntheticsAPI.md#edit_global_variable) | **PUT** /api/v1/synthetics/variables/{variable_id} | Edit a global variable
|
161
165
|
*DatadogAPIClient::V1::SyntheticsAPI* | [**get_api_test**](SyntheticsAPI.md#get_api_test) | **GET** /api/v1/synthetics/tests/api/{public_id} | Get an API test
|
162
|
-
*DatadogAPIClient::V1::SyntheticsAPI* | [**get_api_test_latest_results**](SyntheticsAPI.md#get_api_test_latest_results) | **GET** /api/v1/synthetics/tests/{public_id}/results | Get
|
163
|
-
*DatadogAPIClient::V1::SyntheticsAPI* | [**get_api_test_result**](SyntheticsAPI.md#get_api_test_result) | **GET** /api/v1/synthetics/tests/{public_id}/results/{result_id} | Get
|
164
|
-
*DatadogAPIClient::V1::SyntheticsAPI* | [**get_browser_test**](SyntheticsAPI.md#get_browser_test) | **GET** /api/v1/synthetics/tests/browser/{public_id} | Get a test
|
165
|
-
*DatadogAPIClient::V1::SyntheticsAPI* | [**get_browser_test_latest_results**](SyntheticsAPI.md#get_browser_test_latest_results) | **GET** /api/v1/synthetics/tests/browser/{public_id}/results | Get
|
166
|
-
*DatadogAPIClient::V1::SyntheticsAPI* | [**get_browser_test_result**](SyntheticsAPI.md#get_browser_test_result) | **GET** /api/v1/synthetics/tests/browser/{public_id}/results/{result_id} | Get a test result
|
166
|
+
*DatadogAPIClient::V1::SyntheticsAPI* | [**get_api_test_latest_results**](SyntheticsAPI.md#get_api_test_latest_results) | **GET** /api/v1/synthetics/tests/{public_id}/results | Get an API test's latest results summaries
|
167
|
+
*DatadogAPIClient::V1::SyntheticsAPI* | [**get_api_test_result**](SyntheticsAPI.md#get_api_test_result) | **GET** /api/v1/synthetics/tests/{public_id}/results/{result_id} | Get an API test result
|
168
|
+
*DatadogAPIClient::V1::SyntheticsAPI* | [**get_browser_test**](SyntheticsAPI.md#get_browser_test) | **GET** /api/v1/synthetics/tests/browser/{public_id} | Get a browser test
|
169
|
+
*DatadogAPIClient::V1::SyntheticsAPI* | [**get_browser_test_latest_results**](SyntheticsAPI.md#get_browser_test_latest_results) | **GET** /api/v1/synthetics/tests/browser/{public_id}/results | Get a browser test's latest results summaries
|
170
|
+
*DatadogAPIClient::V1::SyntheticsAPI* | [**get_browser_test_result**](SyntheticsAPI.md#get_browser_test_result) | **GET** /api/v1/synthetics/tests/browser/{public_id}/results/{result_id} | Get a browser test result
|
167
171
|
*DatadogAPIClient::V1::SyntheticsAPI* | [**get_global_variable**](SyntheticsAPI.md#get_global_variable) | **GET** /api/v1/synthetics/variables/{variable_id} | Get a global variable
|
168
172
|
*DatadogAPIClient::V1::SyntheticsAPI* | [**get_private_location**](SyntheticsAPI.md#get_private_location) | **GET** /api/v1/synthetics/private-locations/{location_id} | Get a private location
|
169
|
-
*DatadogAPIClient::V1::SyntheticsAPI* | [**get_test**](SyntheticsAPI.md#get_test) | **GET** /api/v1/synthetics/tests/{public_id} | Get a test configuration
|
173
|
+
*DatadogAPIClient::V1::SyntheticsAPI* | [**get_test**](SyntheticsAPI.md#get_test) | **GET** /api/v1/synthetics/tests/{public_id} | Get a test configuration
|
170
174
|
*DatadogAPIClient::V1::SyntheticsAPI* | [**list_locations**](SyntheticsAPI.md#list_locations) | **GET** /api/v1/synthetics/locations | Get all locations (public and private)
|
171
175
|
*DatadogAPIClient::V1::SyntheticsAPI* | [**list_tests**](SyntheticsAPI.md#list_tests) | **GET** /api/v1/synthetics/tests | Get the list of all tests
|
172
|
-
*DatadogAPIClient::V1::SyntheticsAPI* | [**trigger_ci_tests**](SyntheticsAPI.md#trigger_ci_tests) | **POST** /api/v1/synthetics/tests/trigger/ci | Trigger
|
176
|
+
*DatadogAPIClient::V1::SyntheticsAPI* | [**trigger_ci_tests**](SyntheticsAPI.md#trigger_ci_tests) | **POST** /api/v1/synthetics/tests/trigger/ci | Trigger tests from CI/CD pipelines
|
173
177
|
*DatadogAPIClient::V1::SyntheticsAPI* | [**update_api_test**](SyntheticsAPI.md#update_api_test) | **PUT** /api/v1/synthetics/tests/api/{public_id} | Edit an API test
|
174
178
|
*DatadogAPIClient::V1::SyntheticsAPI* | [**update_browser_test**](SyntheticsAPI.md#update_browser_test) | **PUT** /api/v1/synthetics/tests/browser/{public_id} | Edit a browser test
|
175
179
|
*DatadogAPIClient::V1::SyntheticsAPI* | [**update_private_location**](SyntheticsAPI.md#update_private_location) | **PUT** /api/v1/synthetics/private-locations/{location_id} | Edit a private location
|
176
|
-
*DatadogAPIClient::V1::SyntheticsAPI* | [**update_test**](SyntheticsAPI.md#update_test) | **PUT** /api/v1/synthetics/tests/{public_id} | Edit a test
|
177
180
|
*DatadogAPIClient::V1::SyntheticsAPI* | [**update_test_pause_status**](SyntheticsAPI.md#update_test_pause_status) | **PUT** /api/v1/synthetics/tests/{public_id}/status | Pause or start a test
|
178
181
|
*DatadogAPIClient::V1::TagsAPI* | [**create_host_tags**](TagsAPI.md#create_host_tags) | **POST** /api/v1/tags/hosts/{host_name} | Add tags to a host
|
179
182
|
*DatadogAPIClient::V1::TagsAPI* | [**delete_host_tags**](TagsAPI.md#delete_host_tags) | **DELETE** /api/v1/tags/hosts/{host_name} | Remove host tags
|
@@ -198,6 +201,7 @@ Class | Method | HTTP request | Description
|
|
198
201
|
*DatadogAPIClient::V1::UsageMeteringAPI* | [**get_usage_lambda**](UsageMeteringAPI.md#get_usage_lambda) | **GET** /api/v1/usage/aws_lambda | Get hourly usage for Lambda
|
199
202
|
*DatadogAPIClient::V1::UsageMeteringAPI* | [**get_usage_logs**](UsageMeteringAPI.md#get_usage_logs) | **GET** /api/v1/usage/logs | Get hourly usage for Logs
|
200
203
|
*DatadogAPIClient::V1::UsageMeteringAPI* | [**get_usage_logs_by_index**](UsageMeteringAPI.md#get_usage_logs_by_index) | **GET** /api/v1/usage/logs_by_index | Get hourly usage for Logs by Index
|
204
|
+
*DatadogAPIClient::V1::UsageMeteringAPI* | [**get_usage_logs_by_retention**](UsageMeteringAPI.md#get_usage_logs_by_retention) | **GET** /api/v1/usage/logs-by-retention | Get hourly logs usage by retention
|
201
205
|
*DatadogAPIClient::V1::UsageMeteringAPI* | [**get_usage_network_flows**](UsageMeteringAPI.md#get_usage_network_flows) | **GET** /api/v1/usage/network_flows | Get hourly usage for Network Flows
|
202
206
|
*DatadogAPIClient::V1::UsageMeteringAPI* | [**get_usage_network_hosts**](UsageMeteringAPI.md#get_usage_network_hosts) | **GET** /api/v1/usage/network_hosts | Get hourly usage for Network Hosts
|
203
207
|
*DatadogAPIClient::V1::UsageMeteringAPI* | [**get_usage_profiling**](UsageMeteringAPI.md#get_usage_profiling) | **GET** /api/v1/usage/profiling | Get hourly usage for profiled hosts
|
@@ -280,6 +284,8 @@ Class | Method | HTTP request | Description
|
|
280
284
|
- [DatadogAPIClient::V1::DistributionWidgetDefinition](DistributionWidgetDefinition.md)
|
281
285
|
- [DatadogAPIClient::V1::DistributionWidgetDefinitionType](DistributionWidgetDefinitionType.md)
|
282
286
|
- [DatadogAPIClient::V1::DistributionWidgetRequest](DistributionWidgetRequest.md)
|
287
|
+
- [DatadogAPIClient::V1::DistributionWidgetXAxis](DistributionWidgetXAxis.md)
|
288
|
+
- [DatadogAPIClient::V1::DistributionWidgetYAxis](DistributionWidgetYAxis.md)
|
283
289
|
- [DatadogAPIClient::V1::Downtime](Downtime.md)
|
284
290
|
- [DatadogAPIClient::V1::DowntimeRecurrence](DowntimeRecurrence.md)
|
285
291
|
- [DatadogAPIClient::V1::Event](Event.md)
|
@@ -367,6 +373,10 @@ Class | Method | HTTP request | Description
|
|
367
373
|
- [DatadogAPIClient::V1::LogsArithmeticProcessorType](LogsArithmeticProcessorType.md)
|
368
374
|
- [DatadogAPIClient::V1::LogsAttributeRemapper](LogsAttributeRemapper.md)
|
369
375
|
- [DatadogAPIClient::V1::LogsAttributeRemapperType](LogsAttributeRemapperType.md)
|
376
|
+
- [DatadogAPIClient::V1::LogsByRetention](LogsByRetention.md)
|
377
|
+
- [DatadogAPIClient::V1::LogsByRetentionMonthlyUsage](LogsByRetentionMonthlyUsage.md)
|
378
|
+
- [DatadogAPIClient::V1::LogsByRetentionOrgUsage](LogsByRetentionOrgUsage.md)
|
379
|
+
- [DatadogAPIClient::V1::LogsByRetentionOrgs](LogsByRetentionOrgs.md)
|
370
380
|
- [DatadogAPIClient::V1::LogsCategoryProcessor](LogsCategoryProcessor.md)
|
371
381
|
- [DatadogAPIClient::V1::LogsCategoryProcessorCategory](LogsCategoryProcessorCategory.md)
|
372
382
|
- [DatadogAPIClient::V1::LogsCategoryProcessorType](LogsCategoryProcessorType.md)
|
@@ -397,6 +407,8 @@ Class | Method | HTTP request | Description
|
|
397
407
|
- [DatadogAPIClient::V1::LogsPipelinesOrder](LogsPipelinesOrder.md)
|
398
408
|
- [DatadogAPIClient::V1::LogsProcessor](LogsProcessor.md)
|
399
409
|
- [DatadogAPIClient::V1::LogsQueryCompute](LogsQueryCompute.md)
|
410
|
+
- [DatadogAPIClient::V1::LogsRetentionAggSumUsage](LogsRetentionAggSumUsage.md)
|
411
|
+
- [DatadogAPIClient::V1::LogsRetentionSumUsage](LogsRetentionSumUsage.md)
|
400
412
|
- [DatadogAPIClient::V1::LogsServiceRemapper](LogsServiceRemapper.md)
|
401
413
|
- [DatadogAPIClient::V1::LogsServiceRemapperType](LogsServiceRemapperType.md)
|
402
414
|
- [DatadogAPIClient::V1::LogsSort](LogsSort.md)
|
@@ -433,6 +445,43 @@ Class | Method | HTTP request | Description
|
|
433
445
|
- [DatadogAPIClient::V1::MonitorUpdateRequest](MonitorUpdateRequest.md)
|
434
446
|
- [DatadogAPIClient::V1::NoteWidgetDefinition](NoteWidgetDefinition.md)
|
435
447
|
- [DatadogAPIClient::V1::NoteWidgetDefinitionType](NoteWidgetDefinitionType.md)
|
448
|
+
- [DatadogAPIClient::V1::NotebookAbsoluteTime](NotebookAbsoluteTime.md)
|
449
|
+
- [DatadogAPIClient::V1::NotebookAuthor](NotebookAuthor.md)
|
450
|
+
- [DatadogAPIClient::V1::NotebookCellCreateRequest](NotebookCellCreateRequest.md)
|
451
|
+
- [DatadogAPIClient::V1::NotebookCellCreateRequestAttributes](NotebookCellCreateRequestAttributes.md)
|
452
|
+
- [DatadogAPIClient::V1::NotebookCellResourceType](NotebookCellResourceType.md)
|
453
|
+
- [DatadogAPIClient::V1::NotebookCellResponse](NotebookCellResponse.md)
|
454
|
+
- [DatadogAPIClient::V1::NotebookCellResponseAttributes](NotebookCellResponseAttributes.md)
|
455
|
+
- [DatadogAPIClient::V1::NotebookCellTime](NotebookCellTime.md)
|
456
|
+
- [DatadogAPIClient::V1::NotebookCellUpdateRequest](NotebookCellUpdateRequest.md)
|
457
|
+
- [DatadogAPIClient::V1::NotebookCellUpdateRequestAttributes](NotebookCellUpdateRequestAttributes.md)
|
458
|
+
- [DatadogAPIClient::V1::NotebookCreateData](NotebookCreateData.md)
|
459
|
+
- [DatadogAPIClient::V1::NotebookCreateDataAttributes](NotebookCreateDataAttributes.md)
|
460
|
+
- [DatadogAPIClient::V1::NotebookCreateRequest](NotebookCreateRequest.md)
|
461
|
+
- [DatadogAPIClient::V1::NotebookDistributionCellAttributes](NotebookDistributionCellAttributes.md)
|
462
|
+
- [DatadogAPIClient::V1::NotebookGlobalTime](NotebookGlobalTime.md)
|
463
|
+
- [DatadogAPIClient::V1::NotebookGraphSize](NotebookGraphSize.md)
|
464
|
+
- [DatadogAPIClient::V1::NotebookHeatMapCellAttributes](NotebookHeatMapCellAttributes.md)
|
465
|
+
- [DatadogAPIClient::V1::NotebookLogStreamCellAttributes](NotebookLogStreamCellAttributes.md)
|
466
|
+
- [DatadogAPIClient::V1::NotebookMarkdownCellAttributes](NotebookMarkdownCellAttributes.md)
|
467
|
+
- [DatadogAPIClient::V1::NotebookMarkdownCellDefinition](NotebookMarkdownCellDefinition.md)
|
468
|
+
- [DatadogAPIClient::V1::NotebookMarkdownCellDefinitionType](NotebookMarkdownCellDefinitionType.md)
|
469
|
+
- [DatadogAPIClient::V1::NotebookRelativeTime](NotebookRelativeTime.md)
|
470
|
+
- [DatadogAPIClient::V1::NotebookResourceType](NotebookResourceType.md)
|
471
|
+
- [DatadogAPIClient::V1::NotebookResponse](NotebookResponse.md)
|
472
|
+
- [DatadogAPIClient::V1::NotebookResponseData](NotebookResponseData.md)
|
473
|
+
- [DatadogAPIClient::V1::NotebookResponseDataAttributes](NotebookResponseDataAttributes.md)
|
474
|
+
- [DatadogAPIClient::V1::NotebookSplitBy](NotebookSplitBy.md)
|
475
|
+
- [DatadogAPIClient::V1::NotebookStatus](NotebookStatus.md)
|
476
|
+
- [DatadogAPIClient::V1::NotebookTimeseriesCellAttributes](NotebookTimeseriesCellAttributes.md)
|
477
|
+
- [DatadogAPIClient::V1::NotebookToplistCellAttributes](NotebookToplistCellAttributes.md)
|
478
|
+
- [DatadogAPIClient::V1::NotebookUpdateCell](NotebookUpdateCell.md)
|
479
|
+
- [DatadogAPIClient::V1::NotebookUpdateData](NotebookUpdateData.md)
|
480
|
+
- [DatadogAPIClient::V1::NotebookUpdateDataAttributes](NotebookUpdateDataAttributes.md)
|
481
|
+
- [DatadogAPIClient::V1::NotebookUpdateRequest](NotebookUpdateRequest.md)
|
482
|
+
- [DatadogAPIClient::V1::NotebooksResponse](NotebooksResponse.md)
|
483
|
+
- [DatadogAPIClient::V1::NotebooksResponseMeta](NotebooksResponseMeta.md)
|
484
|
+
- [DatadogAPIClient::V1::NotebooksResponsePage](NotebooksResponsePage.md)
|
436
485
|
- [DatadogAPIClient::V1::Organization](Organization.md)
|
437
486
|
- [DatadogAPIClient::V1::OrganizationBilling](OrganizationBilling.md)
|
438
487
|
- [DatadogAPIClient::V1::OrganizationCreateBody](OrganizationCreateBody.md)
|
@@ -479,7 +528,10 @@ Class | Method | HTTP request | Description
|
|
479
528
|
- [DatadogAPIClient::V1::SLOHistoryResponseError](SLOHistoryResponseError.md)
|
480
529
|
- [DatadogAPIClient::V1::SLOHistorySLIData](SLOHistorySLIData.md)
|
481
530
|
- [DatadogAPIClient::V1::SLOListResponse](SLOListResponse.md)
|
531
|
+
- [DatadogAPIClient::V1::SLOListResponseMetadata](SLOListResponseMetadata.md)
|
532
|
+
- [DatadogAPIClient::V1::SLOListResponseMetadataPage](SLOListResponseMetadataPage.md)
|
482
533
|
- [DatadogAPIClient::V1::SLOResponse](SLOResponse.md)
|
534
|
+
- [DatadogAPIClient::V1::SLOResponseData](SLOResponseData.md)
|
483
535
|
- [DatadogAPIClient::V1::SLOThreshold](SLOThreshold.md)
|
484
536
|
- [DatadogAPIClient::V1::SLOTimeframe](SLOTimeframe.md)
|
485
537
|
- [DatadogAPIClient::V1::SLOType](SLOType.md)
|
@@ -617,6 +669,7 @@ Class | Method | HTTP request | Description
|
|
617
669
|
- [DatadogAPIClient::V1::UsageAttributionPagination](UsageAttributionPagination.md)
|
618
670
|
- [DatadogAPIClient::V1::UsageAttributionResponse](UsageAttributionResponse.md)
|
619
671
|
- [DatadogAPIClient::V1::UsageAttributionSort](UsageAttributionSort.md)
|
672
|
+
- [DatadogAPIClient::V1::UsageAttributionSupportedMetrics](UsageAttributionSupportedMetrics.md)
|
620
673
|
- [DatadogAPIClient::V1::UsageAttributionValues](UsageAttributionValues.md)
|
621
674
|
- [DatadogAPIClient::V1::UsageBillableSummaryBody](UsageBillableSummaryBody.md)
|
622
675
|
- [DatadogAPIClient::V1::UsageBillableSummaryHour](UsageBillableSummaryHour.md)
|
@@ -645,6 +698,8 @@ Class | Method | HTTP request | Description
|
|
645
698
|
- [DatadogAPIClient::V1::UsageLambdaResponse](UsageLambdaResponse.md)
|
646
699
|
- [DatadogAPIClient::V1::UsageLogsByIndexHour](UsageLogsByIndexHour.md)
|
647
700
|
- [DatadogAPIClient::V1::UsageLogsByIndexResponse](UsageLogsByIndexResponse.md)
|
701
|
+
- [DatadogAPIClient::V1::UsageLogsByRetentionHour](UsageLogsByRetentionHour.md)
|
702
|
+
- [DatadogAPIClient::V1::UsageLogsByRetentionResponse](UsageLogsByRetentionResponse.md)
|
648
703
|
- [DatadogAPIClient::V1::UsageLogsHour](UsageLogsHour.md)
|
649
704
|
- [DatadogAPIClient::V1::UsageLogsResponse](UsageLogsResponse.md)
|
650
705
|
- [DatadogAPIClient::V1::UsageMetricCategory](UsageMetricCategory.md)
|
@@ -705,6 +760,7 @@ Class | Method | HTTP request | Description
|
|
705
760
|
- [DatadogAPIClient::V1::WidgetFormula](WidgetFormula.md)
|
706
761
|
- [DatadogAPIClient::V1::WidgetFormulaLimit](WidgetFormulaLimit.md)
|
707
762
|
- [DatadogAPIClient::V1::WidgetGrouping](WidgetGrouping.md)
|
763
|
+
- [DatadogAPIClient::V1::WidgetHorizontalAlign](WidgetHorizontalAlign.md)
|
708
764
|
- [DatadogAPIClient::V1::WidgetImageSizing](WidgetImageSizing.md)
|
709
765
|
- [DatadogAPIClient::V1::WidgetLayout](WidgetLayout.md)
|
710
766
|
- [DatadogAPIClient::V1::WidgetLayoutType](WidgetLayoutType.md)
|
@@ -729,6 +785,7 @@ Class | Method | HTTP request | Description
|
|
729
785
|
- [DatadogAPIClient::V1::WidgetTickEdge](WidgetTickEdge.md)
|
730
786
|
- [DatadogAPIClient::V1::WidgetTime](WidgetTime.md)
|
731
787
|
- [DatadogAPIClient::V1::WidgetTimeWindows](WidgetTimeWindows.md)
|
788
|
+
- [DatadogAPIClient::V1::WidgetVerticalAlign](WidgetVerticalAlign.md)
|
732
789
|
- [DatadogAPIClient::V1::WidgetViewMode](WidgetViewMode.md)
|
733
790
|
- [DatadogAPIClient::V1::WidgetVizType](WidgetVizType.md)
|
734
791
|
|