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
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 6f8c27f68745fac84ba1e99c2eb2a3b8c5069c9f9eebb75e1613f17c46b881e7
|
4
|
+
data.tar.gz: f76092cc4feefa6da4c37a5fe6518d7f2e43d0f80a3acbf0498f2a2605150052
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 5d8522e5a486a3fec4475bed5df0d9fd60a5140d36c8bde7e08680b8948de228504ee9bb85ee753b5629b991ec296dc6cbff0cbff505f3cc7480d6146bee9f77
|
7
|
+
data.tar.gz: d391296273c9822018604c15266617d55ced689c4fe863f1b16eff624c76b48f4dc77c788d2e5c137b4e205a5a4f32a13166fad57da4c1c267105c5b4db3c15e
|
data/.apigentools-info
CHANGED
@@ -4,13 +4,13 @@
|
|
4
4
|
"spec_versions": {
|
5
5
|
"v1": {
|
6
6
|
"apigentools_version": "1.4.1.dev6",
|
7
|
-
"regenerated": "2021-
|
8
|
-
"spec_repo_commit": "
|
7
|
+
"regenerated": "2021-05-12 09:43:20.279249",
|
8
|
+
"spec_repo_commit": "62c8ffe"
|
9
9
|
},
|
10
10
|
"v2": {
|
11
11
|
"apigentools_version": "1.4.1.dev6",
|
12
|
-
"regenerated": "2021-
|
13
|
-
"spec_repo_commit": "
|
12
|
+
"regenerated": "2021-05-12 09:44:17.148819",
|
13
|
+
"spec_repo_commit": "62c8ffe"
|
14
14
|
}
|
15
15
|
}
|
16
16
|
}
|
data/.azure-pipelines/all.yml
CHANGED
data/.rubocop.yml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
# This file is based on https://github.com/rails/rails/blob/master/.rubocop.yml (MIT license)
|
2
2
|
# Automatically generated by OpenAPI Generator (https://openapi-generator.tech)
|
3
3
|
AllCops:
|
4
|
-
TargetRubyVersion: 2.
|
4
|
+
TargetRubyVersion: 2.5
|
5
5
|
# RuboCop has a bunch of cops enabled by default. This setting tells RuboCop
|
6
6
|
# to ignore them, so only the ones explicitly set in this file are enabled.
|
7
7
|
DisabledByDefault: true
|
data/CHANGELOG.md
CHANGED
@@ -1,5 +1,28 @@
|
|
1
1
|
# CHANGELOG
|
2
2
|
|
3
|
+
## 1.0.0 / 2021-05-12
|
4
|
+
|
5
|
+
* [Added] Notebooks Public API Documentation. See [#351](https://github.com/DataDog/datadog-api-client-ruby/pull/351).
|
6
|
+
* [Added] Add `logs_by_retention` usage property and `GetUsageLogsByRetention` endpoint. See [#345](https://github.com/DataDog/datadog-api-client-ruby/pull/345).
|
7
|
+
* [Added] Add anomaly detection method to `SecurityMonitoringRuleDetectionMethod` enum. See [#344](https://github.com/DataDog/datadog-api-client-ruby/pull/344).
|
8
|
+
* [Added] Add `with_configured_alert_ids` parameter to get a SLO details endpoint. See [#341](https://github.com/DataDog/datadog-api-client-ruby/pull/341).
|
9
|
+
* [Added] Add `setCookie`, `dnsServerPort`, `allowFailure ` and `isCritical` fields for Synthetics tests. See [#338](https://github.com/DataDog/datadog-api-client-ruby/pull/338).
|
10
|
+
* [Added] Add `metadata` property with pagination info to `SLOList` endpoint response. See [#334](https://github.com/DataDog/datadog-api-client-ruby/pull/334).
|
11
|
+
* [Added] Add new properties to group widget, note widget and image widget. See [#331](https://github.com/DataDog/datadog-api-client-ruby/pull/331).
|
12
|
+
* [Added] Add support for a `rate` metric type in manage metric tags v2 endpoint. See [#329](https://github.com/DataDog/datadog-api-client-ruby/pull/329).
|
13
|
+
* [Added] Add support for ICMP Synthetics tests. See [#326](https://github.com/DataDog/datadog-api-client-ruby/pull/326).
|
14
|
+
* [Added] Add vSphere usage information. See [#323](https://github.com/DataDog/datadog-api-client-ruby/pull/323).
|
15
|
+
* [Added] Mark metric volumes and ingested tags endpoints as stable. See [#318](https://github.com/DataDog/datadog-api-client-ruby/pull/318).
|
16
|
+
* [Added] Add `filter[shared]` query parameter for searching dashboards. See [#310](https://github.com/DataDog/datadog-api-client-ruby/pull/310).
|
17
|
+
* [Added] Add profiling product fields in usage metering endpoint. See [#309](https://github.com/DataDog/datadog-api-client-ruby/pull/309).
|
18
|
+
* [Added] Add `title` and `background_color` properties to dashboard group widget. See [#308](https://github.com/DataDog/datadog-api-client-ruby/pull/308).
|
19
|
+
* [Added] Add `marker`, `xaxis` and `yaxis` properties on distribution widgets. See [#322](https://github.com/DataDog/datadog-api-client-ruby/pull/322).
|
20
|
+
* [Fixed] Remove default value of `is_column_break` layout property of dashboard. See [#350](https://github.com/DataDog/datadog-api-client-ruby/pull/350).
|
21
|
+
* [Changed] Enumerate accepted values for fields parameter in usage attribution requests. See [#348](https://github.com/DataDog/datadog-api-client-ruby/pull/348).
|
22
|
+
* [Changed] Add frequency and remove request as required field from synthetics test. See [#346](https://github.com/DataDog/datadog-api-client-ruby/pull/346).
|
23
|
+
* [Deprecated] Deprecate `legend_size` and `show_legend` properties on distribution widgets. See [#322](https://github.com/DataDog/datadog-api-client-ruby/pull/322).
|
24
|
+
* [Removed] Remove deprecated Synthetics methods `CreateTest` and `UpdateTest`. See [#324](https://github.com/DataDog/datadog-api-client-ruby/pull/324).
|
25
|
+
|
3
26
|
## v1.0.0.beta.3 / 2021-04-15
|
4
27
|
|
5
28
|
* [Added] Add `reflow_type` property to dashboard object. See [#294](https://github.com/DataDog/datadog-api-client-ruby/pull/294).
|
data/Gemfile
CHANGED
@@ -5,7 +5,6 @@ source 'https://rubygems.org'
|
|
5
5
|
gemspec
|
6
6
|
|
7
7
|
group :development, :test do
|
8
|
-
gem 'codecov', '!= 0.2.14'
|
9
8
|
gem 'cucumber'
|
10
9
|
gem 'gem-release'
|
11
10
|
# gem 'ddtrace'
|
@@ -16,6 +15,7 @@ group :development, :test do
|
|
16
15
|
gem 'rubocop'
|
17
16
|
gem 'reek'
|
18
17
|
gem 'rspec-expectations'
|
18
|
+
gem 'simplecov'
|
19
19
|
gem 'solargraph'
|
20
20
|
gem 'timecop'
|
21
21
|
gem 'webmock'
|
data/LICENSE-3rdparty.csv
CHANGED
@@ -7,7 +7,6 @@ benchmark,BSD-2-Clause,Yukihiro Matsumoto
|
|
7
7
|
builder,MIT,Jim Weirich
|
8
8
|
bundler,MIT,"André Arko, Samuel Giddins, Colby Swandale, Hiroshi Shibata, David Rodríguez, Grey Baker, Stephanie Morillo, Chris Morris, James Wen, Tim Moore, André Medeiros, Jessica Lynn Suttles, Terence Lee, Carl Lerche, Yehuda Katz"
|
9
9
|
byebug,BSD-2-Clause,"David Rodriguez, Kent Sibilev, Mark Moseley"
|
10
|
-
codecov,MIT,codecov
|
11
10
|
coderay,MIT,Kornelius Kalnbach
|
12
11
|
concurrent-ruby,MIT,"Jerry D'Antonio, Petr Chalupa, The Ruby Concurrency Team"
|
13
12
|
crack,MIT,John Nunemaker
|
data/check-examples.sh
CHANGED
@@ -1,9 +1,14 @@
|
|
1
1
|
#!/usr/bin/env bash
|
2
2
|
|
3
|
-
|
3
|
+
if [ $# -eq 0 ]; then
|
4
|
+
echo "No arguments supplied"
|
5
|
+
exit 2
|
6
|
+
fi
|
7
|
+
|
8
|
+
./extract-code-blocks.sh examples $1
|
4
9
|
|
5
10
|
bundle install
|
6
|
-
ls examples
|
11
|
+
ls examples/$1/*/*.rbbeta | xargs -P $(($(nproc)*2)) -n 1 bundle exec ruby -cw && bundle exec rubocop examples/$1/*/*.rbbeta
|
7
12
|
if [ $? -ne 0 ]; then
|
8
13
|
echo -e "Failed to build examples"
|
9
14
|
exit 1
|
data/data/v1/openapi.yaml
CHANGED
@@ -1005,10 +1005,10 @@ components:
|
|
1005
1005
|
type: array
|
1006
1006
|
type: object
|
1007
1007
|
DashboardReflowType:
|
1008
|
-
description: 'Reflow type for a
|
1009
|
-
layout type is ''ordered''.
|
1008
|
+
description: 'Reflow type for a **new dashboard layout** dashboard. Set this
|
1009
|
+
only when layout type is ''ordered''.
|
1010
1010
|
|
1011
|
-
If set to ''fixed'', the dashboard
|
1011
|
+
If set to ''fixed'', the dashboard expects all widgets to have a layout, and
|
1012
1012
|
if it''s set to ''auto'',
|
1013
1013
|
|
1014
1014
|
widgets should not have layouts.'
|
@@ -1119,7 +1119,15 @@ components:
|
|
1119
1119
|
\ a distribution graph\u2019s x-axis is quantity rather than time."
|
1120
1120
|
properties:
|
1121
1121
|
legend_size:
|
1122
|
-
|
1122
|
+
deprecated: true
|
1123
|
+
description: (Deprecated) The widget legend was replaced by a tooltip and
|
1124
|
+
sidebar.
|
1125
|
+
type: string
|
1126
|
+
markers:
|
1127
|
+
description: List of markers.
|
1128
|
+
items:
|
1129
|
+
$ref: '#/components/schemas/WidgetMarker'
|
1130
|
+
type: array
|
1123
1131
|
requests:
|
1124
1132
|
description: "Array of one request object to display in the widget.\n\n\
|
1125
1133
|
See the dedicated [Request JSON schema documentation](https://docs.datadoghq.com/dashboards/graphing_json/request_json)\n\
|
@@ -1132,7 +1140,9 @@ components:
|
|
1132
1140
|
minItems: 1
|
1133
1141
|
type: array
|
1134
1142
|
show_legend:
|
1135
|
-
|
1143
|
+
deprecated: true
|
1144
|
+
description: (Deprecated) The widget legend was replaced by a tooltip and
|
1145
|
+
sidebar.
|
1136
1146
|
type: boolean
|
1137
1147
|
time:
|
1138
1148
|
$ref: '#/components/schemas/WidgetTime'
|
@@ -1146,6 +1156,10 @@ components:
|
|
1146
1156
|
type: string
|
1147
1157
|
type:
|
1148
1158
|
$ref: '#/components/schemas/DistributionWidgetDefinitionType'
|
1159
|
+
xaxis:
|
1160
|
+
$ref: '#/components/schemas/DistributionWidgetXAxis'
|
1161
|
+
yaxis:
|
1162
|
+
$ref: '#/components/schemas/DistributionWidgetYAxis'
|
1149
1163
|
required:
|
1150
1164
|
- type
|
1151
1165
|
- requests
|
@@ -1184,6 +1198,51 @@ components:
|
|
1184
1198
|
style:
|
1185
1199
|
$ref: '#/components/schemas/WidgetStyle'
|
1186
1200
|
type: object
|
1201
|
+
DistributionWidgetXAxis:
|
1202
|
+
description: X Axis controls for the distribution widget.
|
1203
|
+
properties:
|
1204
|
+
include_zero:
|
1205
|
+
description: True includes zero.
|
1206
|
+
type: boolean
|
1207
|
+
max:
|
1208
|
+
default: auto
|
1209
|
+
description: Specifies maximum value to show on the x-axis. It takes a number,
|
1210
|
+
percentile (p90 === 90th percentile), or auto for default behavior.
|
1211
|
+
type: string
|
1212
|
+
min:
|
1213
|
+
default: auto
|
1214
|
+
description: Specifies minimum value to show on the x-axis. It takes a number,
|
1215
|
+
percentile (p90 === 90th percentile), or auto for default behavior.
|
1216
|
+
type: string
|
1217
|
+
scale:
|
1218
|
+
default: linear
|
1219
|
+
description: Specifies the scale type. Possible values are `linear`.
|
1220
|
+
type: string
|
1221
|
+
type: object
|
1222
|
+
DistributionWidgetYAxis:
|
1223
|
+
description: Y Axis controls for the distribution widget.
|
1224
|
+
properties:
|
1225
|
+
include_zero:
|
1226
|
+
description: True includes zero.
|
1227
|
+
type: boolean
|
1228
|
+
label:
|
1229
|
+
description: The label of the axis to display on the graph.
|
1230
|
+
type: string
|
1231
|
+
max:
|
1232
|
+
default: auto
|
1233
|
+
description: Specifies the maximum value to show on the y-axis. It takes
|
1234
|
+
a number, or auto for default behavior.
|
1235
|
+
type: string
|
1236
|
+
min:
|
1237
|
+
default: auto
|
1238
|
+
description: Specifies minimum value to show on the y-axis. It takes a number,
|
1239
|
+
or auto for default behavior.
|
1240
|
+
type: string
|
1241
|
+
scale:
|
1242
|
+
default: linear
|
1243
|
+
description: Specifies the scale type. Possible values are `linear` or `log`.
|
1244
|
+
type: string
|
1245
|
+
type: object
|
1187
1246
|
Downtime:
|
1188
1247
|
description: 'Downtiming gives you greater control over monitor notifications
|
1189
1248
|
by
|
@@ -2242,11 +2301,23 @@ components:
|
|
2242
2301
|
your timeboard. Each group has a custom header, can hold one to many graphs,
|
2243
2302
|
and is collapsible.
|
2244
2303
|
properties:
|
2304
|
+
background_color:
|
2305
|
+
description: Background color of the group title.
|
2306
|
+
type: string
|
2307
|
+
banner_img:
|
2308
|
+
description: URL of image to display as a banner for the group.
|
2309
|
+
type: string
|
2245
2310
|
layout_type:
|
2246
2311
|
$ref: '#/components/schemas/WidgetLayoutType'
|
2312
|
+
show_title:
|
2313
|
+
default: true
|
2314
|
+
description: Whether to show the title or not.
|
2315
|
+
type: boolean
|
2247
2316
|
title:
|
2248
2317
|
description: Title of the widget.
|
2249
2318
|
type: string
|
2319
|
+
title_align:
|
2320
|
+
$ref: '#/components/schemas/WidgetTextAlign'
|
2250
2321
|
type:
|
2251
2322
|
$ref: '#/components/schemas/GroupWidgetDefinitionType'
|
2252
2323
|
widgets:
|
@@ -2936,6 +3007,18 @@ components:
|
|
2936
3007
|
An image can be a PNG, JPG, or animated GIF. Only available on FREE layout
|
2937
3008
|
dashboards.
|
2938
3009
|
properties:
|
3010
|
+
has_background:
|
3011
|
+
default: true
|
3012
|
+
description: Whether to display a background or not.
|
3013
|
+
example: true
|
3014
|
+
type: boolean
|
3015
|
+
has_border:
|
3016
|
+
default: true
|
3017
|
+
description: Whether to display a border or not.
|
3018
|
+
example: true
|
3019
|
+
type: boolean
|
3020
|
+
horizontal_align:
|
3021
|
+
$ref: '#/components/schemas/WidgetHorizontalAlign'
|
2939
3022
|
margin:
|
2940
3023
|
$ref: '#/components/schemas/WidgetMargin'
|
2941
3024
|
sizing:
|
@@ -2944,8 +3027,14 @@ components:
|
|
2944
3027
|
$ref: '#/components/schemas/ImageWidgetDefinitionType'
|
2945
3028
|
url:
|
2946
3029
|
description: URL of the image.
|
2947
|
-
example:
|
3030
|
+
example: https://example.com/image.png
|
3031
|
+
type: string
|
3032
|
+
url_dark_theme:
|
3033
|
+
description: URL of the image in dark mode.
|
3034
|
+
example: https://example.com/image-dark-mode.png
|
2948
3035
|
type: string
|
3036
|
+
vertical_align:
|
3037
|
+
$ref: '#/components/schemas/WidgetVerticalAlign'
|
2949
3038
|
required:
|
2950
3039
|
- type
|
2951
3040
|
- url
|
@@ -3293,6 +3382,51 @@ components:
|
|
3293
3382
|
type: string
|
3294
3383
|
x-enum-varnames:
|
3295
3384
|
- ATTRIBUTE_REMAPPER
|
3385
|
+
LogsByRetention:
|
3386
|
+
description: Object containing logs usage data broken down by retention period.
|
3387
|
+
properties:
|
3388
|
+
orgs:
|
3389
|
+
description: Indexed logs usage summary for each organization for each retention
|
3390
|
+
period with usage.
|
3391
|
+
properties:
|
3392
|
+
usage:
|
3393
|
+
description: Indexed logs usage summary for each organization.
|
3394
|
+
items:
|
3395
|
+
$ref: '#/components/schemas/LogsByRetentionOrgUsage'
|
3396
|
+
type: array
|
3397
|
+
type: object
|
3398
|
+
usage:
|
3399
|
+
description: Aggregated index logs usage for each retention period with
|
3400
|
+
usage.
|
3401
|
+
items:
|
3402
|
+
$ref: '#/components/schemas/LogsRetentionAggSumUsage'
|
3403
|
+
type: array
|
3404
|
+
usage_by_month:
|
3405
|
+
$ref: '#/components/schemas/LogsByRetentionMonthlyUsage'
|
3406
|
+
type: object
|
3407
|
+
LogsByRetentionMonthlyUsage:
|
3408
|
+
description: Object containing a summary of indexed logs usage by retention
|
3409
|
+
period for a single month.
|
3410
|
+
properties:
|
3411
|
+
date:
|
3412
|
+
description: The month for the usage.
|
3413
|
+
format: datetime
|
3414
|
+
type: string
|
3415
|
+
usage:
|
3416
|
+
description: Indexed logs usage for each active retention for the month.
|
3417
|
+
items:
|
3418
|
+
$ref: '#/components/schemas/LogsRetentionSumUsage'
|
3419
|
+
type: array
|
3420
|
+
type: object
|
3421
|
+
LogsByRetentionOrgUsage:
|
3422
|
+
description: Indexed logs usage by retention for a single organization.
|
3423
|
+
properties:
|
3424
|
+
usage:
|
3425
|
+
description: Indexed logs usage for each active retention for the organization.
|
3426
|
+
items:
|
3427
|
+
$ref: '#/components/schemas/LogsRetentionSumUsage'
|
3428
|
+
type: array
|
3429
|
+
type: object
|
3296
3430
|
LogsCategoryProcessor:
|
3297
3431
|
description: "Use the Category Processor to add a new attribute (without spaces\
|
3298
3432
|
\ or special characters in the new attribute name)\nto a log matching a provided\
|
@@ -4009,6 +4143,48 @@ components:
|
|
4009
4143
|
required:
|
4010
4144
|
- aggregation
|
4011
4145
|
type: object
|
4146
|
+
LogsRetentionAggSumUsage:
|
4147
|
+
description: Object containing indexed logs usage aggregated across organizations
|
4148
|
+
and months for a retention period.
|
4149
|
+
properties:
|
4150
|
+
logs_indexed_logs_usage_agg_sum:
|
4151
|
+
description: Total indexed logs for this retention period.
|
4152
|
+
format: int64
|
4153
|
+
type: integer
|
4154
|
+
logs_live_indexed_logs_usage_agg_sum:
|
4155
|
+
description: Live indexed logs for this retention period.
|
4156
|
+
format: int64
|
4157
|
+
type: integer
|
4158
|
+
logs_rehydrated_indexed_logs_usage_agg_sum:
|
4159
|
+
description: Rehydrated indexed logs for this retention period.
|
4160
|
+
format: int64
|
4161
|
+
type: integer
|
4162
|
+
retention:
|
4163
|
+
description: The retention period in days or "custom" for all custom retention
|
4164
|
+
periods.
|
4165
|
+
type: string
|
4166
|
+
type: object
|
4167
|
+
LogsRetentionSumUsage:
|
4168
|
+
description: Object containing indexed logs usage grouped by retention period
|
4169
|
+
and summed.
|
4170
|
+
properties:
|
4171
|
+
logs_indexed_logs_usage_sum:
|
4172
|
+
description: Total indexed logs for this retention period.
|
4173
|
+
format: int64
|
4174
|
+
type: integer
|
4175
|
+
logs_live_indexed_logs_usage_sum:
|
4176
|
+
description: Live indexed logs for this retention period.
|
4177
|
+
format: int64
|
4178
|
+
type: integer
|
4179
|
+
logs_rehydrated_indexed_logs_usage_sum:
|
4180
|
+
description: Rehydrated indexed logs for this retention period.
|
4181
|
+
format: int64
|
4182
|
+
type: integer
|
4183
|
+
retention:
|
4184
|
+
description: The retention period in days or "custom" for all custom retention
|
4185
|
+
periods.
|
4186
|
+
type: string
|
4187
|
+
type: object
|
4012
4188
|
LogsServiceRemapper:
|
4013
4189
|
description: 'Use this processor if you want to assign one or more attributes
|
4014
4190
|
as the official service.
|
@@ -5024,51 +5200,712 @@ components:
|
|
5024
5200
|
tags:
|
5025
5201
|
description: Tags associated to your monitor.
|
5026
5202
|
items:
|
5027
|
-
description: A Datadog tag.
|
5028
|
-
type: string
|
5203
|
+
description: A Datadog tag.
|
5204
|
+
type: string
|
5205
|
+
type: array
|
5206
|
+
type:
|
5207
|
+
$ref: '#/components/schemas/MonitorType'
|
5208
|
+
type: object
|
5209
|
+
NoteWidgetDefinition:
|
5210
|
+
description: The notes and links widget is similar to free text widget, but
|
5211
|
+
allows for more formatting options.
|
5212
|
+
properties:
|
5213
|
+
background_color:
|
5214
|
+
description: Background color of the note.
|
5215
|
+
type: string
|
5216
|
+
content:
|
5217
|
+
description: Content of the note.
|
5218
|
+
example: ''
|
5219
|
+
type: string
|
5220
|
+
font_size:
|
5221
|
+
description: Size of the text.
|
5222
|
+
type: string
|
5223
|
+
has_padding:
|
5224
|
+
default: true
|
5225
|
+
description: Whether to add padding or not.
|
5226
|
+
type: boolean
|
5227
|
+
show_tick:
|
5228
|
+
description: Whether to show a tick or not.
|
5229
|
+
type: boolean
|
5230
|
+
text_align:
|
5231
|
+
$ref: '#/components/schemas/WidgetTextAlign'
|
5232
|
+
tick_edge:
|
5233
|
+
$ref: '#/components/schemas/WidgetTickEdge'
|
5234
|
+
tick_pos:
|
5235
|
+
description: Where to position the tick on an edge.
|
5236
|
+
type: string
|
5237
|
+
type:
|
5238
|
+
$ref: '#/components/schemas/NoteWidgetDefinitionType'
|
5239
|
+
vertical_align:
|
5240
|
+
$ref: '#/components/schemas/WidgetVerticalAlign'
|
5241
|
+
required:
|
5242
|
+
- type
|
5243
|
+
- content
|
5244
|
+
type: object
|
5245
|
+
NoteWidgetDefinitionType:
|
5246
|
+
default: note
|
5247
|
+
description: Type of the note widget.
|
5248
|
+
enum:
|
5249
|
+
- note
|
5250
|
+
example: note
|
5251
|
+
type: string
|
5252
|
+
x-enum-varnames:
|
5253
|
+
- NOTE
|
5254
|
+
NotebookAbsoluteTime:
|
5255
|
+
description: Absolute timeframe.
|
5256
|
+
example:
|
5257
|
+
end: '2021-02-24T20:18:28+00:00'
|
5258
|
+
start: '2021-02-24T19:18:28+00:00'
|
5259
|
+
properties:
|
5260
|
+
end:
|
5261
|
+
description: The end time.
|
5262
|
+
example: '2021-02-24T20:18:28+00:00'
|
5263
|
+
format: date-time
|
5264
|
+
type: string
|
5265
|
+
live:
|
5266
|
+
description: Indicates whether the timeframe should be shifted to end at
|
5267
|
+
the current time.
|
5268
|
+
type: boolean
|
5269
|
+
start:
|
5270
|
+
description: The start time.
|
5271
|
+
example: '2021-02-24T19:18:28+00:00'
|
5272
|
+
format: date-time
|
5273
|
+
type: string
|
5274
|
+
required:
|
5275
|
+
- start
|
5276
|
+
- end
|
5277
|
+
NotebookAuthor:
|
5278
|
+
description: Attributes of user object returned by the API.
|
5279
|
+
properties:
|
5280
|
+
created_at:
|
5281
|
+
description: Creation time of the user.
|
5282
|
+
format: date-time
|
5283
|
+
type: string
|
5284
|
+
disabled:
|
5285
|
+
description: Whether the user is disabled.
|
5286
|
+
type: boolean
|
5287
|
+
email:
|
5288
|
+
description: Email of the user.
|
5289
|
+
type: string
|
5290
|
+
handle:
|
5291
|
+
description: Handle of the user.
|
5292
|
+
type: string
|
5293
|
+
icon:
|
5294
|
+
description: URL of the user's icon.
|
5295
|
+
type: string
|
5296
|
+
name:
|
5297
|
+
description: Name of the user.
|
5298
|
+
type: string
|
5299
|
+
status:
|
5300
|
+
description: Status of the user.
|
5301
|
+
type: string
|
5302
|
+
title:
|
5303
|
+
description: Title of the user.
|
5304
|
+
type: string
|
5305
|
+
verified:
|
5306
|
+
description: Whether the user is verified.
|
5307
|
+
type: boolean
|
5308
|
+
type: object
|
5309
|
+
NotebookCellCreateRequest:
|
5310
|
+
description: The description of a notebook cell create request.
|
5311
|
+
properties:
|
5312
|
+
attributes:
|
5313
|
+
$ref: '#/components/schemas/NotebookCellCreateRequestAttributes'
|
5314
|
+
type:
|
5315
|
+
$ref: '#/components/schemas/NotebookCellResourceType'
|
5316
|
+
required:
|
5317
|
+
- attributes
|
5318
|
+
- type
|
5319
|
+
type: object
|
5320
|
+
NotebookCellCreateRequestAttributes:
|
5321
|
+
description: 'The attributes of a notebook cell in create cell request. Valid
|
5322
|
+
cell types are `markdown`, `timeseries`, `toplist`, `heatmap`, `distribution`,
|
5323
|
+
|
5324
|
+
`log_stream`. [More information on each graph visualization type.](https://docs.datadoghq.com/dashboards/widgets/)'
|
5325
|
+
example:
|
5326
|
+
definition:
|
5327
|
+
requests:
|
5328
|
+
- display_type: line
|
5329
|
+
q: avg:system.load.1{*}
|
5330
|
+
style:
|
5331
|
+
line_type: solid
|
5332
|
+
line_width: normal
|
5333
|
+
palette: dog_classic
|
5334
|
+
show_legend: true
|
5335
|
+
type: timeseries
|
5336
|
+
yaxis:
|
5337
|
+
scale: linear
|
5338
|
+
graph_size: m
|
5339
|
+
split_by:
|
5340
|
+
keys: []
|
5341
|
+
tags: []
|
5342
|
+
time: null
|
5343
|
+
oneOf:
|
5344
|
+
- $ref: '#/components/schemas/NotebookMarkdownCellAttributes'
|
5345
|
+
- $ref: '#/components/schemas/NotebookTimeseriesCellAttributes'
|
5346
|
+
- $ref: '#/components/schemas/NotebookToplistCellAttributes'
|
5347
|
+
- $ref: '#/components/schemas/NotebookHeatMapCellAttributes'
|
5348
|
+
- $ref: '#/components/schemas/NotebookDistributionCellAttributes'
|
5349
|
+
- $ref: '#/components/schemas/NotebookLogStreamCellAttributes'
|
5350
|
+
type: object
|
5351
|
+
NotebookCellResourceType:
|
5352
|
+
default: notebook_cells
|
5353
|
+
description: Type of the Notebook Cell resource.
|
5354
|
+
enum:
|
5355
|
+
- notebook_cells
|
5356
|
+
example: notebook_cells
|
5357
|
+
type: string
|
5358
|
+
x-enum-varnames:
|
5359
|
+
- NOTEBOOK_CELLS
|
5360
|
+
NotebookCellResponse:
|
5361
|
+
description: The description of a notebook cell response.
|
5362
|
+
properties:
|
5363
|
+
attributes:
|
5364
|
+
$ref: '#/components/schemas/NotebookCellResponseAttributes'
|
5365
|
+
id:
|
5366
|
+
description: Notebook cell ID.
|
5367
|
+
example: abcd1234
|
5368
|
+
type: string
|
5369
|
+
type:
|
5370
|
+
$ref: '#/components/schemas/NotebookCellResourceType'
|
5371
|
+
required:
|
5372
|
+
- id
|
5373
|
+
- type
|
5374
|
+
- attributes
|
5375
|
+
type: object
|
5376
|
+
NotebookCellResponseAttributes:
|
5377
|
+
description: 'The attributes of a notebook cell response. Valid cell types are
|
5378
|
+
`markdown`, `timeseries`, `toplist`, `heatmap`, `distribution`,
|
5379
|
+
|
5380
|
+
`log_stream`. [More information on each graph visualization type.](https://docs.datadoghq.com/dashboards/widgets/)'
|
5381
|
+
oneOf:
|
5382
|
+
- $ref: '#/components/schemas/NotebookMarkdownCellAttributes'
|
5383
|
+
- $ref: '#/components/schemas/NotebookTimeseriesCellAttributes'
|
5384
|
+
- $ref: '#/components/schemas/NotebookToplistCellAttributes'
|
5385
|
+
- $ref: '#/components/schemas/NotebookHeatMapCellAttributes'
|
5386
|
+
- $ref: '#/components/schemas/NotebookDistributionCellAttributes'
|
5387
|
+
- $ref: '#/components/schemas/NotebookLogStreamCellAttributes'
|
5388
|
+
type: object
|
5389
|
+
NotebookCellTime:
|
5390
|
+
description: Timeframe for the notebook cell. When 'null', the notebook global
|
5391
|
+
time is used.
|
5392
|
+
nullable: true
|
5393
|
+
oneOf:
|
5394
|
+
- $ref: '#/components/schemas/NotebookRelativeTime'
|
5395
|
+
- $ref: '#/components/schemas/NotebookAbsoluteTime'
|
5396
|
+
type: object
|
5397
|
+
NotebookCellUpdateRequest:
|
5398
|
+
description: The description of a notebook cell update request.
|
5399
|
+
properties:
|
5400
|
+
attributes:
|
5401
|
+
$ref: '#/components/schemas/NotebookCellUpdateRequestAttributes'
|
5402
|
+
id:
|
5403
|
+
description: Notebook cell ID.
|
5404
|
+
example: abcd1234
|
5405
|
+
type: string
|
5406
|
+
type:
|
5407
|
+
$ref: '#/components/schemas/NotebookCellResourceType'
|
5408
|
+
required:
|
5409
|
+
- id
|
5410
|
+
- type
|
5411
|
+
- attributes
|
5412
|
+
type: object
|
5413
|
+
NotebookCellUpdateRequestAttributes:
|
5414
|
+
description: 'The attributes of a notebook cell in update cell request. Valid
|
5415
|
+
cell types are `markdown`, `timeseries`, `toplist`, `heatmap`, `distribution`,
|
5416
|
+
|
5417
|
+
`log_stream`. [More information on each graph visualization type.](https://docs.datadoghq.com/dashboards/widgets/)'
|
5418
|
+
example:
|
5419
|
+
definition:
|
5420
|
+
requests:
|
5421
|
+
- display_type: line
|
5422
|
+
q: avg:system.load.1{*}
|
5423
|
+
style:
|
5424
|
+
line_type: solid
|
5425
|
+
line_width: normal
|
5426
|
+
palette: dog_classic
|
5427
|
+
show_legend: true
|
5428
|
+
type: timeseries
|
5429
|
+
yaxis:
|
5430
|
+
scale: linear
|
5431
|
+
graph_size: m
|
5432
|
+
split_by:
|
5433
|
+
keys: []
|
5434
|
+
tags: []
|
5435
|
+
time: null
|
5436
|
+
oneOf:
|
5437
|
+
- $ref: '#/components/schemas/NotebookMarkdownCellAttributes'
|
5438
|
+
- $ref: '#/components/schemas/NotebookTimeseriesCellAttributes'
|
5439
|
+
- $ref: '#/components/schemas/NotebookToplistCellAttributes'
|
5440
|
+
- $ref: '#/components/schemas/NotebookHeatMapCellAttributes'
|
5441
|
+
- $ref: '#/components/schemas/NotebookDistributionCellAttributes'
|
5442
|
+
- $ref: '#/components/schemas/NotebookLogStreamCellAttributes'
|
5443
|
+
type: object
|
5444
|
+
NotebookCreateData:
|
5445
|
+
description: The data for a notebook create request.
|
5446
|
+
properties:
|
5447
|
+
attributes:
|
5448
|
+
$ref: '#/components/schemas/NotebookCreateDataAttributes'
|
5449
|
+
type:
|
5450
|
+
$ref: '#/components/schemas/NotebookResourceType'
|
5451
|
+
required:
|
5452
|
+
- type
|
5453
|
+
- attributes
|
5454
|
+
type: object
|
5455
|
+
NotebookCreateDataAttributes:
|
5456
|
+
description: The data attributes of a notebook.
|
5457
|
+
properties:
|
5458
|
+
cells:
|
5459
|
+
description: List of cells to display in the notebook.
|
5460
|
+
example:
|
5461
|
+
- attributes:
|
5462
|
+
definition:
|
5463
|
+
text: '## Some test markdown
|
5464
|
+
|
5465
|
+
|
5466
|
+
```js
|
5467
|
+
|
5468
|
+
var x, y;
|
5469
|
+
|
5470
|
+
x = 5;
|
5471
|
+
|
5472
|
+
y = 6;
|
5473
|
+
|
5474
|
+
```'
|
5475
|
+
type: markdown
|
5476
|
+
type: notebook_cells
|
5477
|
+
- attributes:
|
5478
|
+
definition:
|
5479
|
+
requests:
|
5480
|
+
- display_type: line
|
5481
|
+
q: avg:system.load.1{*}
|
5482
|
+
style:
|
5483
|
+
line_type: solid
|
5484
|
+
line_width: normal
|
5485
|
+
palette: dog_classic
|
5486
|
+
show_legend: true
|
5487
|
+
type: timeseries
|
5488
|
+
yaxis:
|
5489
|
+
scale: linear
|
5490
|
+
graph_size: m
|
5491
|
+
split_by:
|
5492
|
+
keys: []
|
5493
|
+
tags: []
|
5494
|
+
time: null
|
5495
|
+
type: notebook_cells
|
5496
|
+
items:
|
5497
|
+
$ref: '#/components/schemas/NotebookCellCreateRequest'
|
5498
|
+
type: array
|
5499
|
+
name:
|
5500
|
+
description: Notebook name.
|
5501
|
+
example: Example Notebook
|
5502
|
+
maxLength: 80
|
5503
|
+
minLength: 0
|
5504
|
+
type: string
|
5505
|
+
status:
|
5506
|
+
$ref: '#/components/schemas/NotebookStatus'
|
5507
|
+
time:
|
5508
|
+
$ref: '#/components/schemas/NotebookGlobalTime'
|
5509
|
+
required:
|
5510
|
+
- name
|
5511
|
+
- cells
|
5512
|
+
- time
|
5513
|
+
type: object
|
5514
|
+
NotebookCreateRequest:
|
5515
|
+
description: The description of a notebook create request.
|
5516
|
+
properties:
|
5517
|
+
data:
|
5518
|
+
$ref: '#/components/schemas/NotebookCreateData'
|
5519
|
+
required:
|
5520
|
+
- data
|
5521
|
+
type: object
|
5522
|
+
NotebookDistributionCellAttributes:
|
5523
|
+
description: The attributes of a notebook distribution cell.
|
5524
|
+
properties:
|
5525
|
+
definition:
|
5526
|
+
$ref: '#/components/schemas/DistributionWidgetDefinition'
|
5527
|
+
graph_size:
|
5528
|
+
$ref: '#/components/schemas/NotebookGraphSize'
|
5529
|
+
split_by:
|
5530
|
+
$ref: '#/components/schemas/NotebookSplitBy'
|
5531
|
+
time:
|
5532
|
+
$ref: '#/components/schemas/NotebookCellTime'
|
5533
|
+
required:
|
5534
|
+
- definition
|
5535
|
+
type: object
|
5536
|
+
NotebookGlobalTime:
|
5537
|
+
description: Notebook global timeframe.
|
5538
|
+
oneOf:
|
5539
|
+
- $ref: '#/components/schemas/NotebookRelativeTime'
|
5540
|
+
- $ref: '#/components/schemas/NotebookAbsoluteTime'
|
5541
|
+
type: object
|
5542
|
+
NotebookGraphSize:
|
5543
|
+
description: The size of the graph.
|
5544
|
+
enum:
|
5545
|
+
- xs
|
5546
|
+
- s
|
5547
|
+
- m
|
5548
|
+
- l
|
5549
|
+
- xl
|
5550
|
+
type: string
|
5551
|
+
x-enum-varnames:
|
5552
|
+
- EXTRA_SMALL
|
5553
|
+
- SMALL
|
5554
|
+
- MEDIUM
|
5555
|
+
- LARGE
|
5556
|
+
- EXTRA_LARGE
|
5557
|
+
NotebookHeatMapCellAttributes:
|
5558
|
+
description: The attributes of a notebook heat map cell.
|
5559
|
+
properties:
|
5560
|
+
definition:
|
5561
|
+
$ref: '#/components/schemas/HeatMapWidgetDefinition'
|
5562
|
+
graph_size:
|
5563
|
+
$ref: '#/components/schemas/NotebookGraphSize'
|
5564
|
+
split_by:
|
5565
|
+
$ref: '#/components/schemas/NotebookSplitBy'
|
5566
|
+
time:
|
5567
|
+
$ref: '#/components/schemas/NotebookCellTime'
|
5568
|
+
required:
|
5569
|
+
- definition
|
5570
|
+
type: object
|
5571
|
+
NotebookLogStreamCellAttributes:
|
5572
|
+
description: The attributes of a notebook log stream cell.
|
5573
|
+
properties:
|
5574
|
+
definition:
|
5575
|
+
$ref: '#/components/schemas/LogStreamWidgetDefinition'
|
5576
|
+
graph_size:
|
5577
|
+
$ref: '#/components/schemas/NotebookGraphSize'
|
5578
|
+
time:
|
5579
|
+
$ref: '#/components/schemas/NotebookCellTime'
|
5580
|
+
required:
|
5581
|
+
- definition
|
5582
|
+
type: object
|
5583
|
+
NotebookMarkdownCellAttributes:
|
5584
|
+
description: The attributes of a notebooks markdown cell.
|
5585
|
+
properties:
|
5586
|
+
definition:
|
5587
|
+
$ref: '#/components/schemas/NotebookMarkdownCellDefinition'
|
5588
|
+
required:
|
5589
|
+
- definition
|
5590
|
+
type: object
|
5591
|
+
NotebookMarkdownCellDefinition:
|
5592
|
+
description: Text in a notebook is formatted with [Markdown](https://daringfireball.net/projects/markdown/),
|
5593
|
+
which enables the use of headings, subheadings, links, images, lists, and
|
5594
|
+
code blocks.
|
5595
|
+
properties:
|
5596
|
+
text:
|
5597
|
+
description: The markdown content.
|
5598
|
+
example: "# Example Header \nexample content"
|
5599
|
+
type: string
|
5600
|
+
type:
|
5601
|
+
$ref: '#/components/schemas/NotebookMarkdownCellDefinitionType'
|
5602
|
+
required:
|
5603
|
+
- type
|
5604
|
+
- text
|
5605
|
+
type: object
|
5606
|
+
NotebookMarkdownCellDefinitionType:
|
5607
|
+
default: markdown
|
5608
|
+
description: Type of the markdown cell.
|
5609
|
+
enum:
|
5610
|
+
- markdown
|
5611
|
+
example: markdown
|
5612
|
+
type: string
|
5613
|
+
x-enum-varnames:
|
5614
|
+
- MARKDOWN
|
5615
|
+
NotebookRelativeTime:
|
5616
|
+
description: Relative timeframe.
|
5617
|
+
example:
|
5618
|
+
live_span: 1h
|
5619
|
+
properties:
|
5620
|
+
live_span:
|
5621
|
+
$ref: '#/components/schemas/WidgetLiveSpan'
|
5622
|
+
required:
|
5623
|
+
- live_span
|
5624
|
+
type: object
|
5625
|
+
NotebookResourceType:
|
5626
|
+
default: notebooks
|
5627
|
+
description: Type of the Notebook resource.
|
5628
|
+
enum:
|
5629
|
+
- notebooks
|
5630
|
+
example: notebooks
|
5631
|
+
type: string
|
5632
|
+
x-enum-varnames:
|
5633
|
+
- NOTEBOOKS
|
5634
|
+
NotebookResponse:
|
5635
|
+
description: The description of a notebook response.
|
5636
|
+
properties:
|
5637
|
+
data:
|
5638
|
+
$ref: '#/components/schemas/NotebookResponseData'
|
5639
|
+
type: object
|
5640
|
+
NotebookResponseData:
|
5641
|
+
description: The data for a notebook.
|
5642
|
+
properties:
|
5643
|
+
attributes:
|
5644
|
+
$ref: '#/components/schemas/NotebookResponseDataAttributes'
|
5645
|
+
id:
|
5646
|
+
description: Unique notebook ID, assigned when you create the notebook.
|
5647
|
+
example: 123456
|
5648
|
+
format: int64
|
5649
|
+
readOnly: true
|
5650
|
+
type: integer
|
5651
|
+
type:
|
5652
|
+
$ref: '#/components/schemas/NotebookResourceType'
|
5653
|
+
required:
|
5654
|
+
- id
|
5655
|
+
- type
|
5656
|
+
- attributes
|
5657
|
+
type: object
|
5658
|
+
NotebookResponseDataAttributes:
|
5659
|
+
description: The attributes of a notebook.
|
5660
|
+
properties:
|
5661
|
+
author:
|
5662
|
+
$ref: '#/components/schemas/NotebookAuthor'
|
5663
|
+
cells:
|
5664
|
+
description: List of cells to display in the notebook.
|
5665
|
+
example:
|
5666
|
+
- attributes:
|
5667
|
+
definition:
|
5668
|
+
text: '## Some test markdown
|
5669
|
+
|
5670
|
+
|
5671
|
+
```js
|
5672
|
+
|
5673
|
+
var x, y;
|
5674
|
+
|
5675
|
+
x = 5;
|
5676
|
+
|
5677
|
+
y = 6;
|
5678
|
+
|
5679
|
+
```'
|
5680
|
+
type: markdown
|
5681
|
+
id: bzbycoya
|
5682
|
+
type: notebook_cells
|
5683
|
+
- attributes:
|
5684
|
+
definition:
|
5685
|
+
requests:
|
5686
|
+
- display_type: line
|
5687
|
+
q: avg:system.load.1{*}
|
5688
|
+
style:
|
5689
|
+
line_type: solid
|
5690
|
+
line_width: normal
|
5691
|
+
palette: dog_classic
|
5692
|
+
show_legend: true
|
5693
|
+
type: timeseries
|
5694
|
+
yaxis:
|
5695
|
+
scale: linear
|
5696
|
+
graph_size: m
|
5697
|
+
split_by:
|
5698
|
+
keys: []
|
5699
|
+
tags: []
|
5700
|
+
time: null
|
5701
|
+
id: 9k6bc6xc
|
5702
|
+
type: notebook_cells
|
5703
|
+
items:
|
5704
|
+
$ref: '#/components/schemas/NotebookCellResponse'
|
5705
|
+
type: array
|
5706
|
+
created:
|
5707
|
+
description: UTC time stamp.
|
5708
|
+
example: '2021-02-24T23:14:15.173964+00:00'
|
5709
|
+
format: date-time
|
5710
|
+
readOnly: true
|
5711
|
+
type: string
|
5712
|
+
modified:
|
5713
|
+
description: UTC time stamp.
|
5714
|
+
example: '2021-02-24T23:15:23.274966+00:00'
|
5715
|
+
format: date-time
|
5716
|
+
readOnly: true
|
5717
|
+
type: string
|
5718
|
+
name:
|
5719
|
+
description: Notebook name.
|
5720
|
+
example: Example Notebook
|
5721
|
+
maxLength: 80
|
5722
|
+
minLength: 0
|
5723
|
+
type: string
|
5724
|
+
status:
|
5725
|
+
$ref: '#/components/schemas/NotebookStatus'
|
5726
|
+
time:
|
5727
|
+
$ref: '#/components/schemas/NotebookGlobalTime'
|
5728
|
+
required:
|
5729
|
+
- cells
|
5730
|
+
- time
|
5731
|
+
- name
|
5732
|
+
type: object
|
5733
|
+
NotebookSplitBy:
|
5734
|
+
description: Object describing how to split the graph to display multiple visualizations
|
5735
|
+
per request.
|
5736
|
+
properties:
|
5737
|
+
keys:
|
5738
|
+
description: Keys to split on.
|
5739
|
+
items:
|
5740
|
+
description: A key to split on.
|
5741
|
+
example: environment
|
5742
|
+
type: string
|
5743
|
+
type: array
|
5744
|
+
tags:
|
5745
|
+
description: Tags to split on.
|
5746
|
+
items:
|
5747
|
+
description: A tag to split on.
|
5748
|
+
example: environment:staging
|
5749
|
+
type: string
|
5750
|
+
type: array
|
5751
|
+
required:
|
5752
|
+
- keys
|
5753
|
+
- tags
|
5754
|
+
type: object
|
5755
|
+
NotebookStatus:
|
5756
|
+
default: published
|
5757
|
+
description: Publication status of the notebook. For now, always "published".
|
5758
|
+
enum:
|
5759
|
+
- published
|
5760
|
+
example: published
|
5761
|
+
type: string
|
5762
|
+
x-enum-varnames:
|
5763
|
+
- PUBLISHED
|
5764
|
+
NotebookTimeseriesCellAttributes:
|
5765
|
+
description: The attributes of a notebook timeseries cell.
|
5766
|
+
properties:
|
5767
|
+
definition:
|
5768
|
+
$ref: '#/components/schemas/TimeseriesWidgetDefinition'
|
5769
|
+
graph_size:
|
5770
|
+
$ref: '#/components/schemas/NotebookGraphSize'
|
5771
|
+
split_by:
|
5772
|
+
$ref: '#/components/schemas/NotebookSplitBy'
|
5773
|
+
time:
|
5774
|
+
$ref: '#/components/schemas/NotebookCellTime'
|
5775
|
+
required:
|
5776
|
+
- definition
|
5777
|
+
type: object
|
5778
|
+
NotebookToplistCellAttributes:
|
5779
|
+
description: The attributes of a notebook toplist cell.
|
5780
|
+
properties:
|
5781
|
+
definition:
|
5782
|
+
$ref: '#/components/schemas/ToplistWidgetDefinition'
|
5783
|
+
graph_size:
|
5784
|
+
$ref: '#/components/schemas/NotebookGraphSize'
|
5785
|
+
split_by:
|
5786
|
+
$ref: '#/components/schemas/NotebookSplitBy'
|
5787
|
+
time:
|
5788
|
+
$ref: '#/components/schemas/NotebookCellTime'
|
5789
|
+
required:
|
5790
|
+
- definition
|
5791
|
+
type: object
|
5792
|
+
NotebookUpdateCell:
|
5793
|
+
description: 'Updating a notebook can either insert new cell(s) or update existing
|
5794
|
+
cell(s) by including the cell `id`.
|
5795
|
+
|
5796
|
+
To delete existing cell(s), simply omit it from the list of cells.'
|
5797
|
+
oneOf:
|
5798
|
+
- $ref: '#/components/schemas/NotebookCellCreateRequest'
|
5799
|
+
- $ref: '#/components/schemas/NotebookCellUpdateRequest'
|
5800
|
+
type: object
|
5801
|
+
NotebookUpdateData:
|
5802
|
+
description: The data for a notebook update request.
|
5803
|
+
properties:
|
5804
|
+
attributes:
|
5805
|
+
$ref: '#/components/schemas/NotebookUpdateDataAttributes'
|
5806
|
+
type:
|
5807
|
+
$ref: '#/components/schemas/NotebookResourceType'
|
5808
|
+
required:
|
5809
|
+
- type
|
5810
|
+
- attributes
|
5811
|
+
type: object
|
5812
|
+
NotebookUpdateDataAttributes:
|
5813
|
+
description: The data attributes of a notebook.
|
5814
|
+
properties:
|
5815
|
+
cells:
|
5816
|
+
description: List of cells to display in the notebook.
|
5817
|
+
example:
|
5818
|
+
- attributes:
|
5819
|
+
definition:
|
5820
|
+
text: '## Some test markdown
|
5821
|
+
|
5822
|
+
|
5823
|
+
```js
|
5824
|
+
|
5825
|
+
var x, y;
|
5826
|
+
|
5827
|
+
x = 5;
|
5828
|
+
|
5829
|
+
y = 6;
|
5830
|
+
|
5831
|
+
```'
|
5832
|
+
type: markdown
|
5833
|
+
id: bzbycoya
|
5834
|
+
type: notebook_cells
|
5835
|
+
- attributes:
|
5836
|
+
definition:
|
5837
|
+
requests:
|
5838
|
+
- display_type: line
|
5839
|
+
q: avg:system.load.1{*}
|
5840
|
+
style:
|
5841
|
+
line_type: solid
|
5842
|
+
line_width: normal
|
5843
|
+
palette: dog_classic
|
5844
|
+
show_legend: true
|
5845
|
+
type: timeseries
|
5846
|
+
yaxis:
|
5847
|
+
scale: linear
|
5848
|
+
graph_size: m
|
5849
|
+
split_by:
|
5850
|
+
keys: []
|
5851
|
+
tags: []
|
5852
|
+
time: null
|
5853
|
+
id: 9k6bc6xc
|
5854
|
+
type: notebook_cells
|
5855
|
+
items:
|
5856
|
+
$ref: '#/components/schemas/NotebookUpdateCell'
|
5857
|
+
type: array
|
5858
|
+
name:
|
5859
|
+
description: Notebook name.
|
5860
|
+
example: Example Notebook
|
5861
|
+
maxLength: 80
|
5862
|
+
minLength: 0
|
5863
|
+
type: string
|
5864
|
+
status:
|
5865
|
+
$ref: '#/components/schemas/NotebookStatus'
|
5866
|
+
time:
|
5867
|
+
$ref: '#/components/schemas/NotebookGlobalTime'
|
5868
|
+
required:
|
5869
|
+
- name
|
5870
|
+
- cells
|
5871
|
+
- time
|
5872
|
+
type: object
|
5873
|
+
NotebookUpdateRequest:
|
5874
|
+
description: The description of a notebook update request.
|
5875
|
+
properties:
|
5876
|
+
data:
|
5877
|
+
$ref: '#/components/schemas/NotebookUpdateData'
|
5878
|
+
required:
|
5879
|
+
- data
|
5880
|
+
type: object
|
5881
|
+
NotebooksResponse:
|
5882
|
+
description: Notebooks get all response.
|
5883
|
+
properties:
|
5884
|
+
data:
|
5885
|
+
description: List of notebook definitions.
|
5886
|
+
items:
|
5887
|
+
$ref: '#/components/schemas/NotebookResponseData'
|
5029
5888
|
type: array
|
5030
|
-
|
5031
|
-
|
5889
|
+
meta:
|
5890
|
+
description: Metadata returned by the API.
|
5891
|
+
properties:
|
5892
|
+
page:
|
5893
|
+
$ref: '#/components/schemas/NotebooksResponsePage'
|
5894
|
+
type: object
|
5032
5895
|
type: object
|
5033
|
-
|
5034
|
-
description:
|
5035
|
-
allows for more formatting options.
|
5896
|
+
NotebooksResponsePage:
|
5897
|
+
description: Pagination metadata returned by the API.
|
5036
5898
|
properties:
|
5037
|
-
|
5038
|
-
description:
|
5039
|
-
|
5040
|
-
|
5041
|
-
|
5042
|
-
|
5043
|
-
|
5044
|
-
|
5045
|
-
|
5046
|
-
type: string
|
5047
|
-
show_tick:
|
5048
|
-
description: Whether to show a tick or not.
|
5049
|
-
type: boolean
|
5050
|
-
text_align:
|
5051
|
-
$ref: '#/components/schemas/WidgetTextAlign'
|
5052
|
-
tick_edge:
|
5053
|
-
$ref: '#/components/schemas/WidgetTickEdge'
|
5054
|
-
tick_pos:
|
5055
|
-
description: Where to position the tick on an edge.
|
5056
|
-
type: string
|
5057
|
-
type:
|
5058
|
-
$ref: '#/components/schemas/NoteWidgetDefinitionType'
|
5059
|
-
required:
|
5060
|
-
- type
|
5061
|
-
- content
|
5899
|
+
total_count:
|
5900
|
+
description: The total number of notebooks that would be returned if the
|
5901
|
+
request was not filtered by `start` and `count` parameters.
|
5902
|
+
format: int64
|
5903
|
+
type: integer
|
5904
|
+
total_filtered_count:
|
5905
|
+
description: The total number of notebooks returned.
|
5906
|
+
format: int64
|
5907
|
+
type: integer
|
5062
5908
|
type: object
|
5063
|
-
NoteWidgetDefinitionType:
|
5064
|
-
default: note
|
5065
|
-
description: Type of the note widget.
|
5066
|
-
enum:
|
5067
|
-
- note
|
5068
|
-
example: note
|
5069
|
-
type: string
|
5070
|
-
x-enum-varnames:
|
5071
|
-
- NOTE
|
5072
5909
|
Organization:
|
5073
5910
|
description: Create, edit, and manage organizations.
|
5074
5911
|
properties:
|
@@ -6033,13 +6870,171 @@ components:
|
|
6033
6870
|
description: The error message.
|
6034
6871
|
type: string
|
6035
6872
|
type: array
|
6873
|
+
metadata:
|
6874
|
+
description: The metadata object containing additional information about
|
6875
|
+
the list of SLOs.
|
6876
|
+
properties:
|
6877
|
+
page:
|
6878
|
+
description: The object containing information about the pages of the
|
6879
|
+
list of SLOs.
|
6880
|
+
properties:
|
6881
|
+
total_count:
|
6882
|
+
description: The total number of resources that could be retrieved
|
6883
|
+
ignoring the parameters and filters in the request.
|
6884
|
+
format: int64
|
6885
|
+
type: integer
|
6886
|
+
total_filtered_count:
|
6887
|
+
description: The total number of resources that match the parameters
|
6888
|
+
and filters in the request. This attribute can be used by a client
|
6889
|
+
to determine the total number of pages.
|
6890
|
+
format: int64
|
6891
|
+
type: integer
|
6892
|
+
type: object
|
6893
|
+
type: object
|
6036
6894
|
type: object
|
6037
6895
|
SLOResponse:
|
6038
6896
|
description: A service level objective response containing a single service
|
6039
6897
|
level objective.
|
6040
6898
|
properties:
|
6041
6899
|
data:
|
6042
|
-
|
6900
|
+
description: 'A service level objective object includes a service level
|
6901
|
+
indicator, thresholds
|
6902
|
+
|
6903
|
+
for one or more timeframes, and metadata (`name`, `description`, `tags`,
|
6904
|
+
etc.).'
|
6905
|
+
properties:
|
6906
|
+
configured_alert_ids:
|
6907
|
+
description: A list of SLO monitors IDs that reference this SLO. This
|
6908
|
+
field is returned only when `with_configured_alert_ids` parameter
|
6909
|
+
is true in query.
|
6910
|
+
example:
|
6911
|
+
- 123
|
6912
|
+
- 456
|
6913
|
+
- 789
|
6914
|
+
items:
|
6915
|
+
description: A monitor ID.
|
6916
|
+
format: int64
|
6917
|
+
type: integer
|
6918
|
+
type: array
|
6919
|
+
created_at:
|
6920
|
+
description: 'Creation timestamp (UNIX time in seconds)
|
6921
|
+
|
6922
|
+
|
6923
|
+
Always included in service level objective responses.'
|
6924
|
+
format: int64
|
6925
|
+
readOnly: true
|
6926
|
+
type: integer
|
6927
|
+
creator:
|
6928
|
+
$ref: '#/components/schemas/Creator'
|
6929
|
+
description:
|
6930
|
+
description: 'A user-defined description of the service level objective.
|
6931
|
+
|
6932
|
+
|
6933
|
+
Always included in service level objective responses (but may be `null`).
|
6934
|
+
|
6935
|
+
Optional in create/update requests.'
|
6936
|
+
nullable: true
|
6937
|
+
type: string
|
6938
|
+
groups:
|
6939
|
+
description: 'A list of (up to 20) monitor groups that narrow the scope
|
6940
|
+
of a monitor service level objective.
|
6941
|
+
|
6942
|
+
|
6943
|
+
Included in service level objective responses if it is not empty.
|
6944
|
+
Optional in
|
6945
|
+
|
6946
|
+
create/update requests for monitor service level objectives, but may
|
6947
|
+
only be
|
6948
|
+
|
6949
|
+
used when then length of the `monitor_ids` field is one.'
|
6950
|
+
example:
|
6951
|
+
- env:prod
|
6952
|
+
- role:mysql
|
6953
|
+
items:
|
6954
|
+
description: A group name, for instance `env:prod`.
|
6955
|
+
type: string
|
6956
|
+
type: array
|
6957
|
+
id:
|
6958
|
+
description: 'A unique identifier for the service level objective object.
|
6959
|
+
|
6960
|
+
|
6961
|
+
Always included in service level objective responses.'
|
6962
|
+
readOnly: true
|
6963
|
+
type: string
|
6964
|
+
modified_at:
|
6965
|
+
description: 'Modification timestamp (UNIX time in seconds)
|
6966
|
+
|
6967
|
+
|
6968
|
+
Always included in service level objective responses.'
|
6969
|
+
format: int64
|
6970
|
+
readOnly: true
|
6971
|
+
type: integer
|
6972
|
+
monitor_ids:
|
6973
|
+
description: 'A list of monitor ids that defines the scope of a monitor
|
6974
|
+
service level
|
6975
|
+
|
6976
|
+
objective. **Required if type is `monitor`**.'
|
6977
|
+
items:
|
6978
|
+
description: A monitor ID.
|
6979
|
+
format: int64
|
6980
|
+
type: integer
|
6981
|
+
type: array
|
6982
|
+
monitor_tags:
|
6983
|
+
description: 'The union of monitor tags for all monitors referenced
|
6984
|
+
by the `monitor_ids`
|
6985
|
+
|
6986
|
+
field.
|
6987
|
+
|
6988
|
+
Always included in service level objective responses for monitor service
|
6989
|
+
level
|
6990
|
+
|
6991
|
+
objectives (but may be empty). Ignored in create/update requests.
|
6992
|
+
Does not
|
6993
|
+
|
6994
|
+
affect which monitors are included in the service level objective
|
6995
|
+
(that is
|
6996
|
+
|
6997
|
+
determined entirely by the `monitor_ids` field).'
|
6998
|
+
items:
|
6999
|
+
description: A monitor tag.
|
7000
|
+
type: string
|
7001
|
+
type: array
|
7002
|
+
name:
|
7003
|
+
description: The name of the service level objective object.
|
7004
|
+
example: Custom Metric SLO
|
7005
|
+
type: string
|
7006
|
+
query:
|
7007
|
+
$ref: '#/components/schemas/ServiceLevelObjectiveQuery'
|
7008
|
+
tags:
|
7009
|
+
description: 'A list of tags associated with this service level objective.
|
7010
|
+
|
7011
|
+
Always included in service level objective responses (but may be empty).
|
7012
|
+
|
7013
|
+
Optional in create/update requests.'
|
7014
|
+
example:
|
7015
|
+
- env:prod
|
7016
|
+
- app:core
|
7017
|
+
items:
|
7018
|
+
description: A tag to apply to your SLO.
|
7019
|
+
type: string
|
7020
|
+
type: array
|
7021
|
+
thresholds:
|
7022
|
+
description: 'The thresholds (timeframes and associated targets) for
|
7023
|
+
this service level
|
7024
|
+
|
7025
|
+
objective object.'
|
7026
|
+
example:
|
7027
|
+
- target: 95
|
7028
|
+
timeframe: 7d
|
7029
|
+
- target: 95
|
7030
|
+
timeframe: 30d
|
7031
|
+
warning: 97
|
7032
|
+
items:
|
7033
|
+
$ref: '#/components/schemas/SLOThreshold'
|
7034
|
+
type: array
|
7035
|
+
type:
|
7036
|
+
$ref: '#/components/schemas/SLOType'
|
7037
|
+
type: object
|
6043
7038
|
errors:
|
6044
7039
|
description: 'An array of error messages. Each endpoint documents how/whether
|
6045
7040
|
this field is
|
@@ -6763,6 +7758,10 @@ components:
|
|
6763
7758
|
SyntheticsAPIStep:
|
6764
7759
|
description: The steps used in a Synthetics multistep API test.
|
6765
7760
|
properties:
|
7761
|
+
allowFailure:
|
7762
|
+
description: Determines whether or not to continue with test if this step
|
7763
|
+
fails.
|
7764
|
+
type: boolean
|
6766
7765
|
assertions:
|
6767
7766
|
default: []
|
6768
7767
|
description: Array of assertions used for the test.
|
@@ -6775,6 +7774,12 @@ components:
|
|
6775
7774
|
items:
|
6776
7775
|
$ref: '#/components/schemas/SyntheticsParsingOptions'
|
6777
7776
|
type: array
|
7777
|
+
isCritical:
|
7778
|
+
description: 'Determines whether or not to consider the entire test as failed
|
7779
|
+
if this step fails.
|
7780
|
+
|
7781
|
+
Can be used only if `allowFailure` is `true`.'
|
7782
|
+
type: boolean
|
6778
7783
|
name:
|
6779
7784
|
description: The name of the step.
|
6780
7785
|
type: string
|
@@ -7061,6 +8066,10 @@ components:
|
|
7061
8066
|
- recordSome
|
7062
8067
|
- tlsVersion
|
7063
8068
|
- minTlsVersion
|
8069
|
+
- latency
|
8070
|
+
- packetLossPercentage
|
8071
|
+
- packetsReceived
|
8072
|
+
- networkHop
|
7064
8073
|
type: string
|
7065
8074
|
x-enum-varnames:
|
7066
8075
|
- BODY
|
@@ -7073,6 +8082,10 @@ components:
|
|
7073
8082
|
- RECORD_SOME
|
7074
8083
|
- TLS_VERSION
|
7075
8084
|
- MIN_TLS_VERSION
|
8085
|
+
- LATENCY
|
8086
|
+
- PACKET_LOSS_PERCENTAGE
|
8087
|
+
- PACKETS_RECEIVED
|
8088
|
+
- NETWORK_HOP
|
7076
8089
|
SyntheticsBasicAuth:
|
7077
8090
|
description: Object to handle basic authentication when performing the test.
|
7078
8091
|
properties:
|
@@ -7177,6 +8190,10 @@ components:
|
|
7177
8190
|
type: array
|
7178
8191
|
request:
|
7179
8192
|
$ref: '#/components/schemas/SyntheticsTestRequest'
|
8193
|
+
setCookie:
|
8194
|
+
description: Cookies to be used for the request, using the [Set-Cookie](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Set-Cookie)
|
8195
|
+
syntax.
|
8196
|
+
type: string
|
7180
8197
|
variables:
|
7181
8198
|
description: Array of variables used for the test steps.
|
7182
8199
|
items:
|
@@ -7423,6 +8440,7 @@ components:
|
|
7423
8440
|
type: object
|
7424
8441
|
required:
|
7425
8442
|
- public_id
|
8443
|
+
type: object
|
7426
8444
|
SyntheticsCITestBody:
|
7427
8445
|
description: Object describing the synthetics tests to trigger.
|
7428
8446
|
properties:
|
@@ -7734,6 +8752,7 @@ components:
|
|
7734
8752
|
type: string
|
7735
8753
|
required:
|
7736
8754
|
- value
|
8755
|
+
type: object
|
7737
8756
|
SyntheticsListTestsResponse:
|
7738
8757
|
description: Object containing an array of Synthetic tests configuration.
|
7739
8758
|
properties:
|
@@ -8134,7 +9153,6 @@ components:
|
|
8134
9153
|
$ref: '#/components/schemas/SyntheticsBrowserVariable'
|
8135
9154
|
type: array
|
8136
9155
|
required:
|
8137
|
-
- request
|
8138
9156
|
- assertions
|
8139
9157
|
type: object
|
8140
9158
|
SyntheticsTestDetails:
|
@@ -8184,13 +9202,14 @@ components:
|
|
8184
9202
|
SyntheticsTestDetailsSubType:
|
8185
9203
|
description: 'The subtype of the Synthetic API test, `http`, `ssl`, `tcp`,
|
8186
9204
|
|
8187
|
-
`dns` or `multi`.'
|
9205
|
+
`dns`, `icmp` or `multi`.'
|
8188
9206
|
enum:
|
8189
9207
|
- http
|
8190
9208
|
- ssl
|
8191
9209
|
- tcp
|
8192
9210
|
- dns
|
8193
9211
|
- multi
|
9212
|
+
- icmp
|
8194
9213
|
type: string
|
8195
9214
|
x-enum-varnames:
|
8196
9215
|
- HTTP
|
@@ -8198,6 +9217,7 @@ components:
|
|
8198
9217
|
- TCP
|
8199
9218
|
- DNS
|
8200
9219
|
- MULTI
|
9220
|
+
- ICMP
|
8201
9221
|
SyntheticsTestDetailsType:
|
8202
9222
|
description: Type of the Synthetic test, either `api` or `browser`.
|
8203
9223
|
enum:
|
@@ -8249,8 +9269,7 @@ components:
|
|
8249
9269
|
$ref: '#/components/schemas/SyntheticsDeviceID'
|
8250
9270
|
type: array
|
8251
9271
|
disableCors:
|
8252
|
-
description: Whether or not to disable CORS mechanism.
|
8253
|
-
for Chrome.
|
9272
|
+
description: Whether or not to disable CORS mechanism.
|
8254
9273
|
type: boolean
|
8255
9274
|
follow_redirects:
|
8256
9275
|
description: For API HTTP test, whether or not the test should follow redirects.
|
@@ -8346,6 +9365,12 @@ components:
|
|
8346
9365
|
dnsServer:
|
8347
9366
|
description: DNS server to use for DNS tests.
|
8348
9367
|
type: string
|
9368
|
+
dnsServerPort:
|
9369
|
+
description: DNS server port to use for DNS tests.
|
9370
|
+
format: int32
|
9371
|
+
maximum: 65535
|
9372
|
+
minimum: 1
|
9373
|
+
type: integer
|
8349
9374
|
headers:
|
8350
9375
|
$ref: '#/components/schemas/SyntheticsTestHeaders'
|
8351
9376
|
host:
|
@@ -8356,6 +9381,12 @@ components:
|
|
8356
9381
|
noSavingResponseBody:
|
8357
9382
|
description: Determines whether or not to save the response body.
|
8358
9383
|
type: boolean
|
9384
|
+
numberOfPackets:
|
9385
|
+
description: Number of pings to use per test.
|
9386
|
+
format: int32
|
9387
|
+
maximum: 10
|
9388
|
+
minimum: 0
|
9389
|
+
type: integer
|
8359
9390
|
port:
|
8360
9391
|
description: Port to use when performing the test.
|
8361
9392
|
format: int64
|
@@ -8363,6 +9394,10 @@ components:
|
|
8363
9394
|
query:
|
8364
9395
|
description: Query to use for the test.
|
8365
9396
|
type: object
|
9397
|
+
shouldTrackHops:
|
9398
|
+
description: Turns on a traceroute probe to discover all gateways along
|
9399
|
+
the path to the host destination.
|
9400
|
+
type: boolean
|
8366
9401
|
timeout:
|
8367
9402
|
description: Timeout in seconds for the test.
|
8368
9403
|
format: double
|
@@ -8395,6 +9430,7 @@ components:
|
|
8395
9430
|
SyntheticsTickInterval:
|
8396
9431
|
description: The frequency at which to run the Synthetic test (in seconds).
|
8397
9432
|
enum:
|
9433
|
+
- 30
|
8398
9434
|
- 60
|
8399
9435
|
- 300
|
8400
9436
|
- 900
|
@@ -8407,6 +9443,7 @@ components:
|
|
8407
9443
|
format: int64
|
8408
9444
|
type: integer
|
8409
9445
|
x-enum-varnames:
|
9446
|
+
- THIRTY_SECONDS
|
8410
9447
|
- MINUTE
|
8411
9448
|
- FIVE_MINUTES
|
8412
9449
|
- FIFTEEN_MINUTES
|
@@ -9083,6 +10120,70 @@ components:
|
|
9083
10120
|
- LAMBDA_INVOCATIONS_PERCENTAGE
|
9084
10121
|
- LAMBDA_USAGE
|
9085
10122
|
- LAMBDA_PERCENTAGE
|
10123
|
+
UsageAttributionSupportedMetrics:
|
10124
|
+
description: Supported fields for usage attribution requests (valid requests
|
10125
|
+
contain one or more metrics, or `*` for all).
|
10126
|
+
enum:
|
10127
|
+
- custom_timeseries_usage
|
10128
|
+
- container_usage
|
10129
|
+
- snmp_percentage
|
10130
|
+
- apm_host_usage
|
10131
|
+
- browser_usage
|
10132
|
+
- npm_host_percentage
|
10133
|
+
- infra_host_usage
|
10134
|
+
- custom_timeseries_percentage
|
10135
|
+
- container_percentage
|
10136
|
+
- lambda_usage
|
10137
|
+
- api_usage
|
10138
|
+
- apm_host_percentage
|
10139
|
+
- infra_host_percentage
|
10140
|
+
- snmp_usage
|
10141
|
+
- browser_percentage
|
10142
|
+
- api_percentage
|
10143
|
+
- lambda_percentage
|
10144
|
+
- npm_host_usage
|
10145
|
+
- lambda_functions_usage
|
10146
|
+
- lambda_functions_percentage
|
10147
|
+
- lambda_invocations_usage
|
10148
|
+
- lambda_invocations_percentage
|
10149
|
+
- fargate_usage
|
10150
|
+
- fargate_percentage
|
10151
|
+
- profiled_host_usage
|
10152
|
+
- profiled_host_percentage
|
10153
|
+
- profiled_container_usage
|
10154
|
+
- profiled_container_percentage
|
10155
|
+
- '*'
|
10156
|
+
type: string
|
10157
|
+
x-enum-varnames:
|
10158
|
+
- CUSTOM_TIMESERIES_USAGE
|
10159
|
+
- CONTAINER_USAGE
|
10160
|
+
- SNMP_PERCENTAGE
|
10161
|
+
- APM_HOST_USAGE
|
10162
|
+
- BROWSER_USAGE
|
10163
|
+
- NPM_HOST_PERCENTAGE
|
10164
|
+
- INFRA_HOST_USAGE
|
10165
|
+
- CUSTOM_TIMESERIES_PERCENTAGE
|
10166
|
+
- CONTAINER_PERCENTAGE
|
10167
|
+
- LAMBDA_USAGE
|
10168
|
+
- API_USAGE
|
10169
|
+
- APM_HOST_PERCENTAGE
|
10170
|
+
- INFRA_HOST_PERCENTAGE
|
10171
|
+
- SNMP_USAGE
|
10172
|
+
- BROWSER_PERCENTAGE
|
10173
|
+
- API_PERCENTAGE
|
10174
|
+
- LAMBDA_PERCENTAGE
|
10175
|
+
- NPM_HOST_USAGE
|
10176
|
+
- LAMBDA_FUNCTIONS_USAGE
|
10177
|
+
- LAMBDA_FUNCTIONS_PERCENTAGE
|
10178
|
+
- LAMBDA_INVOCATIONS_USAGE
|
10179
|
+
- LAMBDA_INVOCATIONS_PERCENTAGE
|
10180
|
+
- FARGATE_USAGE
|
10181
|
+
- FARGATE_PERCENTAGE
|
10182
|
+
- PROFILED_HOST_USAGE
|
10183
|
+
- PROFILED_HOST_PERCENTAGE
|
10184
|
+
- PROFILED_CONTAINER_USAGE
|
10185
|
+
- PROFILED_CONTAINER_PERCENTAGE
|
10186
|
+
- ALL
|
9086
10187
|
UsageAttributionTagNames:
|
9087
10188
|
additionalProperties:
|
9088
10189
|
description: A list of tag values.
|
@@ -9182,6 +10283,22 @@ components:
|
|
9182
10283
|
description: The network host usage by tag(s).
|
9183
10284
|
format: double
|
9184
10285
|
type: number
|
10286
|
+
profiled_containers_percentage:
|
10287
|
+
description: The percentage of profiled containers usage by tag(s).
|
10288
|
+
format: double
|
10289
|
+
type: number
|
10290
|
+
profiled_containers_usage:
|
10291
|
+
description: The profiled container usage by tag(s).
|
10292
|
+
format: double
|
10293
|
+
type: number
|
10294
|
+
profiled_hosts_percentage:
|
10295
|
+
description: The percentage of profiled hosts usage by tag(s).
|
10296
|
+
format: double
|
10297
|
+
type: number
|
10298
|
+
profiled_hosts_usage:
|
10299
|
+
description: The profiled host usage by tag(s).
|
10300
|
+
format: double
|
10301
|
+
type: number
|
9185
10302
|
snmp_percentage:
|
9186
10303
|
description: The percentage of network device usage by tag(s).
|
9187
10304
|
format: double
|
@@ -9497,6 +10614,13 @@ components:
|
|
9497
10614
|
for the OpenTelemetry Collector.
|
9498
10615
|
format: int64
|
9499
10616
|
type: integer
|
10617
|
+
vsphere_host_count:
|
10618
|
+
description: 'Contains the total number of hosts that reported via vSphere
|
10619
|
+
integration
|
10620
|
+
|
10621
|
+
(and were NOT running the Datadog Agent).'
|
10622
|
+
format: int64
|
10623
|
+
type: integer
|
9500
10624
|
type: object
|
9501
10625
|
UsageHostsResponse:
|
9502
10626
|
description: Host usage response.
|
@@ -9584,8 +10708,7 @@ components:
|
|
9584
10708
|
format: date-time
|
9585
10709
|
type: string
|
9586
10710
|
iot_device_count:
|
9587
|
-
description: The total number of IoT
|
9588
|
-
given hour's month until the given hour.
|
10711
|
+
description: The total number of IoT devices during a given hour.
|
9589
10712
|
format: int64
|
9590
10713
|
type: integer
|
9591
10714
|
type: object
|
@@ -9663,6 +10786,40 @@ components:
|
|
9663
10786
|
$ref: '#/components/schemas/UsageLogsByIndexHour'
|
9664
10787
|
type: array
|
9665
10788
|
type: object
|
10789
|
+
UsageLogsByRetentionHour:
|
10790
|
+
description: The number of indexed logs for each hour for a given organization
|
10791
|
+
broken down by retention period.
|
10792
|
+
properties:
|
10793
|
+
indexed_events_count:
|
10794
|
+
description: Total logs indexed with this retention period during a given
|
10795
|
+
hour.
|
10796
|
+
format: int64
|
10797
|
+
type: integer
|
10798
|
+
live_indexed_events_count:
|
10799
|
+
description: Live logs indexed with this retention period during a given
|
10800
|
+
hour.
|
10801
|
+
format: int64
|
10802
|
+
type: integer
|
10803
|
+
rehydrated_indexed_events_count:
|
10804
|
+
description: Rehydrated logs indexed with this retention period during a
|
10805
|
+
given hour.
|
10806
|
+
format: int64
|
10807
|
+
type: integer
|
10808
|
+
retention:
|
10809
|
+
description: The retention period in days or "custom" for all custom retention
|
10810
|
+
usage.
|
10811
|
+
type: string
|
10812
|
+
type: object
|
10813
|
+
UsageLogsByRetentionResponse:
|
10814
|
+
description: Response containing the indexed logs usage broken down by retention
|
10815
|
+
period for an organization during a given hour.
|
10816
|
+
properties:
|
10817
|
+
usage:
|
10818
|
+
description: Get hourly usage for indexed logs by retention period.
|
10819
|
+
items:
|
10820
|
+
$ref: '#/components/schemas/UsageLogsByRetentionHour'
|
10821
|
+
type: array
|
10822
|
+
type: object
|
9666
10823
|
UsageLogsHour:
|
9667
10824
|
description: Hour usage for logs.
|
9668
10825
|
properties:
|
@@ -10025,7 +11182,7 @@ components:
|
|
10025
11182
|
the current date for all organizations.
|
10026
11183
|
format: int64
|
10027
11184
|
type: integer
|
10028
|
-
|
11185
|
+
heroku_host_top99p:
|
10029
11186
|
description: Shows the 99th percentile of all Heroku dynos over all hours
|
10030
11187
|
in the current date for all organizations.
|
10031
11188
|
format: int64
|
@@ -10050,12 +11207,12 @@ components:
|
|
10050
11207
|
current date for all organizations.
|
10051
11208
|
format: int64
|
10052
11209
|
type: integer
|
10053
|
-
|
11210
|
+
iot_device_sum:
|
10054
11211
|
description: Shows the sum of all IoT devices over all hours in the current
|
10055
11212
|
date for all organizations.
|
10056
11213
|
format: int64
|
10057
11214
|
type: integer
|
10058
|
-
|
11215
|
+
iot_device_top99p:
|
10059
11216
|
description: Shows the 99th percentile of all IoT devices over all hours
|
10060
11217
|
in the current date all organizations.
|
10061
11218
|
format: int64
|
@@ -10085,7 +11242,7 @@ components:
|
|
10085
11242
|
all hours in the current date for all organizations.
|
10086
11243
|
format: int64
|
10087
11244
|
type: integer
|
10088
|
-
|
11245
|
+
opentelemetry_host_top99p:
|
10089
11246
|
description: Shows the 99th percentile of all hosts reported by the Datadog
|
10090
11247
|
exporter for the OpenTelemetry Collector over all hours in the current
|
10091
11248
|
date for all organizations.
|
@@ -10131,6 +11288,11 @@ components:
|
|
10131
11288
|
over all hours in the current date for all organizations.
|
10132
11289
|
format: int64
|
10133
11290
|
type: integer
|
11291
|
+
vsphere_host_top99p:
|
11292
|
+
description: Shows the 99th percentile of all vSphere hosts over all hours
|
11293
|
+
in the current date for all organizations.
|
11294
|
+
format: int64
|
11295
|
+
type: integer
|
10134
11296
|
type: object
|
10135
11297
|
UsageSummaryDateOrg:
|
10136
11298
|
description: Global hourly report of all data billed by Datadog for a given
|
@@ -10323,6 +11485,11 @@ components:
|
|
10323
11485
|
over all hours in the current date for the given org.
|
10324
11486
|
format: int64
|
10325
11487
|
type: integer
|
11488
|
+
vsphere_host_top99p:
|
11489
|
+
description: Shows the 99th percentile of all vSphere hosts over all hours
|
11490
|
+
in the current date for the given org.
|
11491
|
+
format: int64
|
11492
|
+
type: integer
|
10326
11493
|
type: object
|
10327
11494
|
UsageSummaryResponse:
|
10328
11495
|
description: Response with hourly report of all data billed by Datadog all organizations.
|
@@ -10467,6 +11634,8 @@ components:
|
|
10467
11634
|
1, 2020).
|
10468
11635
|
format: int64
|
10469
11636
|
type: integer
|
11637
|
+
logs_by_retention:
|
11638
|
+
$ref: '#/components/schemas/LogsByRetention'
|
10470
11639
|
mobile_rum_session_count_agg_sum:
|
10471
11640
|
description: Shows the sum of all mobile RUM Sessions over all hours in
|
10472
11641
|
the current months for all organizations.
|
@@ -10560,6 +11729,11 @@ components:
|
|
10560
11729
|
items:
|
10561
11730
|
$ref: '#/components/schemas/UsageSummaryDate'
|
10562
11731
|
type: array
|
11732
|
+
vsphere_host_top99p_sum:
|
11733
|
+
description: Shows the 99th percentile of all vSphere hosts over all hours
|
11734
|
+
in the current months for all organizations.
|
11735
|
+
format: int64
|
11736
|
+
type: integer
|
10563
11737
|
type: object
|
10564
11738
|
UsageSyntheticsAPIHour:
|
10565
11739
|
description: Number of Synthetics API tests run for each hour for a given organization.
|
@@ -10804,11 +11978,11 @@ components:
|
|
10804
11978
|
$ref: '#/components/schemas/User'
|
10805
11979
|
type: object
|
10806
11980
|
Widget:
|
10807
|
-
description:
|
10808
|
-
|
10809
|
-
|
10810
|
-
|
10811
|
-
`
|
11981
|
+
description: "Information about widget.\n\n**Note**: The `layout` property is\
|
11982
|
+
\ required for widgets in dashboards with `free` `layout_type`.\n For\
|
11983
|
+
\ the **new dashboard layout**, the `layout` property depends on the `reflow_type`\
|
11984
|
+
\ of the dashboard.\n - If `reflow_type` is `fixed`, `layout` is required.\n\
|
11985
|
+
\ - If `reflow_type` is `auto`, `layout` should not be set."
|
10812
11986
|
properties:
|
10813
11987
|
definition:
|
10814
11988
|
$ref: '#/components/schemas/WidgetDefinition'
|
@@ -11073,19 +12247,44 @@ components:
|
|
11073
12247
|
x-enum-varnames:
|
11074
12248
|
- CHECK
|
11075
12249
|
- CLUSTER
|
12250
|
+
WidgetHorizontalAlign:
|
12251
|
+
description: Horizontal alignment.
|
12252
|
+
enum:
|
12253
|
+
- center
|
12254
|
+
- left
|
12255
|
+
- right
|
12256
|
+
type: string
|
12257
|
+
x-enum-varnames:
|
12258
|
+
- CENTER
|
12259
|
+
- LEFT
|
12260
|
+
- RIGHT
|
11076
12261
|
WidgetImageSizing:
|
11077
|
-
description: How to size the image on the widget.
|
12262
|
+
description: 'How to size the image on the widget. The values are based on the
|
12263
|
+
image `object-fit` CSS properties.
|
12264
|
+
|
12265
|
+
**Note**: `zoom`, `fit` and `center` values are deprecated.'
|
11078
12266
|
enum:
|
12267
|
+
- fill
|
12268
|
+
- contain
|
12269
|
+
- cover
|
12270
|
+
- none
|
12271
|
+
- scale-down
|
11079
12272
|
- zoom
|
11080
12273
|
- fit
|
11081
12274
|
- center
|
11082
12275
|
type: string
|
11083
12276
|
x-enum-varnames:
|
12277
|
+
- FILL
|
12278
|
+
- CONTAIN
|
12279
|
+
- COVER
|
12280
|
+
- NONE
|
12281
|
+
- SCALEDOWN
|
11084
12282
|
- ZOOM
|
11085
12283
|
- FIT
|
11086
12284
|
- CENTER
|
11087
12285
|
WidgetLayout:
|
11088
|
-
description: The layout for a widget on a free dashboard
|
12286
|
+
description: The layout for a widget on a `free` or **new dashboard layout**
|
12287
|
+
dashboard.
|
11089
12288
|
properties:
|
11090
12289
|
height:
|
11091
12290
|
description: The height of the widget. Should be a non-negative integer.
|
@@ -11093,6 +12292,13 @@ components:
|
|
11093
12292
|
format: int64
|
11094
12293
|
minimum: 0
|
11095
12294
|
type: integer
|
12295
|
+
is_column_break:
|
12296
|
+
description: 'Whether the widget should be the first one on the second column
|
12297
|
+
in high density or not.
|
12298
|
+
|
12299
|
+
**Note**: Only for the **new dashboard layout** and only one widget in
|
12300
|
+
the dashboard should have this property set to `true`.'
|
12301
|
+
type: boolean
|
11096
12302
|
width:
|
11097
12303
|
description: The width of the widget. Should be a non-negative integer.
|
11098
12304
|
example: 0
|
@@ -11188,12 +12394,20 @@ components:
|
|
11188
12394
|
- PAST_ONE_YEAR
|
11189
12395
|
- ALERT
|
11190
12396
|
WidgetMargin:
|
11191
|
-
description: Size of the margins around the image.
|
12397
|
+
description: 'Size of the margins around the image.
|
12398
|
+
|
12399
|
+
**Note**: `small` and `large` values are deprecated.'
|
11192
12400
|
enum:
|
12401
|
+
- sm
|
12402
|
+
- md
|
12403
|
+
- lg
|
11193
12404
|
- small
|
11194
12405
|
- large
|
11195
12406
|
type: string
|
11196
12407
|
x-enum-varnames:
|
12408
|
+
- SM
|
12409
|
+
- MD
|
12410
|
+
- LG
|
11197
12411
|
- SMALL
|
11198
12412
|
- LARGE
|
11199
12413
|
WidgetMarker:
|
@@ -11202,7 +12416,8 @@ components:
|
|
11202
12416
|
properties:
|
11203
12417
|
display_type:
|
11204
12418
|
description: "Combination of:\n - A severity error, warning, ok, or info\n\
|
11205
|
-
\ - A line type: dashed, solid, or bold\
|
12419
|
+
\ - A line type: dashed, solid, or bold\nIn this case of a Distribution\
|
12420
|
+
\ widget, this can be set to be `x_axis_percentile`.\n"
|
11206
12421
|
example: error dashed
|
11207
12422
|
type: string
|
11208
12423
|
label:
|
@@ -11452,6 +12667,17 @@ components:
|
|
11452
12667
|
- MONTH_TO_DATE
|
11453
12668
|
- PREVIOUS_MONTH
|
11454
12669
|
- GLOBAL_TIME
|
12670
|
+
WidgetVerticalAlign:
|
12671
|
+
description: Vertical alignment.
|
12672
|
+
enum:
|
12673
|
+
- center
|
12674
|
+
- top
|
12675
|
+
- bottom
|
12676
|
+
type: string
|
12677
|
+
x-enum-varnames:
|
12678
|
+
- CENTER
|
12679
|
+
- TOP
|
12680
|
+
- BOTTOM
|
11455
12681
|
WidgetViewMode:
|
11456
12682
|
description: Define how you want the SLO to be displayed.
|
11457
12683
|
enum:
|
@@ -11551,6 +12777,7 @@ paths:
|
|
11551
12777
|
summary: List IP Ranges
|
11552
12778
|
tags:
|
11553
12779
|
- IP Ranges
|
12780
|
+
x-menu-order: 1
|
11554
12781
|
x-undo:
|
11555
12782
|
type: safe
|
11556
12783
|
/api/v1/api_key:
|
@@ -11573,6 +12800,7 @@ paths:
|
|
11573
12800
|
summary: Get all API keys
|
11574
12801
|
tags:
|
11575
12802
|
- Key Management
|
12803
|
+
x-menu-order: 1
|
11576
12804
|
x-undo:
|
11577
12805
|
type: safe
|
11578
12806
|
post:
|
@@ -11607,6 +12835,7 @@ paths:
|
|
11607
12835
|
tags:
|
11608
12836
|
- Key Management
|
11609
12837
|
x-codegen-request-body-name: body
|
12838
|
+
x-menu-order: 2
|
11610
12839
|
x-undo:
|
11611
12840
|
operationId: DeleteAPIKey
|
11612
12841
|
parameters:
|
@@ -11652,6 +12881,7 @@ paths:
|
|
11652
12881
|
summary: Delete an API key
|
11653
12882
|
tags:
|
11654
12883
|
- Key Management
|
12884
|
+
x-menu-order: 5
|
11655
12885
|
x-undo:
|
11656
12886
|
type: idempotent
|
11657
12887
|
get:
|
@@ -11686,6 +12916,7 @@ paths:
|
|
11686
12916
|
summary: Get API key
|
11687
12917
|
tags:
|
11688
12918
|
- Key Management
|
12919
|
+
x-menu-order: 3
|
11689
12920
|
x-undo:
|
11690
12921
|
type: safe
|
11691
12922
|
put:
|
@@ -11733,6 +12964,7 @@ paths:
|
|
11733
12964
|
tags:
|
11734
12965
|
- Key Management
|
11735
12966
|
x-codegen-request-body-name: body
|
12967
|
+
x-menu-order: 4
|
11736
12968
|
x-undo:
|
11737
12969
|
type: idempotent
|
11738
12970
|
/api/v1/application_key:
|
@@ -11755,6 +12987,7 @@ paths:
|
|
11755
12987
|
summary: Get all application keys
|
11756
12988
|
tags:
|
11757
12989
|
- Key Management
|
12990
|
+
x-menu-order: 6
|
11758
12991
|
x-undo:
|
11759
12992
|
type: safe
|
11760
12993
|
post:
|
@@ -11795,6 +13028,7 @@ paths:
|
|
11795
13028
|
tags:
|
11796
13029
|
- Key Management
|
11797
13030
|
x-codegen-request-body-name: body
|
13031
|
+
x-menu-order: 7
|
11798
13032
|
x-undo:
|
11799
13033
|
operationId: DeleteApplicationKey
|
11800
13034
|
parameters:
|
@@ -11834,6 +13068,7 @@ paths:
|
|
11834
13068
|
summary: Delete an application key
|
11835
13069
|
tags:
|
11836
13070
|
- Key Management
|
13071
|
+
x-menu-order: 10
|
11837
13072
|
x-undo:
|
11838
13073
|
type: idempotent
|
11839
13074
|
get:
|
@@ -11868,6 +13103,7 @@ paths:
|
|
11868
13103
|
summary: Get an application key
|
11869
13104
|
tags:
|
11870
13105
|
- Key Management
|
13106
|
+
x-menu-order: 8
|
11871
13107
|
x-undo:
|
11872
13108
|
type: safe
|
11873
13109
|
put:
|
@@ -11921,6 +13157,7 @@ paths:
|
|
11921
13157
|
tags:
|
11922
13158
|
- Key Management
|
11923
13159
|
x-codegen-request-body-name: body
|
13160
|
+
x-menu-order: 9
|
11924
13161
|
x-undo:
|
11925
13162
|
type: idempotent
|
11926
13163
|
/api/v1/check_run:
|
@@ -11974,6 +13211,7 @@ paths:
|
|
11974
13211
|
tags:
|
11975
13212
|
- Service Checks
|
11976
13213
|
x-codegen-request-body-name: body
|
13214
|
+
x-menu-order: 1
|
11977
13215
|
x-undo:
|
11978
13216
|
type: safe
|
11979
13217
|
/api/v1/daily_custom_reports:
|
@@ -12024,6 +13262,7 @@ paths:
|
|
12024
13262
|
summary: Get the list of available daily custom reports
|
12025
13263
|
tags:
|
12026
13264
|
- Usage Metering
|
13265
|
+
x-menu-order: 20
|
12027
13266
|
x-undo:
|
12028
13267
|
type: safe
|
12029
13268
|
x-unstable: '**Note**: This endpoint is in public beta.
|
@@ -12062,6 +13301,7 @@ paths:
|
|
12062
13301
|
summary: Get specified daily custom reports
|
12063
13302
|
tags:
|
12064
13303
|
- Usage Metering
|
13304
|
+
x-menu-order: 21
|
12065
13305
|
x-undo:
|
12066
13306
|
type: safe
|
12067
13307
|
x-unstable: '**Note**: This endpoint is in public beta.
|
@@ -12076,6 +13316,15 @@ paths:
|
|
12076
13316
|
|
12077
13317
|
This query will not return preset dashboards.'
|
12078
13318
|
operationId: ListDashboards
|
13319
|
+
parameters:
|
13320
|
+
- description: 'When `true`, this query only returns shared custom created
|
13321
|
+
|
13322
|
+
or cloned dashboards.'
|
13323
|
+
in: query
|
13324
|
+
name: filter[shared]
|
13325
|
+
required: false
|
13326
|
+
schema:
|
13327
|
+
type: boolean
|
12079
13328
|
responses:
|
12080
13329
|
'200':
|
12081
13330
|
content:
|
@@ -12092,6 +13341,7 @@ paths:
|
|
12092
13341
|
summary: Get all dashboards
|
12093
13342
|
tags:
|
12094
13343
|
- Dashboards
|
13344
|
+
x-menu-order: 2
|
12095
13345
|
x-undo:
|
12096
13346
|
type: safe
|
12097
13347
|
post:
|
@@ -12132,6 +13382,13 @@ paths:
|
|
12132
13382
|
tags:
|
12133
13383
|
- Dashboards
|
12134
13384
|
x-codegen-request-body-name: body
|
13385
|
+
x-given:
|
13386
|
+
dashboard:
|
13387
|
+
parameters:
|
13388
|
+
- file: dashboard_payload.json
|
13389
|
+
name: body
|
13390
|
+
step: there is a valid "dashboard" in the system
|
13391
|
+
x-menu-order: 1
|
12135
13392
|
x-undo:
|
12136
13393
|
operationId: DeleteDashboard
|
12137
13394
|
parameters:
|
@@ -12158,6 +13415,7 @@ paths:
|
|
12158
13415
|
summary: Get all dashboard lists
|
12159
13416
|
tags:
|
12160
13417
|
- Dashboard Lists
|
13418
|
+
x-menu-order: 1
|
12161
13419
|
x-undo:
|
12162
13420
|
type: safe
|
12163
13421
|
post:
|
@@ -12193,6 +13451,7 @@ paths:
|
|
12193
13451
|
tags:
|
12194
13452
|
- Dashboard Lists
|
12195
13453
|
x-codegen-request-body-name: body
|
13454
|
+
x-menu-order: 2
|
12196
13455
|
x-undo:
|
12197
13456
|
operationId: DeleteDashboardList
|
12198
13457
|
parameters:
|
@@ -12233,6 +13492,7 @@ paths:
|
|
12233
13492
|
summary: Delete a dashboard list
|
12234
13493
|
tags:
|
12235
13494
|
- Dashboard Lists
|
13495
|
+
x-menu-order: 5
|
12236
13496
|
x-undo:
|
12237
13497
|
type: idempotent
|
12238
13498
|
get:
|
@@ -12268,6 +13528,7 @@ paths:
|
|
12268
13528
|
summary: Get a dashboard list
|
12269
13529
|
tags:
|
12270
13530
|
- Dashboard Lists
|
13531
|
+
x-menu-order: 3
|
12271
13532
|
x-undo:
|
12272
13533
|
type: safe
|
12273
13534
|
put:
|
@@ -12317,6 +13578,7 @@ paths:
|
|
12317
13578
|
tags:
|
12318
13579
|
- Dashboard Lists
|
12319
13580
|
x-codegen-request-body-name: body
|
13581
|
+
x-menu-order: 4
|
12320
13582
|
x-undo:
|
12321
13583
|
type: idempotent
|
12322
13584
|
/api/v1/dashboard/{dashboard_id}:
|
@@ -12352,6 +13614,7 @@ paths:
|
|
12352
13614
|
summary: Delete a dashboard
|
12353
13615
|
tags:
|
12354
13616
|
- Dashboards
|
13617
|
+
x-menu-order: 3
|
12355
13618
|
x-undo:
|
12356
13619
|
type: idempotent
|
12357
13620
|
get:
|
@@ -12386,6 +13649,7 @@ paths:
|
|
12386
13649
|
summary: Get a dashboard
|
12387
13650
|
tags:
|
12388
13651
|
- Dashboards
|
13652
|
+
x-menu-order: 5
|
12389
13653
|
x-undo:
|
12390
13654
|
type: safe
|
12391
13655
|
put:
|
@@ -12434,6 +13698,7 @@ paths:
|
|
12434
13698
|
tags:
|
12435
13699
|
- Dashboards
|
12436
13700
|
x-codegen-request-body-name: body
|
13701
|
+
x-menu-order: 4
|
12437
13702
|
x-undo:
|
12438
13703
|
type: idempotent
|
12439
13704
|
/api/v1/downtime:
|
@@ -12465,6 +13730,7 @@ paths:
|
|
12465
13730
|
summary: Get all downtimes
|
12466
13731
|
tags:
|
12467
13732
|
- Downtimes
|
13733
|
+
x-menu-order: 1
|
12468
13734
|
x-undo:
|
12469
13735
|
type: safe
|
12470
13736
|
post:
|
@@ -12500,6 +13766,7 @@ paths:
|
|
12500
13766
|
tags:
|
12501
13767
|
- Downtimes
|
12502
13768
|
x-codegen-request-body-name: body
|
13769
|
+
x-menu-order: 2
|
12503
13770
|
x-undo:
|
12504
13771
|
operationId: TODO
|
12505
13772
|
parameters: []
|
@@ -12544,6 +13811,7 @@ paths:
|
|
12544
13811
|
tags:
|
12545
13812
|
- Downtimes
|
12546
13813
|
x-codegen-request-body-name: body
|
13814
|
+
x-menu-order: 3
|
12547
13815
|
x-undo:
|
12548
13816
|
type: idempotent
|
12549
13817
|
/api/v1/downtime/{downtime_id}:
|
@@ -12577,6 +13845,7 @@ paths:
|
|
12577
13845
|
summary: Cancel a downtime
|
12578
13846
|
tags:
|
12579
13847
|
- Downtimes
|
13848
|
+
x-menu-order: 4
|
12580
13849
|
x-undo:
|
12581
13850
|
type: idempotent
|
12582
13851
|
get:
|
@@ -12613,6 +13882,7 @@ paths:
|
|
12613
13882
|
summary: Get a downtime
|
12614
13883
|
tags:
|
12615
13884
|
- Downtimes
|
13885
|
+
x-menu-order: 5
|
12616
13886
|
x-undo:
|
12617
13887
|
type: safe
|
12618
13888
|
put:
|
@@ -12664,6 +13934,7 @@ paths:
|
|
12664
13934
|
tags:
|
12665
13935
|
- Downtimes
|
12666
13936
|
x-codegen-request-body-name: body
|
13937
|
+
x-menu-order: 6
|
12667
13938
|
x-undo:
|
12668
13939
|
type: idempotent
|
12669
13940
|
/api/v1/events:
|
@@ -12674,7 +13945,8 @@ paths:
|
|
12674
13945
|
`,`n` in your output.\n\n- This endpoint returns a maximum of `1000` most\
|
12675
13946
|
\ recent results. To return additional results,\nidentify the last timestamp\
|
12676
13947
|
\ of the last result and set that as the `end` query time to\npaginate the\
|
12677
|
-
\ results.
|
13948
|
+
\ results. You can also use the page parameter to specify which set of `1000`\
|
13949
|
+
\ results to return."
|
12678
13950
|
operationId: ListEvents
|
12679
13951
|
parameters:
|
12680
13952
|
- description: POSIX timestamp.
|
@@ -12716,12 +13988,36 @@ paths:
|
|
12716
13988
|
Otherwise if an event is aggregated to a parent event with a timestamp outside
|
12717
13989
|
of the timeframe,
|
12718
13990
|
|
12719
|
-
it won''t be available in the output.
|
13991
|
+
it won''t be available in the output. Aggregated events with `is_aggregate=true`
|
13992
|
+
in the response will still be returned unless exclude_aggregate is set to
|
13993
|
+
`true.`'
|
12720
13994
|
in: query
|
12721
13995
|
name: unaggregated
|
12722
13996
|
required: false
|
12723
13997
|
schema:
|
12724
13998
|
type: boolean
|
13999
|
+
- description: 'Set `exclude_aggregate` to `true` to only return unaggregated
|
14000
|
+
events where `is_aggregate=false` in the response. If the `exclude_aggregate`
|
14001
|
+
parameter is set to `true`,
|
14002
|
+
|
14003
|
+
then the unaggregated parameter is ignored and will be `true` by default.'
|
14004
|
+
in: query
|
14005
|
+
name: exclude_aggregate
|
14006
|
+
required: false
|
14007
|
+
schema:
|
14008
|
+
type: boolean
|
14009
|
+
- description: 'By default 1000 results are returned per request. Set page to
|
14010
|
+
the number of the page to return with `0` being the first page. The page
|
14011
|
+
parameter can only be used
|
14012
|
+
|
14013
|
+
when either unaggregated or exclude_aggregate is set to `true.`'
|
14014
|
+
in: query
|
14015
|
+
name: page
|
14016
|
+
required: false
|
14017
|
+
schema:
|
14018
|
+
format: int32
|
14019
|
+
maximum: 2147483647
|
14020
|
+
type: integer
|
12725
14021
|
responses:
|
12726
14022
|
'200':
|
12727
14023
|
content:
|
@@ -12744,6 +14040,7 @@ paths:
|
|
12744
14040
|
summary: Query the event stream
|
12745
14041
|
tags:
|
12746
14042
|
- Events
|
14043
|
+
x-menu-order: 1
|
12747
14044
|
x-undo:
|
12748
14045
|
type: safe
|
12749
14046
|
post:
|
@@ -12777,6 +14074,7 @@ paths:
|
|
12777
14074
|
tags:
|
12778
14075
|
- Events
|
12779
14076
|
x-codegen-request-body-name: body
|
14077
|
+
x-menu-order: 1
|
12780
14078
|
x-undo:
|
12781
14079
|
type: safe
|
12782
14080
|
/api/v1/events/{event_id}:
|
@@ -12815,6 +14113,7 @@ paths:
|
|
12815
14113
|
summary: Get an event
|
12816
14114
|
tags:
|
12817
14115
|
- Events
|
14116
|
+
x-menu-order: 2
|
12818
14117
|
x-undo:
|
12819
14118
|
type: safe
|
12820
14119
|
/api/v1/graph/snapshot:
|
@@ -12889,6 +14188,7 @@ paths:
|
|
12889
14188
|
summary: Take graph snapshots
|
12890
14189
|
tags:
|
12891
14190
|
- Snapshots
|
14191
|
+
x-menu-order: 1
|
12892
14192
|
x-undo:
|
12893
14193
|
type: safe
|
12894
14194
|
/api/v1/host/{host_name}/mute:
|
@@ -12932,6 +14232,7 @@ paths:
|
|
12932
14232
|
tags:
|
12933
14233
|
- Hosts
|
12934
14234
|
x-codegen-request-body-name: body
|
14235
|
+
x-menu-order: 3
|
12935
14236
|
x-undo:
|
12936
14237
|
type: safe
|
12937
14238
|
/api/v1/host/{host_name}/unmute:
|
@@ -12968,6 +14269,7 @@ paths:
|
|
12968
14269
|
tags:
|
12969
14270
|
- Hosts
|
12970
14271
|
x-codegen-request-body-name: body
|
14272
|
+
x-menu-order: 4
|
12971
14273
|
x-undo:
|
12972
14274
|
type: safe
|
12973
14275
|
/api/v1/hosts:
|
@@ -13057,6 +14359,7 @@ paths:
|
|
13057
14359
|
summary: Get all hosts for your organization
|
13058
14360
|
tags:
|
13059
14361
|
- Hosts
|
14362
|
+
x-menu-order: 1
|
13060
14363
|
x-undo:
|
13061
14364
|
type: safe
|
13062
14365
|
/api/v1/hosts/totals:
|
@@ -13098,6 +14401,7 @@ paths:
|
|
13098
14401
|
summary: Get the total number of active hosts
|
13099
14402
|
tags:
|
13100
14403
|
- Hosts
|
14404
|
+
x-menu-order: 2
|
13101
14405
|
x-undo:
|
13102
14406
|
type: safe
|
13103
14407
|
/api/v1/integration/aws:
|
@@ -13141,6 +14445,7 @@ paths:
|
|
13141
14445
|
tags:
|
13142
14446
|
- AWS Integration
|
13143
14447
|
x-codegen-request-body-name: body
|
14448
|
+
x-menu-order: 7
|
13144
14449
|
x-undo:
|
13145
14450
|
type: idempotent
|
13146
14451
|
get:
|
@@ -13187,6 +14492,7 @@ paths:
|
|
13187
14492
|
summary: List all AWS integrations
|
13188
14493
|
tags:
|
13189
14494
|
- AWS Integration
|
14495
|
+
x-menu-order: 6
|
13190
14496
|
x-undo:
|
13191
14497
|
type: safe
|
13192
14498
|
post:
|
@@ -13234,6 +14540,7 @@ paths:
|
|
13234
14540
|
tags:
|
13235
14541
|
- AWS Integration
|
13236
14542
|
x-codegen-request-body-name: body
|
14543
|
+
x-menu-order: 8
|
13237
14544
|
x-undo:
|
13238
14545
|
operationId: DeleteAWSAccount
|
13239
14546
|
parameters: []
|
@@ -13300,6 +14607,7 @@ paths:
|
|
13300
14607
|
tags:
|
13301
14608
|
- AWS Integration
|
13302
14609
|
x-codegen-request-body-name: body
|
14610
|
+
x-menu-order: 9
|
13303
14611
|
x-undo:
|
13304
14612
|
type: safe
|
13305
14613
|
/api/v1/integration/aws/available_namespace_rules:
|
@@ -13330,6 +14638,7 @@ paths:
|
|
13330
14638
|
summary: List namespace rules
|
13331
14639
|
tags:
|
13332
14640
|
- AWS Integration
|
14641
|
+
x-menu-order: 5
|
13333
14642
|
x-undo:
|
13334
14643
|
type: safe
|
13335
14644
|
/api/v1/integration/aws/filtering:
|
@@ -13395,6 +14704,7 @@ paths:
|
|
13395
14704
|
tags:
|
13396
14705
|
- AWS Integration
|
13397
14706
|
x-codegen-request-body-name: body
|
14707
|
+
x-menu-order: 3
|
13398
14708
|
x-undo:
|
13399
14709
|
type: idempotent
|
13400
14710
|
get:
|
@@ -13456,6 +14766,7 @@ paths:
|
|
13456
14766
|
summary: Get all AWS tag filters
|
13457
14767
|
tags:
|
13458
14768
|
- AWS Integration
|
14769
|
+
x-menu-order: 1
|
13459
14770
|
x-undo:
|
13460
14771
|
type: safe
|
13461
14772
|
post:
|
@@ -13523,6 +14834,7 @@ paths:
|
|
13523
14834
|
tags:
|
13524
14835
|
- AWS Integration
|
13525
14836
|
x-codegen-request-body-name: body
|
14837
|
+
x-menu-order: 2
|
13526
14838
|
x-undo:
|
13527
14839
|
operationId: DeleteAWSTagFilter
|
13528
14840
|
parameters: []
|
@@ -13566,6 +14878,7 @@ paths:
|
|
13566
14878
|
tags:
|
13567
14879
|
- AWS Integration
|
13568
14880
|
x-codegen-request-body-name: body
|
14881
|
+
x-menu-order: 4
|
13569
14882
|
x-undo:
|
13570
14883
|
type: idempotent
|
13571
14884
|
/api/v1/integration/aws/logs:
|
@@ -13603,6 +14916,7 @@ paths:
|
|
13603
14916
|
tags:
|
13604
14917
|
- AWS Logs Integration
|
13605
14918
|
x-codegen-request-body-name: body
|
14919
|
+
x-menu-order: 3
|
13606
14920
|
x-undo:
|
13607
14921
|
type: idempotent
|
13608
14922
|
get:
|
@@ -13643,6 +14957,7 @@ paths:
|
|
13643
14957
|
summary: List all AWS Logs integrations
|
13644
14958
|
tags:
|
13645
14959
|
- AWS Logs Integration
|
14960
|
+
x-menu-order: 1
|
13646
14961
|
x-undo:
|
13647
14962
|
type: safe
|
13648
14963
|
post:
|
@@ -13679,6 +14994,7 @@ paths:
|
|
13679
14994
|
tags:
|
13680
14995
|
- AWS Logs Integration
|
13681
14996
|
x-codegen-request-body-name: body
|
14997
|
+
x-menu-order: 2
|
13682
14998
|
x-undo:
|
13683
14999
|
operationId: DeleteAWSLambdaARN
|
13684
15000
|
parameters: []
|
@@ -13733,6 +15049,7 @@ paths:
|
|
13733
15049
|
tags:
|
13734
15050
|
- AWS Logs Integration
|
13735
15051
|
x-codegen-request-body-name: body
|
15052
|
+
x-menu-order: 7
|
13736
15053
|
x-undo:
|
13737
15054
|
type: safe
|
13738
15055
|
/api/v1/integration/aws/logs/services:
|
@@ -13772,6 +15089,7 @@ paths:
|
|
13772
15089
|
summary: Get list of AWS log ready services
|
13773
15090
|
tags:
|
13774
15091
|
- AWS Logs Integration
|
15092
|
+
x-menu-order: 4
|
13775
15093
|
x-undo:
|
13776
15094
|
type: safe
|
13777
15095
|
post:
|
@@ -13808,6 +15126,7 @@ paths:
|
|
13808
15126
|
tags:
|
13809
15127
|
- AWS Logs Integration
|
13810
15128
|
x-codegen-request-body-name: body
|
15129
|
+
x-menu-order: 5
|
13811
15130
|
x-undo:
|
13812
15131
|
operationId: TODO
|
13813
15132
|
type: unsafe
|
@@ -13852,6 +15171,7 @@ paths:
|
|
13852
15171
|
tags:
|
13853
15172
|
- AWS Logs Integration
|
13854
15173
|
x-codegen-request-body-name: body
|
15174
|
+
x-menu-order: 6
|
13855
15175
|
x-undo:
|
13856
15176
|
type: safe
|
13857
15177
|
/api/v1/integration/azure:
|
@@ -13889,6 +15209,7 @@ paths:
|
|
13889
15209
|
tags:
|
13890
15210
|
- Azure Integration
|
13891
15211
|
x-codegen-request-body-name: body
|
15212
|
+
x-menu-order: 3
|
13892
15213
|
x-undo:
|
13893
15214
|
type: idempotent
|
13894
15215
|
get:
|
@@ -13917,6 +15238,7 @@ paths:
|
|
13917
15238
|
summary: List all Azure integrations
|
13918
15239
|
tags:
|
13919
15240
|
- Azure Integration
|
15241
|
+
x-menu-order: 1
|
13920
15242
|
x-undo:
|
13921
15243
|
type: safe
|
13922
15244
|
post:
|
@@ -13966,6 +15288,7 @@ paths:
|
|
13966
15288
|
tags:
|
13967
15289
|
- Azure Integration
|
13968
15290
|
x-codegen-request-body-name: body
|
15291
|
+
x-menu-order: 2
|
13969
15292
|
x-undo:
|
13970
15293
|
operationId: DeleteAzureIntegration
|
13971
15294
|
parameters: []
|
@@ -14011,6 +15334,7 @@ paths:
|
|
14011
15334
|
tags:
|
14012
15335
|
- Azure Integration
|
14013
15336
|
x-codegen-request-body-name: body
|
15337
|
+
x-menu-order: 4
|
14014
15338
|
x-undo:
|
14015
15339
|
type: idempotent
|
14016
15340
|
/api/v1/integration/azure/host_filters:
|
@@ -14049,6 +15373,7 @@ paths:
|
|
14049
15373
|
tags:
|
14050
15374
|
- Azure Integration
|
14051
15375
|
x-codegen-request-body-name: body
|
15376
|
+
x-menu-order: 5
|
14052
15377
|
x-undo:
|
14053
15378
|
type: safe
|
14054
15379
|
/api/v1/integration/gcp:
|
@@ -14086,6 +15411,7 @@ paths:
|
|
14086
15411
|
tags:
|
14087
15412
|
- GCP Integration
|
14088
15413
|
x-codegen-request-body-name: body
|
15414
|
+
x-menu-order: 3
|
14089
15415
|
x-undo:
|
14090
15416
|
type: idempotent
|
14091
15417
|
get:
|
@@ -14113,6 +15439,7 @@ paths:
|
|
14113
15439
|
summary: List all GCP integrations
|
14114
15440
|
tags:
|
14115
15441
|
- GCP Integration
|
15442
|
+
x-menu-order: 1
|
14116
15443
|
x-undo:
|
14117
15444
|
type: safe
|
14118
15445
|
post:
|
@@ -14149,6 +15476,7 @@ paths:
|
|
14149
15476
|
tags:
|
14150
15477
|
- GCP Integration
|
14151
15478
|
x-codegen-request-body-name: body
|
15479
|
+
x-menu-order: 2
|
14152
15480
|
x-undo:
|
14153
15481
|
operationId: DeleteGCPIntegration
|
14154
15482
|
parameters: []
|
@@ -14194,6 +15522,7 @@ paths:
|
|
14194
15522
|
tags:
|
14195
15523
|
- GCP Integration
|
14196
15524
|
x-codegen-request-body-name: body
|
15525
|
+
x-menu-order: 4
|
14197
15526
|
x-undo:
|
14198
15527
|
type: idempotent
|
14199
15528
|
/api/v1/integration/pagerduty/configuration/services:
|
@@ -14230,6 +15559,7 @@ paths:
|
|
14230
15559
|
tags:
|
14231
15560
|
- PagerDuty Integration
|
14232
15561
|
x-codegen-request-body-name: body
|
15562
|
+
x-menu-order: 1
|
14233
15563
|
x-undo:
|
14234
15564
|
operationId: DeletePagerDutyIntegrationService
|
14235
15565
|
parameters:
|
@@ -14265,6 +15595,7 @@ paths:
|
|
14265
15595
|
summary: Delete a single service object
|
14266
15596
|
tags:
|
14267
15597
|
- PagerDuty Integration
|
15598
|
+
x-menu-order: 4
|
14268
15599
|
x-undo:
|
14269
15600
|
type: idempotent
|
14270
15601
|
get:
|
@@ -14299,6 +15630,7 @@ paths:
|
|
14299
15630
|
summary: Get a single service object
|
14300
15631
|
tags:
|
14301
15632
|
- PagerDuty Integration
|
15633
|
+
x-menu-order: 2
|
14302
15634
|
x-undo:
|
14303
15635
|
type: safe
|
14304
15636
|
put:
|
@@ -14343,6 +15675,7 @@ paths:
|
|
14343
15675
|
tags:
|
14344
15676
|
- PagerDuty Integration
|
14345
15677
|
x-codegen-request-body-name: body
|
15678
|
+
x-menu-order: 3
|
14346
15679
|
x-undo:
|
14347
15680
|
type: idempotent
|
14348
15681
|
/api/v1/integration/slack/configuration/accounts/{account_name}/channels:
|
@@ -14379,6 +15712,7 @@ paths:
|
|
14379
15712
|
summary: Get all channels in a Slack integration
|
14380
15713
|
tags:
|
14381
15714
|
- Slack Integration
|
15715
|
+
x-menu-order: 1
|
14382
15716
|
x-undo:
|
14383
15717
|
type: safe
|
14384
15718
|
post:
|
@@ -14422,6 +15756,7 @@ paths:
|
|
14422
15756
|
tags:
|
14423
15757
|
- Slack Integration
|
14424
15758
|
x-codegen-request-body-name: body
|
15759
|
+
x-menu-order: 2
|
14425
15760
|
x-undo:
|
14426
15761
|
type: unsafe
|
14427
15762
|
/api/v1/integration/slack/configuration/accounts/{account_name}/channels/{channel_name}:
|
@@ -14455,6 +15790,7 @@ paths:
|
|
14455
15790
|
summary: Remove a Slack integration channel
|
14456
15791
|
tags:
|
14457
15792
|
- Slack Integration
|
15793
|
+
x-menu-order: 5
|
14458
15794
|
x-undo:
|
14459
15795
|
type: idempotent
|
14460
15796
|
get:
|
@@ -14491,6 +15827,7 @@ paths:
|
|
14491
15827
|
summary: Get a Slack integration channel
|
14492
15828
|
tags:
|
14493
15829
|
- Slack Integration
|
15830
|
+
x-menu-order: 3
|
14494
15831
|
x-undo:
|
14495
15832
|
type: safe
|
14496
15833
|
patch:
|
@@ -14535,6 +15872,7 @@ paths:
|
|
14535
15872
|
tags:
|
14536
15873
|
- Slack Integration
|
14537
15874
|
x-codegen-request-body-name: body
|
15875
|
+
x-menu-order: 4
|
14538
15876
|
x-undo:
|
14539
15877
|
type: idempotent
|
14540
15878
|
/api/v1/logs-queries/list:
|
@@ -14585,6 +15923,7 @@ paths:
|
|
14585
15923
|
tags:
|
14586
15924
|
- Logs
|
14587
15925
|
x-codegen-request-body-name: body
|
15926
|
+
x-menu-order: 1
|
14588
15927
|
x-undo:
|
14589
15928
|
type: safe
|
14590
15929
|
/api/v1/logs/config/index-order:
|
@@ -14608,6 +15947,7 @@ paths:
|
|
14608
15947
|
summary: Get indexes order
|
14609
15948
|
tags:
|
14610
15949
|
- Logs Indexes
|
15950
|
+
x-menu-order: 5
|
14611
15951
|
x-undo:
|
14612
15952
|
type: safe
|
14613
15953
|
put:
|
@@ -14646,6 +15986,7 @@ paths:
|
|
14646
15986
|
tags:
|
14647
15987
|
- Logs Indexes
|
14648
15988
|
x-codegen-request-body-name: body
|
15989
|
+
x-menu-order: 6
|
14649
15990
|
x-undo:
|
14650
15991
|
type: idempotent
|
14651
15992
|
/api/v1/logs/config/indexes:
|
@@ -14670,6 +16011,7 @@ paths:
|
|
14670
16011
|
summary: Get all indexes
|
14671
16012
|
tags:
|
14672
16013
|
- Logs Indexes
|
16014
|
+
x-menu-order: 1
|
14673
16015
|
x-undo:
|
14674
16016
|
type: safe
|
14675
16017
|
post:
|
@@ -14706,6 +16048,7 @@ paths:
|
|
14706
16048
|
tags:
|
14707
16049
|
- Logs Indexes
|
14708
16050
|
x-codegen-request-body-name: body
|
16051
|
+
x-menu-order: 2
|
14709
16052
|
x-undo:
|
14710
16053
|
operationId: TODO
|
14711
16054
|
parameters: []
|
@@ -14744,6 +16087,7 @@ paths:
|
|
14744
16087
|
summary: Get an index
|
14745
16088
|
tags:
|
14746
16089
|
- Logs Indexes
|
16090
|
+
x-menu-order: 3
|
14747
16091
|
x-undo:
|
14748
16092
|
type: safe
|
14749
16093
|
put:
|
@@ -14795,6 +16139,7 @@ paths:
|
|
14795
16139
|
tags:
|
14796
16140
|
- Logs Indexes
|
14797
16141
|
x-codegen-request-body-name: body
|
16142
|
+
x-menu-order: 4
|
14798
16143
|
x-undo:
|
14799
16144
|
type: idempotent
|
14800
16145
|
/api/v1/logs/config/pipeline-order:
|
@@ -14819,6 +16164,7 @@ paths:
|
|
14819
16164
|
summary: Get pipeline order
|
14820
16165
|
tags:
|
14821
16166
|
- Logs Pipelines
|
16167
|
+
x-menu-order: 1
|
14822
16168
|
x-undo:
|
14823
16169
|
type: safe
|
14824
16170
|
put:
|
@@ -14870,6 +16216,7 @@ paths:
|
|
14870
16216
|
tags:
|
14871
16217
|
- Logs Pipelines
|
14872
16218
|
x-codegen-request-body-name: body
|
16219
|
+
x-menu-order: 2
|
14873
16220
|
x-undo:
|
14874
16221
|
type: idempotent
|
14875
16222
|
/api/v1/logs/config/pipelines:
|
@@ -14894,6 +16241,7 @@ paths:
|
|
14894
16241
|
summary: Get all pipelines
|
14895
16242
|
tags:
|
14896
16243
|
- Logs Pipelines
|
16244
|
+
x-menu-order: 3
|
14897
16245
|
x-undo:
|
14898
16246
|
type: safe
|
14899
16247
|
post:
|
@@ -14929,6 +16277,7 @@ paths:
|
|
14929
16277
|
tags:
|
14930
16278
|
- Logs Pipelines
|
14931
16279
|
x-codegen-request-body-name: body
|
16280
|
+
x-menu-order: 4
|
14932
16281
|
x-undo:
|
14933
16282
|
operationId: DeleteLogsPipeline
|
14934
16283
|
parameters:
|
@@ -14966,6 +16315,7 @@ paths:
|
|
14966
16315
|
summary: Delete a pipeline
|
14967
16316
|
tags:
|
14968
16317
|
- Logs Pipelines
|
16318
|
+
x-menu-order: 6
|
14969
16319
|
x-undo:
|
14970
16320
|
type: idempotent
|
14971
16321
|
get:
|
@@ -15002,6 +16352,7 @@ paths:
|
|
15002
16352
|
summary: Get a pipeline
|
15003
16353
|
tags:
|
15004
16354
|
- Logs Pipelines
|
16355
|
+
x-menu-order: 5
|
15005
16356
|
x-undo:
|
15006
16357
|
type: safe
|
15007
16358
|
put:
|
@@ -15047,6 +16398,7 @@ paths:
|
|
15047
16398
|
tags:
|
15048
16399
|
- Logs Pipelines
|
15049
16400
|
x-codegen-request-body-name: body
|
16401
|
+
x-menu-order: 7
|
15050
16402
|
x-undo:
|
15051
16403
|
type: idempotent
|
15052
16404
|
/api/v1/metrics:
|
@@ -15102,6 +16454,7 @@ paths:
|
|
15102
16454
|
summary: Get active metrics list
|
15103
16455
|
tags:
|
15104
16456
|
- Metrics
|
16457
|
+
x-menu-order: 1
|
15105
16458
|
x-undo:
|
15106
16459
|
type: safe
|
15107
16460
|
/api/v1/metrics/{metric_name}:
|
@@ -15137,6 +16490,7 @@ paths:
|
|
15137
16490
|
summary: Get metric metadata
|
15138
16491
|
tags:
|
15139
16492
|
- Metrics
|
16493
|
+
x-menu-order: 2
|
15140
16494
|
x-undo:
|
15141
16495
|
type: safe
|
15142
16496
|
put:
|
@@ -15186,6 +16540,7 @@ paths:
|
|
15186
16540
|
tags:
|
15187
16541
|
- Metrics
|
15188
16542
|
x-codegen-request-body-name: body
|
16543
|
+
x-menu-order: 3
|
15189
16544
|
x-undo:
|
15190
16545
|
type: idempotent
|
15191
16546
|
/api/v1/monitor:
|
@@ -15284,6 +16639,7 @@ paths:
|
|
15284
16639
|
summary: Get all monitor details
|
15285
16640
|
tags:
|
15286
16641
|
- Monitors
|
16642
|
+
x-menu-order: 2
|
15287
16643
|
x-undo:
|
15288
16644
|
type: safe
|
15289
16645
|
post:
|
@@ -15326,6 +16682,8 @@ paths:
|
|
15326
16682
|
|
15327
16683
|
- rum: `rum alert`
|
15328
16684
|
|
16685
|
+
- SLO: `slo alert`
|
16686
|
+
|
15329
16687
|
- watchdog: `event alert`
|
15330
16688
|
|
15331
16689
|
- event-v2: `event-v2 alert`
|
@@ -15530,7 +16888,22 @@ paths:
|
|
15530
16888
|
to filter results by these tags.
|
15531
16889
|
|
15532
16890
|
It is only available via the API and isn''t visible or editable in the Datadog
|
15533
|
-
UI.
|
16891
|
+
UI.
|
16892
|
+
|
16893
|
+
|
16894
|
+
**SLO Alert Query**
|
16895
|
+
|
16896
|
+
|
16897
|
+
Example: `error_budget("slo_id").over("time_window") operator #`
|
16898
|
+
|
16899
|
+
|
16900
|
+
- **`slo_id`**: The alphanumeric SLO ID of the SLO you are configuring the
|
16901
|
+
alert for.
|
16902
|
+
|
16903
|
+
- **`time_window`**: The time window of the SLO target you wish to alert on.
|
16904
|
+
Valid options: `7d`, `30d`, `90d`.
|
16905
|
+
|
16906
|
+
- **`operator`**: `>=` or `>`'
|
15534
16907
|
operationId: CreateMonitor
|
15535
16908
|
requestBody:
|
15536
16909
|
content:
|
@@ -15562,6 +16935,7 @@ paths:
|
|
15562
16935
|
tags:
|
15563
16936
|
- Monitors
|
15564
16937
|
x-codegen-request-body-name: body
|
16938
|
+
x-menu-order: 1
|
15565
16939
|
x-undo:
|
15566
16940
|
operationId: DeleteMonitor
|
15567
16941
|
parameters:
|
@@ -15610,6 +16984,7 @@ paths:
|
|
15610
16984
|
summary: Check if a monitor can be deleted
|
15611
16985
|
tags:
|
15612
16986
|
- Monitors
|
16987
|
+
x-menu-order: 6
|
15613
16988
|
x-undo:
|
15614
16989
|
type: safe
|
15615
16990
|
/api/v1/monitor/validate:
|
@@ -15646,6 +17021,7 @@ paths:
|
|
15646
17021
|
tags:
|
15647
17022
|
- Monitors
|
15648
17023
|
x-codegen-request-body-name: body
|
17024
|
+
x-menu-order: 7
|
15649
17025
|
x-undo:
|
15650
17026
|
type: idempotent
|
15651
17027
|
/api/v1/monitor/{monitor_id}:
|
@@ -15701,6 +17077,7 @@ paths:
|
|
15701
17077
|
summary: Delete a monitor
|
15702
17078
|
tags:
|
15703
17079
|
- Monitors
|
17080
|
+
x-menu-order: 5
|
15704
17081
|
x-undo:
|
15705
17082
|
type: idempotent
|
15706
17083
|
get:
|
@@ -15749,6 +17126,7 @@ paths:
|
|
15749
17126
|
summary: Get a monitor's details
|
15750
17127
|
tags:
|
15751
17128
|
- Monitors
|
17129
|
+
x-menu-order: 4
|
15752
17130
|
x-undo:
|
15753
17131
|
type: safe
|
15754
17132
|
put:
|
@@ -15804,6 +17182,7 @@ paths:
|
|
15804
17182
|
tags:
|
15805
17183
|
- Monitors
|
15806
17184
|
x-codegen-request-body-name: body
|
17185
|
+
x-menu-order: 3
|
15807
17186
|
x-undo:
|
15808
17187
|
type: idempotent
|
15809
17188
|
/api/v1/monitor/{monitor_id}/downtimes:
|
@@ -15838,110 +17217,395 @@ paths:
|
|
15838
17217
|
application/json:
|
15839
17218
|
schema:
|
15840
17219
|
$ref: '#/components/schemas/APIErrorResponse'
|
15841
|
-
description: Monitor Not Found error
|
15842
|
-
summary: Get all downtimes for a monitor
|
17220
|
+
description: Monitor Not Found error
|
17221
|
+
summary: Get all downtimes for a monitor
|
17222
|
+
tags:
|
17223
|
+
- Downtimes
|
17224
|
+
x-codegen-request-body-name: body
|
17225
|
+
x-menu-order: 7
|
17226
|
+
x-undo:
|
17227
|
+
type: safe
|
17228
|
+
/api/v1/monthly_custom_reports:
|
17229
|
+
get:
|
17230
|
+
description: Get monthly custom reports.
|
17231
|
+
operationId: GetMonthlyCustomReports
|
17232
|
+
parameters:
|
17233
|
+
- description: The number of files to return in the response `[default=60].`
|
17234
|
+
in: query
|
17235
|
+
name: page[size]
|
17236
|
+
required: false
|
17237
|
+
schema:
|
17238
|
+
format: int64
|
17239
|
+
type: integer
|
17240
|
+
- description: The identifier of the first page to return. This parameter is
|
17241
|
+
used for the pagination feature `[default=0]`.
|
17242
|
+
in: query
|
17243
|
+
name: page[number]
|
17244
|
+
required: false
|
17245
|
+
schema:
|
17246
|
+
format: int64
|
17247
|
+
type: integer
|
17248
|
+
- description: 'The direction to sort by: `[desc, asc]`.'
|
17249
|
+
in: query
|
17250
|
+
name: sort_dir
|
17251
|
+
required: false
|
17252
|
+
schema:
|
17253
|
+
$ref: '#/components/schemas/UsageSortDirection'
|
17254
|
+
- description: 'The field to sort by: `[computed_on, size, start_date, end_date]`.'
|
17255
|
+
in: query
|
17256
|
+
name: sort
|
17257
|
+
required: false
|
17258
|
+
schema:
|
17259
|
+
$ref: '#/components/schemas/UsageSort'
|
17260
|
+
responses:
|
17261
|
+
'200':
|
17262
|
+
content:
|
17263
|
+
application/json;datetime-format=rfc3339:
|
17264
|
+
schema:
|
17265
|
+
$ref: '#/components/schemas/UsageCustomReportsResponse'
|
17266
|
+
description: OK
|
17267
|
+
'403':
|
17268
|
+
content:
|
17269
|
+
application/json;datetime-format=rfc3339:
|
17270
|
+
schema:
|
17271
|
+
$ref: '#/components/schemas/APIErrorResponse'
|
17272
|
+
description: Forbidden - User is not authorized
|
17273
|
+
summary: Get the list of available monthly custom reports
|
17274
|
+
tags:
|
17275
|
+
- Usage Metering
|
17276
|
+
x-menu-order: 22
|
17277
|
+
x-undo:
|
17278
|
+
type: safe
|
17279
|
+
x-unstable: '**Note**: This endpoint is in public beta.
|
17280
|
+
|
17281
|
+
If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).'
|
17282
|
+
/api/v1/monthly_custom_reports/{report_id}:
|
17283
|
+
get:
|
17284
|
+
description: Get specified monthly custom reports.
|
17285
|
+
operationId: GetSpecifiedMonthlyCustomReports
|
17286
|
+
parameters:
|
17287
|
+
- description: The specified ID to search results for.
|
17288
|
+
in: path
|
17289
|
+
name: report_id
|
17290
|
+
required: true
|
17291
|
+
schema:
|
17292
|
+
type: string
|
17293
|
+
responses:
|
17294
|
+
'200':
|
17295
|
+
content:
|
17296
|
+
application/json;datetime-format=rfc3339:
|
17297
|
+
schema:
|
17298
|
+
$ref: '#/components/schemas/UsageSpecifiedCustomReportsResponse'
|
17299
|
+
description: OK
|
17300
|
+
'400':
|
17301
|
+
content:
|
17302
|
+
application/json;datetime-format=rfc3339:
|
17303
|
+
schema:
|
17304
|
+
$ref: '#/components/schemas/APIErrorResponse'
|
17305
|
+
description: Bad Request
|
17306
|
+
'403':
|
17307
|
+
content:
|
17308
|
+
application/json;datetime-format=rfc3339:
|
17309
|
+
schema:
|
17310
|
+
$ref: '#/components/schemas/APIErrorResponse'
|
17311
|
+
description: Forbidden - User is not authorized
|
17312
|
+
'404':
|
17313
|
+
content:
|
17314
|
+
application/json;datetime-format=rfc3339:
|
17315
|
+
schema:
|
17316
|
+
$ref: '#/components/schemas/APIErrorResponse'
|
17317
|
+
description: Not Found
|
17318
|
+
summary: Get specified monthly custom reports
|
17319
|
+
tags:
|
17320
|
+
- Usage Metering
|
17321
|
+
x-menu-order: 23
|
17322
|
+
x-undo:
|
17323
|
+
type: safe
|
17324
|
+
x-unstable: '**Note**: This endpoint is in public beta.
|
17325
|
+
|
17326
|
+
If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).'
|
17327
|
+
/api/v1/notebooks:
|
17328
|
+
get:
|
17329
|
+
description: 'Get all notebooks. This can also be used to search for notebooks
|
17330
|
+
with a particular `query` in the notebook
|
17331
|
+
|
17332
|
+
`name` or author `handle`.'
|
17333
|
+
operationId: ListNotebooks
|
17334
|
+
parameters:
|
17335
|
+
- description: Return notebooks created by the given `author_handle`.
|
17336
|
+
in: query
|
17337
|
+
name: author_handle
|
17338
|
+
required: false
|
17339
|
+
schema:
|
17340
|
+
example: test@datadoghq.com
|
17341
|
+
type: string
|
17342
|
+
style: form
|
17343
|
+
- description: Return notebooks not created by the given `author_handle`.
|
17344
|
+
in: query
|
17345
|
+
name: exclude_author_handle
|
17346
|
+
required: false
|
17347
|
+
schema:
|
17348
|
+
example: test@datadoghq.com
|
17349
|
+
type: string
|
17350
|
+
style: form
|
17351
|
+
- description: The index of the first notebook you want returned.
|
17352
|
+
in: query
|
17353
|
+
name: start
|
17354
|
+
required: false
|
17355
|
+
schema:
|
17356
|
+
example: 0
|
17357
|
+
format: int64
|
17358
|
+
type: integer
|
17359
|
+
style: form
|
17360
|
+
- description: The number of notebooks to be returned.
|
17361
|
+
in: query
|
17362
|
+
name: count
|
17363
|
+
required: false
|
17364
|
+
schema:
|
17365
|
+
example: 5
|
17366
|
+
format: int64
|
17367
|
+
type: integer
|
17368
|
+
style: form
|
17369
|
+
- description: Sort by field `modified` or `name`.
|
17370
|
+
in: query
|
17371
|
+
name: sort_field
|
17372
|
+
required: false
|
17373
|
+
schema:
|
17374
|
+
default: modified
|
17375
|
+
example: modified
|
17376
|
+
type: string
|
17377
|
+
style: form
|
17378
|
+
- description: Sort by direction `asc` or `desc`.
|
17379
|
+
in: query
|
17380
|
+
name: sort_dir
|
17381
|
+
required: false
|
17382
|
+
schema:
|
17383
|
+
default: desc
|
17384
|
+
example: desc
|
17385
|
+
type: string
|
17386
|
+
style: form
|
17387
|
+
- description: Return only notebooks with `query` string in notebook name or
|
17388
|
+
author handle.
|
17389
|
+
in: query
|
17390
|
+
name: query
|
17391
|
+
required: false
|
17392
|
+
schema:
|
17393
|
+
example: postmortem
|
17394
|
+
type: string
|
17395
|
+
style: form
|
17396
|
+
- description: Value of `false` excludes the `cells` and global `time` for each
|
17397
|
+
notebook.
|
17398
|
+
in: query
|
17399
|
+
name: include_cells
|
17400
|
+
required: false
|
17401
|
+
schema:
|
17402
|
+
default: true
|
17403
|
+
example: false
|
17404
|
+
type: boolean
|
17405
|
+
style: form
|
17406
|
+
responses:
|
17407
|
+
'200':
|
17408
|
+
content:
|
17409
|
+
application/json:
|
17410
|
+
schema:
|
17411
|
+
$ref: '#/components/schemas/NotebooksResponse'
|
17412
|
+
description: OK
|
17413
|
+
'400':
|
17414
|
+
content:
|
17415
|
+
application/json:
|
17416
|
+
schema:
|
17417
|
+
$ref: '#/components/schemas/APIErrorResponse'
|
17418
|
+
description: Bad Request
|
17419
|
+
'403':
|
17420
|
+
content:
|
17421
|
+
application/json:
|
17422
|
+
schema:
|
17423
|
+
$ref: '#/components/schemas/APIErrorResponse'
|
17424
|
+
description: Authentication Error
|
17425
|
+
summary: Get all notebooks
|
17426
|
+
tags:
|
17427
|
+
- Notebooks
|
17428
|
+
x-undo:
|
17429
|
+
type: safe
|
17430
|
+
post:
|
17431
|
+
description: Create a notebook using the specified options.
|
17432
|
+
operationId: CreateNotebook
|
17433
|
+
requestBody:
|
17434
|
+
content:
|
17435
|
+
application/json:
|
17436
|
+
schema:
|
17437
|
+
$ref: '#/components/schemas/NotebookCreateRequest'
|
17438
|
+
description: The JSON description of the notebook you want to create.
|
17439
|
+
required: true
|
17440
|
+
responses:
|
17441
|
+
'200':
|
17442
|
+
content:
|
17443
|
+
application/json:
|
17444
|
+
schema:
|
17445
|
+
$ref: '#/components/schemas/NotebookResponse'
|
17446
|
+
description: OK
|
17447
|
+
'400':
|
17448
|
+
content:
|
17449
|
+
application/json:
|
17450
|
+
schema:
|
17451
|
+
$ref: '#/components/schemas/APIErrorResponse'
|
17452
|
+
description: Bad Request
|
17453
|
+
'403':
|
17454
|
+
content:
|
17455
|
+
application/json:
|
17456
|
+
schema:
|
17457
|
+
$ref: '#/components/schemas/APIErrorResponse'
|
17458
|
+
description: Authentication Error
|
17459
|
+
summary: Create a notebook
|
17460
|
+
tags:
|
17461
|
+
- Notebooks
|
17462
|
+
x-codegen-request-body-name: body
|
17463
|
+
x-given:
|
17464
|
+
notebook:
|
17465
|
+
parameters:
|
17466
|
+
- file: notebook_payload.json
|
17467
|
+
name: body
|
17468
|
+
step: there is a valid "notebook" in the system
|
17469
|
+
x-undo:
|
17470
|
+
operationId: DeleteNotebook
|
17471
|
+
parameters:
|
17472
|
+
- name: notebook_id
|
17473
|
+
source: data.id
|
17474
|
+
type: unsafe
|
17475
|
+
/api/v1/notebooks/{notebook_id}:
|
17476
|
+
delete:
|
17477
|
+
description: Delete a notebook using the specified ID.
|
17478
|
+
operationId: DeleteNotebook
|
17479
|
+
parameters:
|
17480
|
+
- description: Unique ID, assigned when you create the notebook.
|
17481
|
+
in: path
|
17482
|
+
name: notebook_id
|
17483
|
+
required: true
|
17484
|
+
schema:
|
17485
|
+
format: int64
|
17486
|
+
type: integer
|
17487
|
+
responses:
|
17488
|
+
'204':
|
17489
|
+
description: OK
|
17490
|
+
'400':
|
17491
|
+
content:
|
17492
|
+
application/json:
|
17493
|
+
schema:
|
17494
|
+
$ref: '#/components/schemas/APIErrorResponse'
|
17495
|
+
description: Bad Request
|
17496
|
+
'403':
|
17497
|
+
content:
|
17498
|
+
application/json:
|
17499
|
+
schema:
|
17500
|
+
$ref: '#/components/schemas/APIErrorResponse'
|
17501
|
+
description: Authentication Error
|
17502
|
+
'404':
|
17503
|
+
content:
|
17504
|
+
application/json:
|
17505
|
+
schema:
|
17506
|
+
$ref: '#/components/schemas/APIErrorResponse'
|
17507
|
+
description: Not Found
|
17508
|
+
summary: Delete a notebook
|
15843
17509
|
tags:
|
15844
|
-
-
|
15845
|
-
x-codegen-request-body-name: body
|
17510
|
+
- Notebooks
|
15846
17511
|
x-undo:
|
15847
|
-
type:
|
15848
|
-
/api/v1/monthly_custom_reports:
|
17512
|
+
type: idempotent
|
15849
17513
|
get:
|
15850
|
-
description: Get
|
15851
|
-
operationId:
|
17514
|
+
description: Get a notebook using the specified notebook ID.
|
17515
|
+
operationId: GetNotebook
|
15852
17516
|
parameters:
|
15853
|
-
- description:
|
15854
|
-
in:
|
15855
|
-
name:
|
15856
|
-
required:
|
15857
|
-
schema:
|
15858
|
-
format: int64
|
15859
|
-
type: integer
|
15860
|
-
- description: The identifier of the first page to return. This parameter is
|
15861
|
-
used for the pagination feature `[default=0]`.
|
15862
|
-
in: query
|
15863
|
-
name: page[number]
|
15864
|
-
required: false
|
17517
|
+
- description: Unique ID, assigned when you create the notebook.
|
17518
|
+
in: path
|
17519
|
+
name: notebook_id
|
17520
|
+
required: true
|
15865
17521
|
schema:
|
15866
17522
|
format: int64
|
15867
17523
|
type: integer
|
15868
|
-
- description: 'The direction to sort by: `[desc, asc]`.'
|
15869
|
-
in: query
|
15870
|
-
name: sort_dir
|
15871
|
-
required: false
|
15872
|
-
schema:
|
15873
|
-
$ref: '#/components/schemas/UsageSortDirection'
|
15874
|
-
- description: 'The field to sort by: `[computed_on, size, start_date, end_date]`.'
|
15875
|
-
in: query
|
15876
|
-
name: sort
|
15877
|
-
required: false
|
15878
|
-
schema:
|
15879
|
-
$ref: '#/components/schemas/UsageSort'
|
15880
17524
|
responses:
|
15881
17525
|
'200':
|
15882
17526
|
content:
|
15883
|
-
application/json
|
17527
|
+
application/json:
|
15884
17528
|
schema:
|
15885
|
-
$ref: '#/components/schemas/
|
17529
|
+
$ref: '#/components/schemas/NotebookResponse'
|
15886
17530
|
description: OK
|
17531
|
+
'400':
|
17532
|
+
content:
|
17533
|
+
application/json:
|
17534
|
+
schema:
|
17535
|
+
$ref: '#/components/schemas/APIErrorResponse'
|
17536
|
+
description: Bad Request
|
15887
17537
|
'403':
|
15888
17538
|
content:
|
15889
|
-
application/json
|
17539
|
+
application/json:
|
15890
17540
|
schema:
|
15891
17541
|
$ref: '#/components/schemas/APIErrorResponse'
|
15892
|
-
description:
|
15893
|
-
|
17542
|
+
description: Authentication Error
|
17543
|
+
'404':
|
17544
|
+
content:
|
17545
|
+
application/json:
|
17546
|
+
schema:
|
17547
|
+
$ref: '#/components/schemas/APIErrorResponse'
|
17548
|
+
description: Not Found
|
17549
|
+
summary: Get a notebook
|
15894
17550
|
tags:
|
15895
|
-
-
|
17551
|
+
- Notebooks
|
15896
17552
|
x-undo:
|
15897
17553
|
type: safe
|
15898
|
-
|
15899
|
-
|
15900
|
-
|
15901
|
-
/api/v1/monthly_custom_reports/{report_id}:
|
15902
|
-
get:
|
15903
|
-
description: Get specified monthly custom reports.
|
15904
|
-
operationId: GetSpecifiedMonthlyCustomReports
|
17554
|
+
put:
|
17555
|
+
description: Update a notebook using the specified ID.
|
17556
|
+
operationId: UpdateNotebook
|
15905
17557
|
parameters:
|
15906
|
-
- description:
|
17558
|
+
- description: Unique ID, assigned when you create the notebook.
|
15907
17559
|
in: path
|
15908
|
-
name:
|
17560
|
+
name: notebook_id
|
15909
17561
|
required: true
|
15910
17562
|
schema:
|
15911
|
-
|
17563
|
+
format: int64
|
17564
|
+
type: integer
|
17565
|
+
requestBody:
|
17566
|
+
content:
|
17567
|
+
application/json:
|
17568
|
+
schema:
|
17569
|
+
$ref: '#/components/schemas/NotebookUpdateRequest'
|
17570
|
+
description: Update notebook request body.
|
17571
|
+
required: true
|
15912
17572
|
responses:
|
15913
17573
|
'200':
|
15914
17574
|
content:
|
15915
|
-
application/json
|
17575
|
+
application/json:
|
15916
17576
|
schema:
|
15917
|
-
$ref: '#/components/schemas/
|
17577
|
+
$ref: '#/components/schemas/NotebookResponse'
|
15918
17578
|
description: OK
|
15919
17579
|
'400':
|
15920
17580
|
content:
|
15921
|
-
application/json
|
17581
|
+
application/json:
|
15922
17582
|
schema:
|
15923
17583
|
$ref: '#/components/schemas/APIErrorResponse'
|
15924
17584
|
description: Bad Request
|
15925
17585
|
'403':
|
15926
17586
|
content:
|
15927
|
-
application/json
|
17587
|
+
application/json:
|
15928
17588
|
schema:
|
15929
17589
|
$ref: '#/components/schemas/APIErrorResponse'
|
15930
|
-
description:
|
17590
|
+
description: Authentication Error
|
15931
17591
|
'404':
|
15932
17592
|
content:
|
15933
|
-
application/json
|
17593
|
+
application/json:
|
15934
17594
|
schema:
|
15935
17595
|
$ref: '#/components/schemas/APIErrorResponse'
|
15936
17596
|
description: Not Found
|
15937
|
-
|
17597
|
+
'409':
|
17598
|
+
content:
|
17599
|
+
application/json:
|
17600
|
+
schema:
|
17601
|
+
$ref: '#/components/schemas/APIErrorResponse'
|
17602
|
+
description: Conflict
|
17603
|
+
summary: Update a notebook
|
15938
17604
|
tags:
|
15939
|
-
-
|
17605
|
+
- Notebooks
|
17606
|
+
x-codegen-request-body-name: body
|
15940
17607
|
x-undo:
|
15941
|
-
type:
|
15942
|
-
x-unstable: '**Note**: This endpoint is in public beta.
|
15943
|
-
|
15944
|
-
If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).'
|
17608
|
+
type: idempotent
|
15945
17609
|
/api/v1/org:
|
15946
17610
|
get:
|
15947
17611
|
description: List your managed organizations.
|
@@ -15962,6 +17626,7 @@ paths:
|
|
15962
17626
|
summary: List your managed organizations
|
15963
17627
|
tags:
|
15964
17628
|
- Organizations
|
17629
|
+
x-menu-order: 2
|
15965
17630
|
x-undo:
|
15966
17631
|
type: safe
|
15967
17632
|
post:
|
@@ -16013,6 +17678,7 @@ paths:
|
|
16013
17678
|
tags:
|
16014
17679
|
- Organizations
|
16015
17680
|
x-codegen-request-body-name: body
|
17681
|
+
x-menu-order: 1
|
16016
17682
|
x-undo:
|
16017
17683
|
operationId: TODO
|
16018
17684
|
parameters: []
|
@@ -16051,6 +17717,7 @@ paths:
|
|
16051
17717
|
summary: Get organization information
|
16052
17718
|
tags:
|
16053
17719
|
- Organizations
|
17720
|
+
x-menu-order: 3
|
16054
17721
|
x-undo:
|
16055
17722
|
type: safe
|
16056
17723
|
put:
|
@@ -16093,6 +17760,7 @@ paths:
|
|
16093
17760
|
tags:
|
16094
17761
|
- Organizations
|
16095
17762
|
x-codegen-request-body-name: body
|
17763
|
+
x-menu-order: 4
|
16096
17764
|
x-undo:
|
16097
17765
|
type: idempotent
|
16098
17766
|
/api/v1/org/{public_id}/idp_metadata:
|
@@ -16151,6 +17819,7 @@ paths:
|
|
16151
17819
|
tags:
|
16152
17820
|
- Organizations
|
16153
17821
|
x-codegen-request-body-name: body
|
17822
|
+
x-menu-order: 5
|
16154
17823
|
x-undo:
|
16155
17824
|
type: safe
|
16156
17825
|
/api/v1/query:
|
@@ -16200,6 +17869,7 @@ paths:
|
|
16200
17869
|
summary: Query timeseries points
|
16201
17870
|
tags:
|
16202
17871
|
- Metrics
|
17872
|
+
x-menu-order: 5
|
16203
17873
|
x-undo:
|
16204
17874
|
type: safe
|
16205
17875
|
/api/v1/search:
|
@@ -16235,6 +17905,7 @@ paths:
|
|
16235
17905
|
summary: Search metrics
|
16236
17906
|
tags:
|
16237
17907
|
- Metrics
|
17908
|
+
x-menu-order: 4
|
16238
17909
|
x-undo:
|
16239
17910
|
type: safe
|
16240
17911
|
/api/v1/series:
|
@@ -16304,6 +17975,7 @@ paths:
|
|
16304
17975
|
tags:
|
16305
17976
|
- Metrics
|
16306
17977
|
x-codegen-request-body-name: body
|
17978
|
+
x-menu-order: 1
|
16307
17979
|
x-undo:
|
16308
17980
|
type: safe
|
16309
17981
|
/api/v1/slo:
|
@@ -16369,6 +18041,7 @@ paths:
|
|
16369
18041
|
summary: Get all SLOs
|
16370
18042
|
tags:
|
16371
18043
|
- Service Level Objectives
|
18044
|
+
x-menu-order: 2
|
16372
18045
|
x-undo:
|
16373
18046
|
type: safe
|
16374
18047
|
post:
|
@@ -16414,6 +18087,7 @@ paths:
|
|
16414
18087
|
sum:httpservice.hits{code:2xx}.as_count()\",\n \"denominator\": \"\
|
16415
18088
|
sum:httpservice.hits{!code:3xx}.as_count()\"\n }\n}"
|
16416
18089
|
step: there is a valid "slo" in the system
|
18090
|
+
x-menu-order: 1
|
16417
18091
|
x-undo:
|
16418
18092
|
operationId: DeleteSLO
|
16419
18093
|
parameters:
|
@@ -16463,6 +18137,7 @@ paths:
|
|
16463
18137
|
tags:
|
16464
18138
|
- Service Level Objectives
|
16465
18139
|
x-codegen-request-body-name: body
|
18140
|
+
x-menu-order: 8
|
16466
18141
|
x-undo:
|
16467
18142
|
type: idempotent
|
16468
18143
|
/api/v1/slo/can_delete:
|
@@ -16508,6 +18183,7 @@ paths:
|
|
16508
18183
|
summary: Check if SLOs can be safely deleted
|
16509
18184
|
tags:
|
16510
18185
|
- Service Level Objectives
|
18186
|
+
x-menu-order: 7
|
16511
18187
|
x-undo:
|
16512
18188
|
type: safe
|
16513
18189
|
/api/v1/slo/correction:
|
@@ -16530,6 +18206,7 @@ paths:
|
|
16530
18206
|
summary: Get all SLO corrections
|
16531
18207
|
tags:
|
16532
18208
|
- Service Level Objective Corrections
|
18209
|
+
x-menu-order: 2
|
16533
18210
|
x-undo:
|
16534
18211
|
type: safe
|
16535
18212
|
x-unstable: '**Note**: This endpoint is in public beta.
|
@@ -16564,6 +18241,12 @@ paths:
|
|
16564
18241
|
schema:
|
16565
18242
|
$ref: '#/components/schemas/APIErrorResponse'
|
16566
18243
|
description: Forbidden
|
18244
|
+
'404':
|
18245
|
+
content:
|
18246
|
+
application/json:
|
18247
|
+
schema:
|
18248
|
+
$ref: '#/components/schemas/APIErrorResponse'
|
18249
|
+
description: SLO Not Found
|
16567
18250
|
summary: Create an SLO correction
|
16568
18251
|
tags:
|
16569
18252
|
- Service Level Objective Corrections
|
@@ -16572,12 +18255,13 @@ paths:
|
|
16572
18255
|
correction:
|
16573
18256
|
parameters:
|
16574
18257
|
- name: body
|
16575
|
-
value: "{\n \"data\": {\n \"
|
16576
|
-
|
16577
|
-
|
16578
|
-
|
16579
|
-
\
|
18258
|
+
value: "{\n \"data\": {\n \"attributes\": {\n \"slo_id\": \"\
|
18259
|
+
{{ slo.data[0].id }}\",\n \"start\": {{ now_ts }},\n \"end\"\
|
18260
|
+
: {{ hour_later_ts }},\n \"category\": \"Other\",\n \"timezone\"\
|
18261
|
+
: \"UTC\",\n \"description\": \"Test Correction\"\n },\n \
|
18262
|
+
\ \"type\": \"correction\"\n }\n}"
|
16580
18263
|
step: there is a valid "correction" for "slo"
|
18264
|
+
x-menu-order: 1
|
16581
18265
|
x-undo:
|
16582
18266
|
operationId: DeleteSLOCorrection
|
16583
18267
|
parameters:
|
@@ -16616,6 +18300,7 @@ paths:
|
|
16616
18300
|
summary: Delete an SLO correction
|
16617
18301
|
tags:
|
16618
18302
|
- Service Level Objective Corrections
|
18303
|
+
x-menu-order: 5
|
16619
18304
|
x-undo:
|
16620
18305
|
type: idempotent
|
16621
18306
|
x-unstable: '**Note**: This endpoint is in public beta.
|
@@ -16653,6 +18338,7 @@ paths:
|
|
16653
18338
|
summary: Get an SLO correction for an SLO
|
16654
18339
|
tags:
|
16655
18340
|
- Service Level Objective Corrections
|
18341
|
+
x-menu-order: 3
|
16656
18342
|
x-undo:
|
16657
18343
|
type: safe
|
16658
18344
|
x-unstable: '**Note**: This endpoint is in public beta.
|
@@ -16704,6 +18390,7 @@ paths:
|
|
16704
18390
|
tags:
|
16705
18391
|
- Service Level Objective Corrections
|
16706
18392
|
x-codegen-request-body-name: body
|
18393
|
+
x-menu-order: 4
|
16707
18394
|
x-undo:
|
16708
18395
|
type: idempotent
|
16709
18396
|
x-unstable: '**Note**: This endpoint is in public beta.
|
@@ -16760,6 +18447,7 @@ paths:
|
|
16760
18447
|
summary: Delete an SLO
|
16761
18448
|
tags:
|
16762
18449
|
- Service Level Objectives
|
18450
|
+
x-menu-order: 5
|
16763
18451
|
x-undo:
|
16764
18452
|
type: idempotent
|
16765
18453
|
get:
|
@@ -16772,6 +18460,13 @@ paths:
|
|
16772
18460
|
required: true
|
16773
18461
|
schema:
|
16774
18462
|
type: string
|
18463
|
+
- description: Get the IDs of SLO monitors that reference this SLO.
|
18464
|
+
example: true
|
18465
|
+
in: query
|
18466
|
+
name: with_configured_alert_ids
|
18467
|
+
required: false
|
18468
|
+
schema:
|
18469
|
+
type: boolean
|
16775
18470
|
responses:
|
16776
18471
|
'200':
|
16777
18472
|
content:
|
@@ -16794,6 +18489,7 @@ paths:
|
|
16794
18489
|
summary: Get an SLO's details
|
16795
18490
|
tags:
|
16796
18491
|
- Service Level Objectives
|
18492
|
+
x-menu-order: 4
|
16797
18493
|
x-undo:
|
16798
18494
|
type: safe
|
16799
18495
|
put:
|
@@ -16842,6 +18538,7 @@ paths:
|
|
16842
18538
|
tags:
|
16843
18539
|
- Service Level Objectives
|
16844
18540
|
x-codegen-request-body-name: body
|
18541
|
+
x-menu-order: 3
|
16845
18542
|
x-undo:
|
16846
18543
|
type: idempotent
|
16847
18544
|
/api/v1/slo/{slo_id}/history:
|
@@ -16913,6 +18610,7 @@ paths:
|
|
16913
18610
|
summary: Get an SLO's history
|
16914
18611
|
tags:
|
16915
18612
|
- Service Level Objectives
|
18613
|
+
x-menu-order: 6
|
16916
18614
|
x-undo:
|
16917
18615
|
type: safe
|
16918
18616
|
x-unstable: '**Note**: This endpoint is in public beta.
|
@@ -16934,6 +18632,7 @@ paths:
|
|
16934
18632
|
summary: Get all locations (public and private)
|
16935
18633
|
tags:
|
16936
18634
|
- Synthetics
|
18635
|
+
x-menu-order: 22
|
16937
18636
|
x-undo:
|
16938
18637
|
type: safe
|
16939
18638
|
/api/v1/synthetics/private-locations:
|
@@ -16970,6 +18669,7 @@ paths:
|
|
16970
18669
|
tags:
|
16971
18670
|
- Synthetics
|
16972
18671
|
x-codegen-request-body-name: body
|
18672
|
+
x-menu-order: 19
|
16973
18673
|
x-undo:
|
16974
18674
|
operationId: DeletePrivateLocation
|
16975
18675
|
parameters:
|
@@ -17001,6 +18701,7 @@ paths:
|
|
17001
18701
|
summary: Delete a private location
|
17002
18702
|
tags:
|
17003
18703
|
- Synthetics
|
18704
|
+
x-menu-order: 23
|
17004
18705
|
x-undo:
|
17005
18706
|
type: idempotent
|
17006
18707
|
get:
|
@@ -17031,6 +18732,7 @@ paths:
|
|
17031
18732
|
summary: Get a private location
|
17032
18733
|
tags:
|
17033
18734
|
- Synthetics
|
18735
|
+
x-menu-order: 21
|
17034
18736
|
x-undo:
|
17035
18737
|
type: safe
|
17036
18738
|
put:
|
@@ -17069,6 +18771,7 @@ paths:
|
|
17069
18771
|
tags:
|
17070
18772
|
- Synthetics
|
17071
18773
|
x-codegen-request-body-name: body
|
18774
|
+
x-menu-order: 20
|
17072
18775
|
x-undo:
|
17073
18776
|
type: idempotent
|
17074
18777
|
/api/v1/synthetics/tests:
|
@@ -17097,54 +18800,9 @@ paths:
|
|
17097
18800
|
summary: Get the list of all tests
|
17098
18801
|
tags:
|
17099
18802
|
- Synthetics
|
18803
|
+
x-menu-order: 9
|
17100
18804
|
x-undo:
|
17101
18805
|
type: safe
|
17102
|
-
post:
|
17103
|
-
deprecated: true
|
17104
|
-
description: Create a Synthetic test.
|
17105
|
-
operationId: CreateTest
|
17106
|
-
requestBody:
|
17107
|
-
content:
|
17108
|
-
application/json:
|
17109
|
-
schema:
|
17110
|
-
$ref: '#/components/schemas/SyntheticsTestDetails'
|
17111
|
-
description: Details of the test to create.
|
17112
|
-
required: true
|
17113
|
-
responses:
|
17114
|
-
'200':
|
17115
|
-
content:
|
17116
|
-
application/json:
|
17117
|
-
schema:
|
17118
|
-
$ref: '#/components/schemas/SyntheticsTestDetails'
|
17119
|
-
description: OK - Returns the created test details.
|
17120
|
-
'400':
|
17121
|
-
content:
|
17122
|
-
application/json:
|
17123
|
-
schema:
|
17124
|
-
$ref: '#/components/schemas/APIErrorResponse'
|
17125
|
-
description: '- JSON format is wrong
|
17126
|
-
|
17127
|
-
- Creation failed'
|
17128
|
-
'402':
|
17129
|
-
content:
|
17130
|
-
application/json:
|
17131
|
-
schema:
|
17132
|
-
$ref: '#/components/schemas/APIErrorResponse'
|
17133
|
-
description: Test quota is reached
|
17134
|
-
'403':
|
17135
|
-
content:
|
17136
|
-
application/json:
|
17137
|
-
schema:
|
17138
|
-
$ref: '#/components/schemas/APIErrorResponse'
|
17139
|
-
description: Forbidden
|
17140
|
-
summary: Create a test
|
17141
|
-
tags:
|
17142
|
-
- Synthetics
|
17143
|
-
x-codegen-request-body-name: body
|
17144
|
-
x-undo:
|
17145
|
-
operationId: TODO
|
17146
|
-
parameters: []
|
17147
|
-
type: unsafe
|
17148
18806
|
/api/v1/synthetics/tests/api:
|
17149
18807
|
post:
|
17150
18808
|
description: Create a Synthetic API test.
|
@@ -17187,6 +18845,7 @@ paths:
|
|
17187
18845
|
tags:
|
17188
18846
|
- Synthetics
|
17189
18847
|
x-codegen-request-body-name: body
|
18848
|
+
x-menu-order: 1
|
17190
18849
|
x-undo:
|
17191
18850
|
operationId: TODO
|
17192
18851
|
parameters: []
|
@@ -17228,6 +18887,7 @@ paths:
|
|
17228
18887
|
summary: Get an API test
|
17229
18888
|
tags:
|
17230
18889
|
- Synthetics
|
18890
|
+
x-menu-order: 7
|
17231
18891
|
x-undo:
|
17232
18892
|
type: safe
|
17233
18893
|
put:
|
@@ -17282,6 +18942,7 @@ paths:
|
|
17282
18942
|
tags:
|
17283
18943
|
- Synthetics
|
17284
18944
|
x-codegen-request-body-name: body
|
18945
|
+
x-menu-order: 3
|
17285
18946
|
x-undo:
|
17286
18947
|
type: idempotent
|
17287
18948
|
/api/v1/synthetics/tests/browser:
|
@@ -17326,6 +18987,7 @@ paths:
|
|
17326
18987
|
tags:
|
17327
18988
|
- Synthetics
|
17328
18989
|
x-codegen-request-body-name: body
|
18990
|
+
x-menu-order: 2
|
17329
18991
|
x-undo:
|
17330
18992
|
operationId: TODO
|
17331
18993
|
parameters: []
|
@@ -17364,9 +19026,10 @@ paths:
|
|
17364
19026
|
description: '- Synthetic is not activated for the user
|
17365
19027
|
|
17366
19028
|
- Test is not owned by the user'
|
17367
|
-
summary: Get a test
|
19029
|
+
summary: Get a browser test
|
17368
19030
|
tags:
|
17369
19031
|
- Synthetics
|
19032
|
+
x-menu-order: 8
|
17370
19033
|
x-undo:
|
17371
19034
|
type: safe
|
17372
19035
|
put:
|
@@ -17421,6 +19084,7 @@ paths:
|
|
17421
19084
|
tags:
|
17422
19085
|
- Synthetics
|
17423
19086
|
x-codegen-request-body-name: body
|
19087
|
+
x-menu-order: 4
|
17424
19088
|
x-undo:
|
17425
19089
|
type: idempotent
|
17426
19090
|
/api/v1/synthetics/tests/browser/{public_id}/results:
|
@@ -17480,10 +19144,11 @@ paths:
|
|
17480
19144
|
description: '- Synthetic is not activated for the user
|
17481
19145
|
|
17482
19146
|
- Test is not owned by the user'
|
17483
|
-
summary: Get
|
19147
|
+
summary: Get a browser test's latest results summaries
|
17484
19148
|
tags:
|
17485
19149
|
- Synthetics
|
17486
19150
|
x-codegen-request-body-name: body
|
19151
|
+
x-menu-order: 13
|
17487
19152
|
x-undo:
|
17488
19153
|
type: safe
|
17489
19154
|
/api/v1/synthetics/tests/browser/{public_id}/results/{result_id}:
|
@@ -17526,9 +19191,10 @@ paths:
|
|
17526
19191
|
description: '- Synthetic is not activated for the user
|
17527
19192
|
|
17528
19193
|
- Test or result is not owned by the user'
|
17529
|
-
summary: Get a test result
|
19194
|
+
summary: Get a browser test result
|
17530
19195
|
tags:
|
17531
19196
|
- Synthetics
|
19197
|
+
x-menu-order: 11
|
17532
19198
|
x-undo:
|
17533
19199
|
type: safe
|
17534
19200
|
/api/v1/synthetics/tests/delete:
|
@@ -17578,6 +19244,7 @@ paths:
|
|
17578
19244
|
tags:
|
17579
19245
|
- Synthetics
|
17580
19246
|
x-codegen-request-body-name: body
|
19247
|
+
x-menu-order: 14
|
17581
19248
|
x-undo:
|
17582
19249
|
type: idempotent
|
17583
19250
|
/api/v1/synthetics/tests/trigger/ci:
|
@@ -17604,10 +19271,11 @@ paths:
|
|
17604
19271
|
schema:
|
17605
19272
|
$ref: '#/components/schemas/APIErrorResponse'
|
17606
19273
|
description: JSON format is wrong
|
17607
|
-
summary: Trigger
|
19274
|
+
summary: Trigger tests from CI/CD pipelines
|
17608
19275
|
tags:
|
17609
19276
|
- Synthetics
|
17610
19277
|
x-codegen-request-body-name: body
|
19278
|
+
x-menu-order: 6
|
17611
19279
|
x-undo:
|
17612
19280
|
type: idempotent
|
17613
19281
|
/api/v1/synthetics/tests/{public_id}:
|
@@ -17642,66 +19310,12 @@ paths:
|
|
17642
19310
|
description: '- Synthetic is not activated for the user
|
17643
19311
|
|
17644
19312
|
- Test is not owned by the user'
|
17645
|
-
summary: Get a test configuration
|
19313
|
+
summary: Get a test configuration
|
17646
19314
|
tags:
|
17647
19315
|
- Synthetics
|
19316
|
+
x-menu-order: 24
|
17648
19317
|
x-undo:
|
17649
19318
|
type: safe
|
17650
|
-
put:
|
17651
|
-
deprecated: true
|
17652
|
-
description: Edit the configuration of a Synthetic test.
|
17653
|
-
operationId: UpdateTest
|
17654
|
-
parameters:
|
17655
|
-
- description: The public ID of the test to get details from.
|
17656
|
-
in: path
|
17657
|
-
name: public_id
|
17658
|
-
required: true
|
17659
|
-
schema:
|
17660
|
-
type: string
|
17661
|
-
requestBody:
|
17662
|
-
content:
|
17663
|
-
application/json:
|
17664
|
-
schema:
|
17665
|
-
$ref: '#/components/schemas/SyntheticsTestDetails'
|
17666
|
-
description: New test details to be saved.
|
17667
|
-
required: true
|
17668
|
-
responses:
|
17669
|
-
'200':
|
17670
|
-
content:
|
17671
|
-
application/json:
|
17672
|
-
schema:
|
17673
|
-
$ref: '#/components/schemas/SyntheticsTestDetails'
|
17674
|
-
description: OK
|
17675
|
-
'400':
|
17676
|
-
content:
|
17677
|
-
application/json:
|
17678
|
-
schema:
|
17679
|
-
$ref: '#/components/schemas/APIErrorResponse'
|
17680
|
-
description: '- JSON format is wrong
|
17681
|
-
|
17682
|
-
- Updating sub-type is forbidden'
|
17683
|
-
'403':
|
17684
|
-
content:
|
17685
|
-
application/json:
|
17686
|
-
schema:
|
17687
|
-
$ref: '#/components/schemas/APIErrorResponse'
|
17688
|
-
description: Forbidden
|
17689
|
-
'404':
|
17690
|
-
content:
|
17691
|
-
application/json:
|
17692
|
-
schema:
|
17693
|
-
$ref: '#/components/schemas/APIErrorResponse'
|
17694
|
-
description: '- Synthetic is not activated for the user
|
17695
|
-
|
17696
|
-
- Test is not owned by the user
|
17697
|
-
|
17698
|
-
- Test can''t be found'
|
17699
|
-
summary: Edit a test
|
17700
|
-
tags:
|
17701
|
-
- Synthetics
|
17702
|
-
x-codegen-request-body-name: body
|
17703
|
-
x-undo:
|
17704
|
-
type: idempotent
|
17705
19319
|
/api/v1/synthetics/tests/{public_id}/results:
|
17706
19320
|
get:
|
17707
19321
|
description: Get the last 50 test results summaries for a given Synthetics API
|
@@ -17757,10 +19371,11 @@ paths:
|
|
17757
19371
|
description: '- Synthetic is not activated for the user
|
17758
19372
|
|
17759
19373
|
- Test is not owned by the user'
|
17760
|
-
summary: Get
|
19374
|
+
summary: Get an API test's latest results summaries
|
17761
19375
|
tags:
|
17762
19376
|
- Synthetics
|
17763
19377
|
x-codegen-request-body-name: body
|
19378
|
+
x-menu-order: 12
|
17764
19379
|
x-undo:
|
17765
19380
|
type: safe
|
17766
19381
|
/api/v1/synthetics/tests/{public_id}/results/{result_id}:
|
@@ -17801,9 +19416,10 @@ paths:
|
|
17801
19416
|
description: '- Synthetic is not activated for the user
|
17802
19417
|
|
17803
19418
|
- Test or result is not owned by the user'
|
17804
|
-
summary: Get
|
19419
|
+
summary: Get an API test result
|
17805
19420
|
tags:
|
17806
19421
|
- Synthetics
|
19422
|
+
x-menu-order: 10
|
17807
19423
|
x-undo:
|
17808
19424
|
type: safe
|
17809
19425
|
/api/v1/synthetics/tests/{public_id}/status:
|
@@ -17855,6 +19471,7 @@ paths:
|
|
17855
19471
|
tags:
|
17856
19472
|
- Synthetics
|
17857
19473
|
x-codegen-request-body-name: body
|
19474
|
+
x-menu-order: 5
|
17858
19475
|
x-undo:
|
17859
19476
|
type: idempotent
|
17860
19477
|
/api/v1/synthetics/variables:
|
@@ -17891,6 +19508,7 @@ paths:
|
|
17891
19508
|
tags:
|
17892
19509
|
- Synthetics
|
17893
19510
|
x-codegen-request-body-name: body
|
19511
|
+
x-menu-order: 15
|
17894
19512
|
x-undo:
|
17895
19513
|
operationId: DeleteGlobalVariable
|
17896
19514
|
parameters:
|
@@ -17932,6 +19550,7 @@ paths:
|
|
17932
19550
|
summary: Delete a global variable
|
17933
19551
|
tags:
|
17934
19552
|
- Synthetics
|
19553
|
+
x-menu-order: 18
|
17935
19554
|
x-undo:
|
17936
19555
|
type: idempotent
|
17937
19556
|
get:
|
@@ -17966,6 +19585,7 @@ paths:
|
|
17966
19585
|
summary: Get a global variable
|
17967
19586
|
tags:
|
17968
19587
|
- Synthetics
|
19588
|
+
x-menu-order: 17
|
17969
19589
|
x-undo:
|
17970
19590
|
type: safe
|
17971
19591
|
put:
|
@@ -18008,6 +19628,7 @@ paths:
|
|
18008
19628
|
tags:
|
18009
19629
|
- Synthetics
|
18010
19630
|
x-codegen-request-body-name: body
|
19631
|
+
x-menu-order: 16
|
18011
19632
|
x-undo:
|
18012
19633
|
type: idempotent
|
18013
19634
|
/api/v1/tags/hosts:
|
@@ -18044,6 +19665,7 @@ paths:
|
|
18044
19665
|
summary: Get Tags
|
18045
19666
|
tags:
|
18046
19667
|
- Tags
|
19668
|
+
x-menu-order: 1
|
18047
19669
|
x-undo:
|
18048
19670
|
type: safe
|
18049
19671
|
/api/v1/tags/hosts/{host_name}:
|
@@ -18086,6 +19708,7 @@ paths:
|
|
18086
19708
|
summary: Remove host tags
|
18087
19709
|
tags:
|
18088
19710
|
- Tags
|
19711
|
+
x-menu-order: 5
|
18089
19712
|
x-undo:
|
18090
19713
|
type: idempotent
|
18091
19714
|
get:
|
@@ -18127,6 +19750,7 @@ paths:
|
|
18127
19750
|
summary: Get host tags
|
18128
19751
|
tags:
|
18129
19752
|
- Tags
|
19753
|
+
x-menu-order: 2
|
18130
19754
|
x-undo:
|
18131
19755
|
type: safe
|
18132
19756
|
post:
|
@@ -18181,6 +19805,7 @@ paths:
|
|
18181
19805
|
tags:
|
18182
19806
|
- Tags
|
18183
19807
|
x-codegen-request-body-name: body
|
19808
|
+
x-menu-order: 3
|
18184
19809
|
x-undo:
|
18185
19810
|
operationId: DeleteHostTags
|
18186
19811
|
parameters:
|
@@ -18240,6 +19865,7 @@ paths:
|
|
18240
19865
|
tags:
|
18241
19866
|
- Tags
|
18242
19867
|
x-codegen-request-body-name: body
|
19868
|
+
x-menu-order: 4
|
18243
19869
|
x-undo:
|
18244
19870
|
type: idempotent
|
18245
19871
|
/api/v1/usage/analyzed_logs:
|
@@ -18287,6 +19913,7 @@ paths:
|
|
18287
19913
|
summary: Get hourly usage for analyzed logs
|
18288
19914
|
tags:
|
18289
19915
|
- Usage Metering
|
19916
|
+
x-menu-order: 17
|
18290
19917
|
x-undo:
|
18291
19918
|
type: safe
|
18292
19919
|
/api/v1/usage/attribution:
|
@@ -18304,12 +19931,13 @@ paths:
|
|
18304
19931
|
schema:
|
18305
19932
|
format: date-time
|
18306
19933
|
type: string
|
18307
|
-
- description:
|
19934
|
+
- description: Comma-separated list of usage types to return, or `*` for all
|
19935
|
+
usage types.
|
18308
19936
|
in: query
|
18309
19937
|
name: fields
|
18310
19938
|
required: true
|
18311
19939
|
schema:
|
18312
|
-
|
19940
|
+
$ref: '#/components/schemas/UsageAttributionSupportedMetrics'
|
18313
19941
|
- description: 'Datetime in ISO-8601 format, UTC, precise to month: `[YYYY-MM]`
|
18314
19942
|
for usage ending this month.'
|
18315
19943
|
in: query
|
@@ -18346,6 +19974,7 @@ paths:
|
|
18346
19974
|
summary: Get Usage Attribution
|
18347
19975
|
tags:
|
18348
19976
|
- Usage Metering
|
19977
|
+
x-menu-order: 29
|
18349
19978
|
x-undo:
|
18350
19979
|
type: safe
|
18351
19980
|
x-unstable: '**Note**: This endpoint is in public beta.
|
@@ -18394,6 +20023,7 @@ paths:
|
|
18394
20023
|
summary: Get hourly usage for Lambda
|
18395
20024
|
tags:
|
18396
20025
|
- Usage Metering
|
20026
|
+
x-menu-order: 12
|
18397
20027
|
x-undo:
|
18398
20028
|
type: safe
|
18399
20029
|
/api/v1/usage/billable-summary:
|
@@ -18431,6 +20061,7 @@ paths:
|
|
18431
20061
|
summary: Get billable usage across your account
|
18432
20062
|
tags:
|
18433
20063
|
- Usage Metering
|
20064
|
+
x-menu-order: 19
|
18434
20065
|
x-undo:
|
18435
20066
|
type: safe
|
18436
20067
|
/api/v1/usage/compliance-monitoring:
|
@@ -18478,6 +20109,7 @@ paths:
|
|
18478
20109
|
summary: Get hourly usage for Compliance Monitoring
|
18479
20110
|
tags:
|
18480
20111
|
- Usage Metering
|
20112
|
+
x-menu-order: 30
|
18481
20113
|
x-undo:
|
18482
20114
|
type: safe
|
18483
20115
|
/api/v1/usage/fargate:
|
@@ -18523,6 +20155,7 @@ paths:
|
|
18523
20155
|
summary: Get hourly usage for Fargate
|
18524
20156
|
tags:
|
18525
20157
|
- Usage Metering
|
20158
|
+
x-menu-order: 11
|
18526
20159
|
x-undo:
|
18527
20160
|
type: safe
|
18528
20161
|
/api/v1/usage/hosts:
|
@@ -18568,6 +20201,7 @@ paths:
|
|
18568
20201
|
summary: Get hourly usage for hosts and containers
|
18569
20202
|
tags:
|
18570
20203
|
- Usage Metering
|
20204
|
+
x-menu-order: 1
|
18571
20205
|
x-undo:
|
18572
20206
|
type: safe
|
18573
20207
|
/api/v1/usage/incident-management:
|
@@ -18615,6 +20249,7 @@ paths:
|
|
18615
20249
|
summary: Get hourly usage for incident management
|
18616
20250
|
tags:
|
18617
20251
|
- Usage Metering
|
20252
|
+
x-menu-order: 27
|
18618
20253
|
x-undo:
|
18619
20254
|
type: safe
|
18620
20255
|
/api/v1/usage/indexed-spans:
|
@@ -18660,6 +20295,7 @@ paths:
|
|
18660
20295
|
summary: Get hourly usage for indexed spans
|
18661
20296
|
tags:
|
18662
20297
|
- Usage Metering
|
20298
|
+
x-menu-order: 7
|
18663
20299
|
x-undo:
|
18664
20300
|
type: safe
|
18665
20301
|
/api/v1/usage/ingested-spans:
|
@@ -18707,6 +20343,7 @@ paths:
|
|
18707
20343
|
summary: Get hourly usage for ingested spans
|
18708
20344
|
tags:
|
18709
20345
|
- Usage Metering
|
20346
|
+
x-menu-order: 26
|
18710
20347
|
x-undo:
|
18711
20348
|
type: safe
|
18712
20349
|
/api/v1/usage/iot:
|
@@ -18754,6 +20391,7 @@ paths:
|
|
18754
20391
|
summary: Get hourly usage for IoT
|
18755
20392
|
tags:
|
18756
20393
|
- Usage Metering
|
20394
|
+
x-menu-order: 28
|
18757
20395
|
x-undo:
|
18758
20396
|
type: safe
|
18759
20397
|
/api/v1/usage/logs:
|
@@ -18799,6 +20437,54 @@ paths:
|
|
18799
20437
|
summary: Get hourly usage for Logs
|
18800
20438
|
tags:
|
18801
20439
|
- Usage Metering
|
20440
|
+
x-menu-order: 2
|
20441
|
+
x-undo:
|
20442
|
+
type: safe
|
20443
|
+
/api/v1/usage/logs-by-retention:
|
20444
|
+
get:
|
20445
|
+
description: Get hourly usage for indexed logs by retention period.
|
20446
|
+
operationId: GetUsageLogsByRetention
|
20447
|
+
parameters:
|
20448
|
+
- description: 'Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]`
|
20449
|
+
for usage beginning at this hour.'
|
20450
|
+
in: query
|
20451
|
+
name: start_hr
|
20452
|
+
required: true
|
20453
|
+
schema:
|
20454
|
+
format: date-time
|
20455
|
+
type: string
|
20456
|
+
- description: 'Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]`
|
20457
|
+
for usage ending
|
20458
|
+
|
20459
|
+
**before** this hour.'
|
20460
|
+
in: query
|
20461
|
+
name: end_hr
|
20462
|
+
required: false
|
20463
|
+
schema:
|
20464
|
+
format: date-time
|
20465
|
+
type: string
|
20466
|
+
responses:
|
20467
|
+
'200':
|
20468
|
+
content:
|
20469
|
+
application/json;datetime-format=rfc3339:
|
20470
|
+
schema:
|
20471
|
+
$ref: '#/components/schemas/UsageLogsByRetentionResponse'
|
20472
|
+
description: OK
|
20473
|
+
'400':
|
20474
|
+
content:
|
20475
|
+
application/json;datetime-format=rfc3339:
|
20476
|
+
schema:
|
20477
|
+
$ref: '#/components/schemas/APIErrorResponse'
|
20478
|
+
description: Bad Request
|
20479
|
+
'403':
|
20480
|
+
content:
|
20481
|
+
application/json;datetime-format=rfc3339:
|
20482
|
+
schema:
|
20483
|
+
$ref: '#/components/schemas/APIErrorResponse'
|
20484
|
+
description: Forbidden - User is not authorized
|
20485
|
+
summary: Get hourly logs usage by retention
|
20486
|
+
tags:
|
20487
|
+
- Usage Metering
|
18802
20488
|
x-undo:
|
18803
20489
|
type: safe
|
18804
20490
|
/api/v1/usage/logs_by_index:
|
@@ -18852,6 +20538,7 @@ paths:
|
|
18852
20538
|
summary: Get hourly usage for Logs by Index
|
18853
20539
|
tags:
|
18854
20540
|
- Usage Metering
|
20541
|
+
x-menu-order: 3
|
18855
20542
|
x-undo:
|
18856
20543
|
type: safe
|
18857
20544
|
/api/v1/usage/network_flows:
|
@@ -18899,6 +20586,7 @@ paths:
|
|
18899
20586
|
summary: Get hourly usage for Network Flows
|
18900
20587
|
tags:
|
18901
20588
|
- Usage Metering
|
20589
|
+
x-menu-order: 15
|
18902
20590
|
x-undo:
|
18903
20591
|
type: safe
|
18904
20592
|
/api/v1/usage/network_hosts:
|
@@ -18944,6 +20632,7 @@ paths:
|
|
18944
20632
|
summary: Get hourly usage for Network Hosts
|
18945
20633
|
tags:
|
18946
20634
|
- Usage Metering
|
20635
|
+
x-menu-order: 14
|
18947
20636
|
x-undo:
|
18948
20637
|
type: safe
|
18949
20638
|
/api/v1/usage/profiling:
|
@@ -18991,6 +20680,7 @@ paths:
|
|
18991
20680
|
summary: Get hourly usage for profiled hosts
|
18992
20681
|
tags:
|
18993
20682
|
- Usage Metering
|
20683
|
+
x-menu-order: 24
|
18994
20684
|
x-undo:
|
18995
20685
|
type: safe
|
18996
20686
|
/api/v1/usage/rum_sessions:
|
@@ -19043,6 +20733,7 @@ paths:
|
|
19043
20733
|
summary: Get hourly usage for RUM Sessions
|
19044
20734
|
tags:
|
19045
20735
|
- Usage Metering
|
20736
|
+
x-menu-order: 13
|
19046
20737
|
x-undo:
|
19047
20738
|
type: safe
|
19048
20739
|
/api/v1/usage/snmp:
|
@@ -19090,6 +20781,7 @@ paths:
|
|
19090
20781
|
summary: Get hourly usage for SNMP devices
|
19091
20782
|
tags:
|
19092
20783
|
- Usage Metering
|
20784
|
+
x-menu-order: 18
|
19093
20785
|
x-undo:
|
19094
20786
|
type: safe
|
19095
20787
|
/api/v1/usage/summary:
|
@@ -19144,6 +20836,7 @@ paths:
|
|
19144
20836
|
summary: Get usage across your multi-org account
|
19145
20837
|
tags:
|
19146
20838
|
- Usage Metering
|
20839
|
+
x-menu-order: 16
|
19147
20840
|
x-undo:
|
19148
20841
|
type: safe
|
19149
20842
|
/api/v1/usage/synthetics:
|
@@ -19190,6 +20883,7 @@ paths:
|
|
19190
20883
|
summary: Get hourly usage for Synthetics Checks
|
19191
20884
|
tags:
|
19192
20885
|
- Usage Metering
|
20886
|
+
x-menu-order: 8
|
19193
20887
|
x-undo:
|
19194
20888
|
type: safe
|
19195
20889
|
/api/v1/usage/synthetics_api:
|
@@ -19235,6 +20929,7 @@ paths:
|
|
19235
20929
|
summary: Get hourly usage for Synthetics API Checks
|
19236
20930
|
tags:
|
19237
20931
|
- Usage Metering
|
20932
|
+
x-menu-order: 9
|
19238
20933
|
x-undo:
|
19239
20934
|
type: safe
|
19240
20935
|
/api/v1/usage/synthetics_browser:
|
@@ -19280,6 +20975,7 @@ paths:
|
|
19280
20975
|
summary: Get hourly usage for Synthetics Browser Checks
|
19281
20976
|
tags:
|
19282
20977
|
- Usage Metering
|
20978
|
+
x-menu-order: 10
|
19283
20979
|
x-undo:
|
19284
20980
|
type: safe
|
19285
20981
|
/api/v1/usage/timeseries:
|
@@ -19325,6 +21021,7 @@ paths:
|
|
19325
21021
|
summary: Get hourly usage for custom metrics
|
19326
21022
|
tags:
|
19327
21023
|
- Usage Metering
|
21024
|
+
x-menu-order: 4
|
19328
21025
|
x-undo:
|
19329
21026
|
type: safe
|
19330
21027
|
/api/v1/usage/top_avg_metrics:
|
@@ -19392,6 +21089,7 @@ paths:
|
|
19392
21089
|
summary: Get top custom metrics by hourly average
|
19393
21090
|
tags:
|
19394
21091
|
- Usage Metering
|
21092
|
+
x-menu-order: 5
|
19395
21093
|
x-undo:
|
19396
21094
|
type: safe
|
19397
21095
|
/api/v1/usage/traces:
|
@@ -19441,6 +21139,7 @@ paths:
|
|
19441
21139
|
summary: Get hourly usage for Trace Search
|
19442
21140
|
tags:
|
19443
21141
|
- Usage Metering
|
21142
|
+
x-menu-order: 6
|
19444
21143
|
x-undo:
|
19445
21144
|
type: safe
|
19446
21145
|
/api/v1/usage/tracing-without-limits:
|
@@ -19492,6 +21191,7 @@ paths:
|
|
19492
21191
|
summary: Get hourly usage for tracing without limits
|
19493
21192
|
tags:
|
19494
21193
|
- Usage Metering
|
21194
|
+
x-menu-order: 25
|
19495
21195
|
x-undo:
|
19496
21196
|
type: safe
|
19497
21197
|
/api/v1/user:
|
@@ -19514,6 +21214,7 @@ paths:
|
|
19514
21214
|
summary: List all users
|
19515
21215
|
tags:
|
19516
21216
|
- Users
|
21217
|
+
x-menu-order: 2
|
19517
21218
|
x-undo:
|
19518
21219
|
type: safe
|
19519
21220
|
post:
|
@@ -19560,6 +21261,7 @@ paths:
|
|
19560
21261
|
tags:
|
19561
21262
|
- Users
|
19562
21263
|
x-codegen-request-body-name: body
|
21264
|
+
x-menu-order: 1
|
19563
21265
|
x-undo:
|
19564
21266
|
operationId: DisableUser
|
19565
21267
|
parameters:
|
@@ -19612,6 +21314,7 @@ paths:
|
|
19612
21314
|
summary: Disable a user
|
19613
21315
|
tags:
|
19614
21316
|
- Users
|
21317
|
+
x-menu-order: 5
|
19615
21318
|
x-undo:
|
19616
21319
|
type: idempotent
|
19617
21320
|
get:
|
@@ -19648,6 +21351,7 @@ paths:
|
|
19648
21351
|
summary: Get user details
|
19649
21352
|
tags:
|
19650
21353
|
- Users
|
21354
|
+
x-menu-order: 3
|
19651
21355
|
x-undo:
|
19652
21356
|
type: safe
|
19653
21357
|
put:
|
@@ -19701,6 +21405,7 @@ paths:
|
|
19701
21405
|
tags:
|
19702
21406
|
- Users
|
19703
21407
|
x-codegen-request-body-name: body
|
21408
|
+
x-menu-order: 4
|
19704
21409
|
x-undo:
|
19705
21410
|
type: idempotent
|
19706
21411
|
/api/v1/validate:
|
@@ -19726,6 +21431,7 @@ paths:
|
|
19726
21431
|
summary: Validate API key
|
19727
21432
|
tags:
|
19728
21433
|
- Authentication
|
21434
|
+
x-menu-order: 1
|
19729
21435
|
x-undo:
|
19730
21436
|
type: safe
|
19731
21437
|
/v1/input:
|
@@ -19887,6 +21593,7 @@ paths:
|
|
19887
21593
|
tags:
|
19888
21594
|
- Logs
|
19889
21595
|
x-codegen-request-body-name: body
|
21596
|
+
x-menu-order: 1
|
19890
21597
|
x-undo:
|
19891
21598
|
type: safe
|
19892
21599
|
security:
|
@@ -20047,6 +21754,17 @@ tags:
|
|
20047
21754
|
description: Find out more at
|
20048
21755
|
url: https://docs.datadoghq.com/monitors/monitor_types/
|
20049
21756
|
name: Monitors
|
21757
|
+
- description: 'Interact with your notebooks through the API to make it easier to
|
21758
|
+
organize, find, and
|
21759
|
+
|
21760
|
+
share all of your notebooks with your team and organization. For more information,
|
21761
|
+
see the
|
21762
|
+
|
21763
|
+
[Notebooks documentation](https://docs.datadoghq.com/notebooks/).'
|
21764
|
+
externalDocs:
|
21765
|
+
description: For more information, see the Notebooks documentation.
|
21766
|
+
url: https://docs.datadoghq.com/notebooks/
|
21767
|
+
name: Notebooks
|
20050
21768
|
- description: Create, edit, and manage your organizations. Read more about [multi-org
|
20051
21769
|
accounts](https://docs.datadoghq.com/account_management/multi_organization).
|
20052
21770
|
externalDocs:
|