datadog_api_client 1.3.0 → 1.4.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/.apigentools-info +6 -6
- data/.generator/templates/api.mustache +2 -2
- data/.generator/templates/api_client.mustache +7 -0
- data/.generator/templates/api_client_typhoeus_partial.mustache +7 -0
- data/.generator/templates/configuration.mustache +4 -0
- data/.openapi-generator/VERSION +1 -1
- data/CHANGELOG.md +27 -0
- data/README.md +12 -1
- data/data/v1/openapi.yaml +866 -119
- data/data/v2/openapi.yaml +113 -0
- data/docs/v1/AWSAccount.md +6 -0
- data/docs/v1/DowntimeRecurrence.md +1 -1
- data/docs/v1/Event.md +1 -1
- data/docs/v1/FormulaAndFunctionApmDependencyStatName.md +15 -0
- data/docs/v1/FormulaAndFunctionApmDependencyStatsDataSource.md +15 -0
- data/docs/v1/FormulaAndFunctionApmDependencyStatsQueryDefinition.md +36 -0
- data/docs/v1/FormulaAndFunctionApmResourceStatName.md +15 -0
- data/docs/v1/FormulaAndFunctionApmResourceStatsDataSource.md +15 -0
- data/docs/v1/FormulaAndFunctionApmResourceStatsQueryDefinition.md +36 -0
- data/docs/v1/FormulaAndFunctionQueryDefinition.md +5 -1
- data/docs/v1/FunnelQuery.md +22 -0
- data/docs/v1/FunnelRequestType.md +15 -0
- data/docs/v1/FunnelSource.md +15 -0
- data/docs/v1/FunnelWidgetDefinition.md +28 -0
- data/docs/v1/FunnelWidgetDefinitionType.md +15 -0
- data/docs/v1/FunnelWidgetRequest.md +20 -0
- data/docs/v1/LogsAPI.md +1 -1
- data/docs/v1/MetricContentEncoding.md +15 -0
- data/docs/v1/MetricsAPI.md +10 -6
- data/docs/v1/MetricsPayload.md +1 -1
- data/docs/v1/MonitorOptions.md +5 -1
- data/docs/v1/MonitorRenotifyStatusType.md +15 -0
- data/docs/v1/MonitorsAPI.md +9 -9
- data/docs/v1/NotebookCreateDataAttributes.md +2 -0
- data/docs/v1/NotebookMetadata.md +22 -0
- data/docs/v1/NotebookMetadataType.md +15 -0
- data/docs/v1/NotebookResponseDataAttributes.md +2 -0
- data/docs/v1/NotebookUpdateDataAttributes.md +2 -0
- data/docs/v1/NotebooksAPI.md +7 -3
- data/docs/v1/NotebooksResponseDataAttributes.md +2 -0
- data/docs/v1/ProcessQueryDefinition.md +1 -1
- data/docs/v1/README.md +31 -3
- data/docs/v1/SLOCorrection.md +1 -1
- data/docs/v1/SLOCorrectionCreateData.md +1 -1
- data/docs/v1/SLOCorrectionCreateRequestAttributes.md +4 -4
- data/docs/v1/SLOCorrectionListResponse.md +1 -1
- data/docs/v1/SLOCorrectionResponseAttributes.md +4 -4
- data/docs/v1/SLOCorrectionUpdateRequestAttributes.md +3 -3
- data/docs/v1/ScatterPlotWidgetDefinitionRequests.md +4 -2
- data/docs/v1/ScatterplotDimension.md +15 -0
- data/docs/v1/ScatterplotTableRequest.md +22 -0
- data/docs/v1/ScatterplotWidgetFormula.md +22 -0
- data/docs/v1/Series.md +1 -1
- data/docs/v1/ServiceChecksAPI.md +1 -1
- data/docs/v1/ServiceLevelObjectiveCorrectionsAPI.md +11 -11
- data/docs/v1/SyntheticsAPI.md +61 -0
- data/docs/v1/SyntheticsAPIStep.md +1 -1
- data/docs/v1/SyntheticsBatchDetails.md +18 -0
- data/docs/v1/SyntheticsBatchDetailsData.md +22 -0
- data/docs/v1/SyntheticsBatchResult.md +36 -0
- data/docs/v1/SyntheticsBrowserError.md +3 -3
- data/docs/v1/SyntheticsCIBatchMetadata.md +20 -0
- data/docs/v1/{SyntheticsCITestMetadataCi.md → SyntheticsCIBatchMetadataCI.md} +2 -2
- data/docs/v1/SyntheticsCIBatchMetadataGit.md +20 -0
- data/docs/v1/SyntheticsCITest.md +1 -1
- data/docs/v1/SyntheticsStatus.md +15 -0
- data/docs/v1/SyntheticsTestDetails.md +2 -0
- data/docs/v1/SyntheticsTestExecutionRule.md +15 -0
- data/docs/v1/SyntheticsTestRequest.md +2 -0
- data/docs/v1/UsageAttributionValues.md +4 -4
- data/docs/v1/UsageMeteringAPI.md +65 -0
- data/docs/v1/UsageSDSHour.md +22 -0
- data/docs/v1/UsageSDSResponse.md +18 -0
- data/docs/v1/UsageSummaryDate.md +4 -0
- data/docs/v1/UsageSummaryDateOrg.md +6 -2
- data/docs/v1/UsageSummaryResponse.md +6 -2
- data/docs/v1/UsageTimeseriesHour.md +1 -1
- data/docs/v1/WebhooksIntegration.md +1 -1
- data/docs/v1/WebhooksIntegrationUpdateRequest.md +1 -1
- data/docs/v1/WidgetDefinition.md +2 -0
- data/docs/v2/IncidentServicesAPI.md +5 -5
- data/docs/v2/IncidentTeamsAPI.md +5 -5
- data/docs/v2/IncidentsAPI.md +5 -5
- data/docs/v2/README.md +5 -0
- data/docs/v2/SecurityMonitoringAPI.md +5 -5
- data/examples/v1/metrics/SubmitMetrics.rbbeta +14 -0
- data/extract-code-blocks.awk +4 -0
- data/lib/datadog_api_client/v1/api/logs_api.rb +1 -1
- data/lib/datadog_api_client/v1/api/metrics_api.rb +5 -2
- data/lib/datadog_api_client/v1/api/monitors_api.rb +9 -9
- data/lib/datadog_api_client/v1/api/notebooks_api.rb +8 -2
- data/lib/datadog_api_client/v1/api/service_checks_api.rb +1 -1
- data/lib/datadog_api_client/v1/api/service_level_objective_corrections_api.rb +16 -16
- data/lib/datadog_api_client/v1/api/synthetics_api.rb +73 -0
- data/lib/datadog_api_client/v1/api/usage_metering_api.rb +77 -0
- data/lib/datadog_api_client/v1/api_client.rb +14 -0
- data/lib/datadog_api_client/v1/configuration.rb +7 -0
- data/lib/datadog_api_client/v1/models/aws_account.rb +37 -1
- data/lib/datadog_api_client/v1/models/content_encoding.rb +2 -2
- data/lib/datadog_api_client/v1/models/creator.rb +1 -0
- data/lib/datadog_api_client/v1/models/dashboard_summary_definition.rb +1 -0
- data/lib/datadog_api_client/v1/models/downtime_recurrence.rb +1 -1
- data/lib/datadog_api_client/v1/models/event.rb +1 -16
- data/lib/datadog_api_client/v1/models/formula_and_function_apm_dependency_stat_name.rb +44 -0
- data/lib/datadog_api_client/v1/models/formula_and_function_apm_dependency_stats_data_source.rb +38 -0
- data/lib/datadog_api_client/v1/models/formula_and_function_apm_dependency_stats_query_definition.rb +356 -0
- data/lib/datadog_api_client/v1/models/formula_and_function_apm_resource_stat_name.rb +47 -0
- data/lib/datadog_api_client/v1/models/formula_and_function_apm_resource_stats_data_source.rb +38 -0
- data/lib/datadog_api_client/v1/models/formula_and_function_apm_resource_stats_query_definition.rb +348 -0
- data/lib/datadog_api_client/v1/models/formula_and_function_query_definition.rb +2 -0
- data/lib/datadog_api_client/v1/models/funnel_query.rb +271 -0
- data/lib/datadog_api_client/v1/models/funnel_request_type.rb +38 -0
- data/lib/datadog_api_client/v1/models/funnel_source.rb +38 -0
- data/lib/datadog_api_client/v1/models/funnel_widget_definition.rb +322 -0
- data/lib/datadog_api_client/v1/models/funnel_widget_definition_type.rb +38 -0
- data/lib/datadog_api_client/v1/models/funnel_widget_request.rb +251 -0
- data/lib/datadog_api_client/v1/models/metric_content_encoding.rb +38 -0
- data/lib/datadog_api_client/v1/models/metrics_query_metadata.rb +1 -0
- data/lib/datadog_api_client/v1/models/monitor.rb +2 -0
- data/lib/datadog_api_client/v1/models/monitor_options.rb +26 -2
- data/lib/datadog_api_client/v1/models/monitor_renotify_status_type.rb +40 -0
- data/lib/datadog_api_client/v1/models/notebook_author.rb +2 -0
- data/lib/datadog_api_client/v1/models/notebook_create_data_attributes.rb +10 -1
- data/lib/datadog_api_client/v1/models/notebook_metadata.rb +259 -0
- data/lib/datadog_api_client/v1/models/notebook_metadata_type.rb +42 -0
- data/lib/datadog_api_client/v1/models/notebook_response_data_attributes.rb +10 -1
- data/lib/datadog_api_client/v1/models/notebook_update_data_attributes.rb +10 -1
- data/lib/datadog_api_client/v1/models/notebooks_response_data_attributes.rb +10 -1
- data/lib/datadog_api_client/v1/models/notebooks_response_meta.rb +1 -1
- data/lib/datadog_api_client/v1/models/scatter_plot_widget_definition_requests.rb +10 -11
- data/lib/datadog_api_client/v1/models/scatterplot_dimension.rb +41 -0
- data/lib/datadog_api_client/v1/models/scatterplot_table_request.rb +256 -0
- data/lib/datadog_api_client/v1/models/scatterplot_widget_formula.rb +262 -0
- data/lib/datadog_api_client/v1/models/slo_correction.rb +2 -2
- data/lib/datadog_api_client/v1/models/slo_correction_create_data.rb +6 -1
- data/lib/datadog_api_client/v1/models/slo_correction_create_request.rb +1 -1
- data/lib/datadog_api_client/v1/models/slo_correction_create_request_attributes.rb +5 -5
- data/lib/datadog_api_client/v1/models/slo_correction_list_response.rb +2 -2
- data/lib/datadog_api_client/v1/models/slo_correction_response.rb +1 -1
- data/lib/datadog_api_client/v1/models/slo_correction_response_attributes.rb +5 -5
- data/lib/datadog_api_client/v1/models/slo_correction_update_data.rb +1 -1
- data/lib/datadog_api_client/v1/models/slo_correction_update_request.rb +1 -1
- data/lib/datadog_api_client/v1/models/slo_correction_update_request_attributes.rb +4 -4
- data/lib/datadog_api_client/v1/models/synthetics_batch_details.rb +232 -0
- data/lib/datadog_api_client/v1/models/synthetics_batch_details_data.rb +253 -0
- data/lib/datadog_api_client/v1/models/synthetics_batch_result.rb +319 -0
- data/lib/datadog_api_client/v1/models/{synthetics_ci_test_metadata.rb → synthetics_ci_batch_metadata.rb} +6 -6
- data/lib/datadog_api_client/v1/models/{synthetics_ci_test_metadata_ci.rb → synthetics_ci_batch_metadata_ci.rb} +4 -4
- data/lib/datadog_api_client/v1/models/{synthetics_ci_test_metadata_git.rb → synthetics_ci_batch_metadata_git.rb} +5 -5
- data/lib/datadog_api_client/v1/models/synthetics_ci_test.rb +1 -1
- data/lib/datadog_api_client/v1/models/synthetics_status.rb +40 -0
- data/lib/datadog_api_client/v1/models/synthetics_test_details.rb +10 -1
- data/lib/datadog_api_client/v1/models/synthetics_test_execution_rule.rb +40 -0
- data/lib/datadog_api_client/v1/models/synthetics_test_request.rb +11 -1
- data/lib/datadog_api_client/v1/models/usage_attribution_values.rb +13 -13
- data/lib/datadog_api_client/v1/models/usage_sds_hour.rb +253 -0
- data/lib/datadog_api_client/v1/models/usage_sds_response.rb +235 -0
- data/lib/datadog_api_client/v1/models/usage_summary_date.rb +21 -1
- data/lib/datadog_api_client/v1/models/usage_summary_date_org.rb +28 -8
- data/lib/datadog_api_client/v1/models/usage_summary_response.rb +29 -9
- data/lib/datadog_api_client/v1/models/usage_timeseries_hour.rb +1 -1
- data/lib/datadog_api_client/v1/models/webhooks_integration.rb +1 -1
- data/lib/datadog_api_client/v1/models/webhooks_integration_update_request.rb +1 -1
- data/lib/datadog_api_client/v1/models/widget_definition.rb +1 -0
- data/lib/datadog_api_client/v1.rb +29 -3
- data/lib/datadog_api_client/v2/api/incident_services_api.rb +5 -5
- data/lib/datadog_api_client/v2/api/incident_teams_api.rb +5 -5
- data/lib/datadog_api_client/v2/api/incidents_api.rb +5 -5
- data/lib/datadog_api_client/v2/api/security_monitoring_api.rb +5 -5
- data/lib/datadog_api_client/v2/api_client.rb +14 -0
- data/lib/datadog_api_client/v2/configuration.rb +5 -0
- data/lib/datadog_api_client/v2/models/incident_field_attributes_multiple_value.rb +1 -0
- data/lib/datadog_api_client/v2/models/incident_field_attributes_single_value.rb +1 -0
- data/lib/datadog_api_client/v2/models/incident_response_attributes.rb +1 -0
- data/lib/datadog_api_client/v2/models/user_attributes.rb +2 -0
- data/lib/datadog_api_client/version.rb +1 -1
- data/spec/v1/models/formula_and_function_apm_dependency_stat_name_spec.rb +31 -0
- data/spec/v1/models/formula_and_function_apm_dependency_stats_data_source_spec.rb +31 -0
- data/spec/v1/models/formula_and_function_apm_dependency_stats_query_definition_spec.rb +91 -0
- data/spec/v1/models/formula_and_function_apm_resource_stat_name_spec.rb +31 -0
- data/spec/v1/models/formula_and_function_apm_resource_stats_data_source_spec.rb +31 -0
- data/spec/v1/models/formula_and_function_apm_resource_stats_query_definition_spec.rb +91 -0
- data/spec/v1/models/funnel_query_spec.rb +49 -0
- data/spec/v1/models/funnel_request_type_spec.rb +31 -0
- data/spec/v1/models/funnel_source_spec.rb +31 -0
- data/spec/v1/models/funnel_widget_definition_spec.rb +67 -0
- data/spec/v1/models/funnel_widget_definition_type_spec.rb +31 -0
- data/spec/v1/models/funnel_widget_request_spec.rb +43 -0
- data/spec/v1/models/metric_content_encoding_spec.rb +31 -0
- data/spec/v1/models/monitor_renotify_status_type_spec.rb +31 -0
- data/spec/v1/models/notebook_metadata_spec.rb +49 -0
- data/spec/v1/models/notebook_metadata_type_spec.rb +31 -0
- data/spec/v1/models/scatterplot_dimension_spec.rb +31 -0
- data/spec/v1/models/scatterplot_table_request_spec.rb +49 -0
- data/spec/v1/models/scatterplot_widget_formula_spec.rb +49 -0
- data/spec/v1/models/synthetics_batch_details_data_spec.rb +49 -0
- data/spec/v1/models/synthetics_batch_details_spec.rb +37 -0
- data/spec/v1/models/synthetics_batch_result_spec.rb +91 -0
- data/spec/v1/models/{synthetics_ci_test_metadata_ci_spec.rb → synthetics_ci_batch_metadata_ci_spec.rb} +6 -6
- data/spec/v1/models/{synthetics_ci_test_metadata_git_spec.rb → synthetics_ci_batch_metadata_git_spec.rb} +6 -6
- data/spec/v1/models/{synthetics_ci_test_metadata_spec.rb → synthetics_ci_batch_metadata_spec.rb} +6 -6
- data/spec/v1/models/synthetics_status_spec.rb +31 -0
- data/spec/v1/models/synthetics_test_execution_rule_spec.rb +31 -0
- data/spec/v1/models/usage_sds_hour_spec.rb +49 -0
- data/spec/v1/models/usage_sds_response_spec.rb +37 -0
- metadata +119 -14
- data/docs/v1/SyntheticsCITestMetadata.md +0 -20
- data/docs/v1/SyntheticsCITestMetadataGit.md +0 -20
data/data/v1/openapi.yaml
CHANGED
|
@@ -59,6 +59,13 @@ components:
|
|
|
59
59
|
auto_scaling: false
|
|
60
60
|
opswork: false
|
|
61
61
|
type: object
|
|
62
|
+
cspm_resource_collection_enabled:
|
|
63
|
+
default: false
|
|
64
|
+
description: Whether Datadog collects cloud security posture management
|
|
65
|
+
resources from your AWS account. This includes additional resources not
|
|
66
|
+
covered under the general `resource_collection`.
|
|
67
|
+
example: true
|
|
68
|
+
type: boolean
|
|
62
69
|
excluded_regions:
|
|
63
70
|
description: An array of AWS regions to exclude from metrics collection.
|
|
64
71
|
example:
|
|
@@ -99,6 +106,17 @@ components:
|
|
|
99
106
|
description: The list of the the host_tags.
|
|
100
107
|
type: string
|
|
101
108
|
type: array
|
|
109
|
+
metrics_collection_enabled:
|
|
110
|
+
default: true
|
|
111
|
+
description: Whether Datadog collects metrics for this AWS account.
|
|
112
|
+
example: false
|
|
113
|
+
type: boolean
|
|
114
|
+
resource_collection_enabled:
|
|
115
|
+
default: false
|
|
116
|
+
description: Whether Datadog collects a standard set of resources from your
|
|
117
|
+
AWS account.
|
|
118
|
+
example: true
|
|
119
|
+
type: boolean
|
|
102
120
|
role_name:
|
|
103
121
|
description: Your Datadog role delegation name.
|
|
104
122
|
example: DatadogAWSIntegrationRole
|
|
@@ -840,14 +858,14 @@ components:
|
|
|
840
858
|
x-enum-varnames:
|
|
841
859
|
- CHECK_STATUS
|
|
842
860
|
ContentEncoding:
|
|
843
|
-
description: HTTP header used to compress the media-type
|
|
861
|
+
description: HTTP header used to compress the media-type.
|
|
844
862
|
enum:
|
|
845
863
|
- gzip
|
|
846
864
|
- deflate
|
|
847
865
|
type: string
|
|
848
866
|
x-enum-varnames:
|
|
849
|
-
-
|
|
850
|
-
-
|
|
867
|
+
- GZIP
|
|
868
|
+
- DEFLATE
|
|
851
869
|
Creator:
|
|
852
870
|
description: Object describing the creator of the shared element.
|
|
853
871
|
properties:
|
|
@@ -859,6 +877,7 @@ components:
|
|
|
859
877
|
type: string
|
|
860
878
|
name:
|
|
861
879
|
description: Name of the creator.
|
|
880
|
+
nullable: true
|
|
862
881
|
type: string
|
|
863
882
|
readOnly: true
|
|
864
883
|
type: object
|
|
@@ -1005,6 +1024,7 @@ components:
|
|
|
1005
1024
|
enum:
|
|
1006
1025
|
- ordered
|
|
1007
1026
|
- free
|
|
1027
|
+
example: ordered
|
|
1008
1028
|
type: string
|
|
1009
1029
|
x-enum-varnames:
|
|
1010
1030
|
- ORDERED
|
|
@@ -1124,6 +1144,7 @@ components:
|
|
|
1124
1144
|
type: string
|
|
1125
1145
|
description:
|
|
1126
1146
|
description: Description of the dashboard.
|
|
1147
|
+
nullable: true
|
|
1127
1148
|
type: string
|
|
1128
1149
|
id:
|
|
1129
1150
|
description: Dashboard identifier.
|
|
@@ -1631,7 +1652,7 @@ components:
|
|
|
1631
1652
|
**Note**: Attributes specifying the duration in `RRULE` are not supported
|
|
1632
1653
|
(for example, `DTSTART`, `DTEND`, `DURATION`).
|
|
1633
1654
|
|
|
1634
|
-
More examples available in this [downtime guide](https://docs.datadoghq.com/monitors/guide/
|
|
1655
|
+
More examples available in this [downtime guide](https://docs.datadoghq.com/monitors/guide/suppress-alert-with-downtimes/?tab=api)'
|
|
1635
1656
|
example: FREQ=MONTHLY;BYSETPOS=3;BYDAY=WE;INTERVAL=1
|
|
1636
1657
|
type: string
|
|
1637
1658
|
type:
|
|
@@ -1736,10 +1757,8 @@ components:
|
|
|
1736
1757
|
maxLength: 4000
|
|
1737
1758
|
type: string
|
|
1738
1759
|
title:
|
|
1739
|
-
description: The event title.
|
|
1740
|
-
with the Datadog Ruby library.
|
|
1760
|
+
description: The event title.
|
|
1741
1761
|
example: Did you hear the news today?
|
|
1742
|
-
maxLength: 100
|
|
1743
1762
|
type: string
|
|
1744
1763
|
url:
|
|
1745
1764
|
description: URL of the event.
|
|
@@ -2051,6 +2070,170 @@ components:
|
|
|
2051
2070
|
type: string
|
|
2052
2071
|
x-enum-varnames:
|
|
2053
2072
|
- EVENT_TIMELINE
|
|
2073
|
+
FormulaAndFunctionApmDependencyStatName:
|
|
2074
|
+
description: APM statistic.
|
|
2075
|
+
enum:
|
|
2076
|
+
- avg_duration
|
|
2077
|
+
- avg_root_duration
|
|
2078
|
+
- avg_spans_per_trace
|
|
2079
|
+
- error_rate
|
|
2080
|
+
- pct_exec_time
|
|
2081
|
+
- pct_of_traces
|
|
2082
|
+
- total_traces_count
|
|
2083
|
+
example: avg_duration
|
|
2084
|
+
type: string
|
|
2085
|
+
x-enum-varnames:
|
|
2086
|
+
- AVG_DURATION
|
|
2087
|
+
- AVG_ROOT_DURATION
|
|
2088
|
+
- AVG_SPANS_PER_TRACE
|
|
2089
|
+
- ERROR_RATE
|
|
2090
|
+
- PCT_EXEC_TIME
|
|
2091
|
+
- PCT_OF_TRACES
|
|
2092
|
+
- TOTAL_TRACES_COUNT
|
|
2093
|
+
FormulaAndFunctionApmDependencyStatsDataSource:
|
|
2094
|
+
description: Data source for APM dependency stats queries.
|
|
2095
|
+
enum:
|
|
2096
|
+
- apm_dependency_stats
|
|
2097
|
+
example: apm_dependency_stats
|
|
2098
|
+
type: string
|
|
2099
|
+
x-enum-varnames:
|
|
2100
|
+
- APM_DEPENDENCY_STATS
|
|
2101
|
+
FormulaAndFunctionApmDependencyStatsQueryDefinition:
|
|
2102
|
+
description: A formula and functions APM dependency stats query.
|
|
2103
|
+
properties:
|
|
2104
|
+
data_source:
|
|
2105
|
+
$ref: '#/components/schemas/FormulaAndFunctionApmDependencyStatsDataSource'
|
|
2106
|
+
env:
|
|
2107
|
+
description: APM environment.
|
|
2108
|
+
example: staging
|
|
2109
|
+
type: string
|
|
2110
|
+
is_upstream:
|
|
2111
|
+
description: Determines whether stats for upstream or downstream dependencies
|
|
2112
|
+
should be queried.
|
|
2113
|
+
example: false
|
|
2114
|
+
type: boolean
|
|
2115
|
+
name:
|
|
2116
|
+
description: Name of query to use in formulas.
|
|
2117
|
+
example: query_errors
|
|
2118
|
+
type: string
|
|
2119
|
+
operation_name:
|
|
2120
|
+
description: Name of operation on service.
|
|
2121
|
+
example: cassandra.query
|
|
2122
|
+
type: string
|
|
2123
|
+
primary_tag_name:
|
|
2124
|
+
description: The name of the second primary tag used within APM; required
|
|
2125
|
+
when `primary_tag_value` is specified. See https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog.
|
|
2126
|
+
example: datacenter
|
|
2127
|
+
type: string
|
|
2128
|
+
primary_tag_value:
|
|
2129
|
+
description: Filter APM data by the second primary tag. `primary_tag_name`
|
|
2130
|
+
must also be specified.
|
|
2131
|
+
example: staging
|
|
2132
|
+
type: string
|
|
2133
|
+
resource_name:
|
|
2134
|
+
description: APM resource.
|
|
2135
|
+
example: DELETE FROM foo WHERE baz = ?
|
|
2136
|
+
type: string
|
|
2137
|
+
service:
|
|
2138
|
+
description: APM service.
|
|
2139
|
+
example: cassandra
|
|
2140
|
+
type: string
|
|
2141
|
+
stat:
|
|
2142
|
+
$ref: '#/components/schemas/FormulaAndFunctionApmDependencyStatName'
|
|
2143
|
+
required:
|
|
2144
|
+
- data_source
|
|
2145
|
+
- env
|
|
2146
|
+
- stat
|
|
2147
|
+
- operation_name
|
|
2148
|
+
- resource_name
|
|
2149
|
+
- service
|
|
2150
|
+
- name
|
|
2151
|
+
type: object
|
|
2152
|
+
FormulaAndFunctionApmResourceStatName:
|
|
2153
|
+
description: APM resource stat name.
|
|
2154
|
+
enum:
|
|
2155
|
+
- errors
|
|
2156
|
+
- error_rate
|
|
2157
|
+
- hits
|
|
2158
|
+
- latency_avg
|
|
2159
|
+
- latency_max
|
|
2160
|
+
- latency_p50
|
|
2161
|
+
- latency_p75
|
|
2162
|
+
- latency_p90
|
|
2163
|
+
- latency_p95
|
|
2164
|
+
- latency_p99
|
|
2165
|
+
example: hits
|
|
2166
|
+
type: string
|
|
2167
|
+
x-enum-varnames:
|
|
2168
|
+
- ERRORS
|
|
2169
|
+
- ERROR_RATE
|
|
2170
|
+
- HITS
|
|
2171
|
+
- LATENCY_AVG
|
|
2172
|
+
- LATENCY_MAX
|
|
2173
|
+
- LATENCY_P50
|
|
2174
|
+
- LATENCY_P75
|
|
2175
|
+
- LATENCY_P90
|
|
2176
|
+
- LATENCY_P95
|
|
2177
|
+
- LATENCY_P99
|
|
2178
|
+
FormulaAndFunctionApmResourceStatsDataSource:
|
|
2179
|
+
description: Data source for APM resource stats queries.
|
|
2180
|
+
enum:
|
|
2181
|
+
- apm_resource_stats
|
|
2182
|
+
example: apm_resource_stats
|
|
2183
|
+
type: string
|
|
2184
|
+
x-enum-varnames:
|
|
2185
|
+
- APM_RESOURCE_STATS
|
|
2186
|
+
FormulaAndFunctionApmResourceStatsQueryDefinition:
|
|
2187
|
+
description: APM resource stats query using formulas and functions.
|
|
2188
|
+
properties:
|
|
2189
|
+
data_source:
|
|
2190
|
+
$ref: '#/components/schemas/FormulaAndFunctionApmResourceStatsDataSource'
|
|
2191
|
+
env:
|
|
2192
|
+
description: APM environment.
|
|
2193
|
+
example: staging
|
|
2194
|
+
type: string
|
|
2195
|
+
group_by:
|
|
2196
|
+
description: Array of fields to group results by.
|
|
2197
|
+
items:
|
|
2198
|
+
description: Field to group results by.
|
|
2199
|
+
example: resource_name
|
|
2200
|
+
type: string
|
|
2201
|
+
type: array
|
|
2202
|
+
name:
|
|
2203
|
+
description: Name of this query to use in formulas.
|
|
2204
|
+
example: query_errors
|
|
2205
|
+
type: string
|
|
2206
|
+
operation_name:
|
|
2207
|
+
description: Name of operation on service.
|
|
2208
|
+
example: cassandra.query
|
|
2209
|
+
type: string
|
|
2210
|
+
primary_tag_name:
|
|
2211
|
+
description: Name of the second primary tag used within APM. Required when
|
|
2212
|
+
`primary_tag_value` is specified. See https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog
|
|
2213
|
+
example: datacenter
|
|
2214
|
+
type: string
|
|
2215
|
+
primary_tag_value:
|
|
2216
|
+
description: Value of the second primary tag by which to filter APM data.
|
|
2217
|
+
`primary_tag_name` must also be specified.
|
|
2218
|
+
example: us-east-az
|
|
2219
|
+
type: string
|
|
2220
|
+
resource_name:
|
|
2221
|
+
description: APM resource name.
|
|
2222
|
+
example: Admin::ProductsController#create
|
|
2223
|
+
type: string
|
|
2224
|
+
service:
|
|
2225
|
+
description: APM service name.
|
|
2226
|
+
example: web-store
|
|
2227
|
+
type: string
|
|
2228
|
+
stat:
|
|
2229
|
+
$ref: '#/components/schemas/FormulaAndFunctionApmResourceStatName'
|
|
2230
|
+
required:
|
|
2231
|
+
- data_source
|
|
2232
|
+
- env
|
|
2233
|
+
- name
|
|
2234
|
+
- service
|
|
2235
|
+
- stat
|
|
2236
|
+
type: object
|
|
2054
2237
|
FormulaAndFunctionEventAggregation:
|
|
2055
2238
|
description: Aggregation methods for event platform queries.
|
|
2056
2239
|
enum:
|
|
@@ -2247,6 +2430,7 @@ components:
|
|
|
2247
2430
|
enum:
|
|
2248
2431
|
- process
|
|
2249
2432
|
- container
|
|
2433
|
+
example: process
|
|
2250
2434
|
type: string
|
|
2251
2435
|
x-enum-varnames:
|
|
2252
2436
|
- PROCESS
|
|
@@ -2295,12 +2479,15 @@ components:
|
|
|
2295
2479
|
- $ref: '#/components/schemas/FormulaAndFunctionMetricQueryDefinition'
|
|
2296
2480
|
- $ref: '#/components/schemas/FormulaAndFunctionEventQueryDefinition'
|
|
2297
2481
|
- $ref: '#/components/schemas/FormulaAndFunctionProcessQueryDefinition'
|
|
2482
|
+
- $ref: '#/components/schemas/FormulaAndFunctionApmDependencyStatsQueryDefinition'
|
|
2483
|
+
- $ref: '#/components/schemas/FormulaAndFunctionApmResourceStatsQueryDefinition'
|
|
2298
2484
|
type: object
|
|
2299
2485
|
FormulaAndFunctionResponseFormat:
|
|
2300
2486
|
description: Timeseries or Scalar response. **This feature is currently in beta.**
|
|
2301
2487
|
enum:
|
|
2302
2488
|
- timeseries
|
|
2303
2489
|
- scalar
|
|
2490
|
+
example: timeseries
|
|
2304
2491
|
type: string
|
|
2305
2492
|
x-enum-varnames:
|
|
2306
2493
|
- TIMESERIES
|
|
@@ -2337,6 +2524,116 @@ components:
|
|
|
2337
2524
|
type: string
|
|
2338
2525
|
x-enum-varnames:
|
|
2339
2526
|
- FREE_TEXT
|
|
2527
|
+
FunnelQuery:
|
|
2528
|
+
description: Updated funnel widget.
|
|
2529
|
+
properties:
|
|
2530
|
+
data_source:
|
|
2531
|
+
$ref: '#/components/schemas/FunnelSource'
|
|
2532
|
+
query_string:
|
|
2533
|
+
description: The widget query.
|
|
2534
|
+
example: '@browser.name:Chrome'
|
|
2535
|
+
type: string
|
|
2536
|
+
steps:
|
|
2537
|
+
$ref: '#/components/schemas/FunnelSteps'
|
|
2538
|
+
required:
|
|
2539
|
+
- query_string
|
|
2540
|
+
- data_source
|
|
2541
|
+
- steps
|
|
2542
|
+
type: object
|
|
2543
|
+
FunnelRequestType:
|
|
2544
|
+
description: Widget request type.
|
|
2545
|
+
enum:
|
|
2546
|
+
- funnel
|
|
2547
|
+
example: funnel
|
|
2548
|
+
type: string
|
|
2549
|
+
x-enum-varnames:
|
|
2550
|
+
- FUNNEL
|
|
2551
|
+
FunnelSource:
|
|
2552
|
+
default: rum
|
|
2553
|
+
description: Source from which to query items to display in the funnel.
|
|
2554
|
+
enum:
|
|
2555
|
+
- rum
|
|
2556
|
+
example: rum
|
|
2557
|
+
type: string
|
|
2558
|
+
x-enum-varnames:
|
|
2559
|
+
- RUM
|
|
2560
|
+
FunnelSteps:
|
|
2561
|
+
description: List of funnel steps.
|
|
2562
|
+
items:
|
|
2563
|
+
description: The funnel step.
|
|
2564
|
+
properties:
|
|
2565
|
+
facet:
|
|
2566
|
+
description: The facet of the step.
|
|
2567
|
+
example: '@view.name'
|
|
2568
|
+
type: string
|
|
2569
|
+
value:
|
|
2570
|
+
description: The value of the step.
|
|
2571
|
+
example: /apm/home
|
|
2572
|
+
type: string
|
|
2573
|
+
required:
|
|
2574
|
+
- facet
|
|
2575
|
+
- value
|
|
2576
|
+
type: object
|
|
2577
|
+
type: array
|
|
2578
|
+
FunnelWidgetDefinition:
|
|
2579
|
+
description: 'The funnel visualization displays a funnel of user sessions that
|
|
2580
|
+
maps a sequence of view navigation and user interaction in your application.
|
|
2581
|
+
|
|
2582
|
+
'
|
|
2583
|
+
properties:
|
|
2584
|
+
requests:
|
|
2585
|
+
description: Request payload used to query items.
|
|
2586
|
+
example:
|
|
2587
|
+
- request_type: funnel
|
|
2588
|
+
- query:
|
|
2589
|
+
data_source: rum
|
|
2590
|
+
query_string: '@browser.name:Chrome'
|
|
2591
|
+
steps:
|
|
2592
|
+
- facet: '@view.name'
|
|
2593
|
+
value: /logs
|
|
2594
|
+
- facet: '@view.name'
|
|
2595
|
+
value: /apm/home
|
|
2596
|
+
items:
|
|
2597
|
+
$ref: '#/components/schemas/FunnelWidgetRequest'
|
|
2598
|
+
maxItems: 1
|
|
2599
|
+
minItems: 1
|
|
2600
|
+
type: array
|
|
2601
|
+
time:
|
|
2602
|
+
$ref: '#/components/schemas/WidgetTime'
|
|
2603
|
+
title:
|
|
2604
|
+
description: The title of the widget.
|
|
2605
|
+
type: string
|
|
2606
|
+
title_align:
|
|
2607
|
+
$ref: '#/components/schemas/WidgetTextAlign'
|
|
2608
|
+
title_size:
|
|
2609
|
+
description: The size of the title.
|
|
2610
|
+
type: string
|
|
2611
|
+
type:
|
|
2612
|
+
$ref: '#/components/schemas/FunnelWidgetDefinitionType'
|
|
2613
|
+
required:
|
|
2614
|
+
- type
|
|
2615
|
+
- requests
|
|
2616
|
+
type: object
|
|
2617
|
+
FunnelWidgetDefinitionType:
|
|
2618
|
+
default: funnel
|
|
2619
|
+
description: Type of funnel widget.
|
|
2620
|
+
enum:
|
|
2621
|
+
- funnel
|
|
2622
|
+
example: funnel
|
|
2623
|
+
type: string
|
|
2624
|
+
x-enum-varnames:
|
|
2625
|
+
- FUNNEL
|
|
2626
|
+
FunnelWidgetRequest:
|
|
2627
|
+
description: Updated funnel widget.
|
|
2628
|
+
properties:
|
|
2629
|
+
query:
|
|
2630
|
+
$ref: '#/components/schemas/FunnelQuery'
|
|
2631
|
+
request_type:
|
|
2632
|
+
$ref: '#/components/schemas/FunnelRequestType'
|
|
2633
|
+
required:
|
|
2634
|
+
- query
|
|
2635
|
+
- request_type
|
|
2636
|
+
type: object
|
|
2340
2637
|
GCPAccount:
|
|
2341
2638
|
description: Your Google Cloud Platform Account.
|
|
2342
2639
|
properties:
|
|
@@ -3320,6 +3617,7 @@ components:
|
|
|
3320
3617
|
- auto
|
|
3321
3618
|
- compact
|
|
3322
3619
|
- full
|
|
3620
|
+
example: compact
|
|
3323
3621
|
type: string
|
|
3324
3622
|
x-enum-varnames:
|
|
3325
3623
|
- AUTO
|
|
@@ -3348,6 +3646,7 @@ components:
|
|
|
3348
3646
|
description: Widget response format.
|
|
3349
3647
|
enum:
|
|
3350
3648
|
- event_list
|
|
3649
|
+
example: event_list
|
|
3351
3650
|
type: string
|
|
3352
3651
|
x-enum-varnames:
|
|
3353
3652
|
- EVENT_LIST
|
|
@@ -4847,6 +5146,13 @@ components:
|
|
|
4847
5146
|
type: string
|
|
4848
5147
|
x-enum-varnames:
|
|
4849
5148
|
- USER_AGENT_PARSER
|
|
5149
|
+
MetricContentEncoding:
|
|
5150
|
+
description: HTTP header used to compress the media-type.
|
|
5151
|
+
enum:
|
|
5152
|
+
- deflate
|
|
5153
|
+
type: string
|
|
5154
|
+
x-enum-varnames:
|
|
5155
|
+
- DEFLATE
|
|
4850
5156
|
MetricMetadata:
|
|
4851
5157
|
description: Object with all metric related metadata.
|
|
4852
5158
|
properties:
|
|
@@ -4914,7 +5220,7 @@ components:
|
|
|
4914
5220
|
example:
|
|
4915
5221
|
- metric: system.load.1
|
|
4916
5222
|
points:
|
|
4917
|
-
- - 1475317847
|
|
5223
|
+
- - 1475317847.0
|
|
4918
5224
|
- 0.7
|
|
4919
5225
|
items:
|
|
4920
5226
|
$ref: '#/components/schemas/Series'
|
|
@@ -4929,6 +5235,7 @@ components:
|
|
|
4929
5235
|
aggr:
|
|
4930
5236
|
description: Aggregation type.
|
|
4931
5237
|
example: avg
|
|
5238
|
+
nullable: true
|
|
4932
5239
|
readOnly: true
|
|
4933
5240
|
type: string
|
|
4934
5241
|
display_name:
|
|
@@ -5131,6 +5438,7 @@ components:
|
|
|
5131
5438
|
format: int64
|
|
5132
5439
|
maximum: 5
|
|
5133
5440
|
minimum: 1
|
|
5441
|
+
nullable: true
|
|
5134
5442
|
type: integer
|
|
5135
5443
|
query:
|
|
5136
5444
|
description: The monitor query.
|
|
@@ -5142,6 +5450,7 @@ components:
|
|
|
5142
5450
|
items:
|
|
5143
5451
|
description: A role UUID.
|
|
5144
5452
|
type: string
|
|
5453
|
+
nullable: true
|
|
5145
5454
|
type: array
|
|
5146
5455
|
state:
|
|
5147
5456
|
$ref: '#/components/schemas/MonitorState'
|
|
@@ -5302,7 +5611,7 @@ components:
|
|
|
5302
5611
|
type: boolean
|
|
5303
5612
|
escalation_message:
|
|
5304
5613
|
default: none
|
|
5305
|
-
description: 'We recommend using the [is_renotify](https://docs.datadoghq.com/monitors/
|
|
5614
|
+
description: 'We recommend using the [is_renotify](https://docs.datadoghq.com/monitors/notify/?tab=is_alert#renotify),
|
|
5306
5615
|
|
|
5307
5616
|
block in the original message instead.
|
|
5308
5617
|
|
|
@@ -5420,6 +5729,19 @@ components:
|
|
|
5420
5729
|
format: int64
|
|
5421
5730
|
nullable: true
|
|
5422
5731
|
type: integer
|
|
5732
|
+
renotify_occurrences:
|
|
5733
|
+
description: The number of times re-notification messages should be sent
|
|
5734
|
+
on the current status at the provided re-notification interval.
|
|
5735
|
+
format: int64
|
|
5736
|
+
nullable: true
|
|
5737
|
+
type: integer
|
|
5738
|
+
renotify_statuses:
|
|
5739
|
+
description: The types of monitor statuses for which re-notification messages
|
|
5740
|
+
are sent.
|
|
5741
|
+
items:
|
|
5742
|
+
$ref: '#/components/schemas/MonitorRenotifyStatusType'
|
|
5743
|
+
nullable: true
|
|
5744
|
+
type: array
|
|
5423
5745
|
require_full_window:
|
|
5424
5746
|
description: "A Boolean indicating whether this monitor needs a full window
|
|
5425
5747
|
of data before it\u2019s evaluated.\nWe highly recommend you set this
|
|
@@ -5472,6 +5794,17 @@ components:
|
|
|
5472
5794
|
- SKIPPED
|
|
5473
5795
|
- UNKNOWN
|
|
5474
5796
|
- WARN
|
|
5797
|
+
MonitorRenotifyStatusType:
|
|
5798
|
+
description: The different statuses for which renotification is supported.
|
|
5799
|
+
enum:
|
|
5800
|
+
- alert
|
|
5801
|
+
- warn
|
|
5802
|
+
- no data
|
|
5803
|
+
type: string
|
|
5804
|
+
x-enum-varnames:
|
|
5805
|
+
- ALERT
|
|
5806
|
+
- WARN
|
|
5807
|
+
- NO_DATA
|
|
5475
5808
|
MonitorSearchCount:
|
|
5476
5809
|
description: Search facets.
|
|
5477
5810
|
items:
|
|
@@ -5999,12 +6332,14 @@ components:
|
|
|
5999
6332
|
type: string
|
|
6000
6333
|
name:
|
|
6001
6334
|
description: Name of the user.
|
|
6335
|
+
nullable: true
|
|
6002
6336
|
type: string
|
|
6003
6337
|
status:
|
|
6004
6338
|
description: Status of the user.
|
|
6005
6339
|
type: string
|
|
6006
6340
|
title:
|
|
6007
6341
|
description: Title of the user.
|
|
6342
|
+
nullable: true
|
|
6008
6343
|
type: string
|
|
6009
6344
|
verified:
|
|
6010
6345
|
description: Whether the user is verified.
|
|
@@ -6200,6 +6535,8 @@ components:
|
|
|
6200
6535
|
items:
|
|
6201
6536
|
$ref: '#/components/schemas/NotebookCellCreateRequest'
|
|
6202
6537
|
type: array
|
|
6538
|
+
metadata:
|
|
6539
|
+
$ref: '#/components/schemas/NotebookMetadata'
|
|
6203
6540
|
name:
|
|
6204
6541
|
description: The name of the notebook.
|
|
6205
6542
|
example: Example Notebook
|
|
@@ -6317,10 +6654,46 @@ components:
|
|
|
6317
6654
|
type: string
|
|
6318
6655
|
x-enum-varnames:
|
|
6319
6656
|
- MARKDOWN
|
|
6657
|
+
NotebookMetadata:
|
|
6658
|
+
description: Metadata associated with the notebook.
|
|
6659
|
+
properties:
|
|
6660
|
+
is_template:
|
|
6661
|
+
default: false
|
|
6662
|
+
description: Whether or not the notebook is a template.
|
|
6663
|
+
example: false
|
|
6664
|
+
type: boolean
|
|
6665
|
+
take_snapshots:
|
|
6666
|
+
default: false
|
|
6667
|
+
description: Whether or not the notebook takes snapshot image backups of
|
|
6668
|
+
the notebook's fixed-time graphs.
|
|
6669
|
+
example: false
|
|
6670
|
+
type: boolean
|
|
6671
|
+
type:
|
|
6672
|
+
$ref: '#/components/schemas/NotebookMetadataType'
|
|
6673
|
+
type: object
|
|
6674
|
+
NotebookMetadataType:
|
|
6675
|
+
default: null
|
|
6676
|
+
description: Metadata type of the notebook.
|
|
6677
|
+
enum:
|
|
6678
|
+
- postmortem
|
|
6679
|
+
- runbook
|
|
6680
|
+
- investigation
|
|
6681
|
+
- documentation
|
|
6682
|
+
- report
|
|
6683
|
+
example: investigation
|
|
6684
|
+
nullable: true
|
|
6685
|
+
type: string
|
|
6686
|
+
x-enum-varnames:
|
|
6687
|
+
- POSTMORTEM
|
|
6688
|
+
- RUNBOOK
|
|
6689
|
+
- INVESTIGATION
|
|
6690
|
+
- DOCUMENTATION
|
|
6691
|
+
- REPORT
|
|
6320
6692
|
NotebookRelativeTime:
|
|
6321
6693
|
description: Relative timeframe.
|
|
6322
6694
|
example:
|
|
6323
6695
|
live_span: 1h
|
|
6696
|
+
nullable: true
|
|
6324
6697
|
properties:
|
|
6325
6698
|
live_span:
|
|
6326
6699
|
$ref: '#/components/schemas/WidgetLiveSpan'
|
|
@@ -6414,6 +6787,8 @@ components:
|
|
|
6414
6787
|
format: date-time
|
|
6415
6788
|
readOnly: true
|
|
6416
6789
|
type: string
|
|
6790
|
+
metadata:
|
|
6791
|
+
$ref: '#/components/schemas/NotebookMetadata'
|
|
6417
6792
|
modified:
|
|
6418
6793
|
description: UTC time stamp for when the notebook was last modified.
|
|
6419
6794
|
example: '2021-02-24T23:15:23.274966+00:00'
|
|
@@ -6563,6 +6938,8 @@ components:
|
|
|
6563
6938
|
items:
|
|
6564
6939
|
$ref: '#/components/schemas/NotebookUpdateCell'
|
|
6565
6940
|
type: array
|
|
6941
|
+
metadata:
|
|
6942
|
+
$ref: '#/components/schemas/NotebookMetadata'
|
|
6566
6943
|
name:
|
|
6567
6944
|
description: The name of the notebook.
|
|
6568
6945
|
example: Example Notebook
|
|
@@ -6595,7 +6972,7 @@ components:
|
|
|
6595
6972
|
$ref: '#/components/schemas/NotebooksResponseData'
|
|
6596
6973
|
type: array
|
|
6597
6974
|
meta:
|
|
6598
|
-
description:
|
|
6975
|
+
description: Searches metadata returned by the API.
|
|
6599
6976
|
properties:
|
|
6600
6977
|
page:
|
|
6601
6978
|
$ref: '#/components/schemas/NotebooksResponsePage'
|
|
@@ -6635,6 +7012,8 @@ components:
|
|
|
6635
7012
|
format: date-time
|
|
6636
7013
|
readOnly: true
|
|
6637
7014
|
type: string
|
|
7015
|
+
metadata:
|
|
7016
|
+
$ref: '#/components/schemas/NotebookMetadata'
|
|
6638
7017
|
modified:
|
|
6639
7018
|
description: UTC time stamp for when the notebook was last modified.
|
|
6640
7019
|
example: '2021-02-24T23:15:23.274966+00:00'
|
|
@@ -6885,7 +7264,7 @@ components:
|
|
|
6885
7264
|
Point:
|
|
6886
7265
|
description: Array of timeseries points.
|
|
6887
7266
|
example:
|
|
6888
|
-
- 1575317847
|
|
7267
|
+
- 1575317847.0
|
|
6889
7268
|
- 0.5
|
|
6890
7269
|
items:
|
|
6891
7270
|
description: 'Each point is of the form `[POSIX_timestamp, numeric_value]`.
|
|
@@ -6918,7 +7297,7 @@ components:
|
|
|
6918
7297
|
type: integer
|
|
6919
7298
|
metric:
|
|
6920
7299
|
description: Your chosen metric.
|
|
6921
|
-
example:
|
|
7300
|
+
example: system.load.1
|
|
6922
7301
|
type: string
|
|
6923
7302
|
search_by:
|
|
6924
7303
|
description: Your chosen search term.
|
|
@@ -7122,18 +7501,18 @@ components:
|
|
|
7122
7501
|
type: array
|
|
7123
7502
|
type: object
|
|
7124
7503
|
SLOCorrection:
|
|
7125
|
-
description: The response object of a list of SLO corrections
|
|
7504
|
+
description: The response object of a list of SLO corrections.
|
|
7126
7505
|
properties:
|
|
7127
7506
|
attributes:
|
|
7128
7507
|
$ref: '#/components/schemas/SLOCorrectionResponseAttributes'
|
|
7129
7508
|
id:
|
|
7130
|
-
description: The ID of the SLO correction
|
|
7509
|
+
description: The ID of the SLO correction.
|
|
7131
7510
|
type: string
|
|
7132
7511
|
type:
|
|
7133
7512
|
$ref: '#/components/schemas/SLOCorrectionType'
|
|
7134
7513
|
type: object
|
|
7135
7514
|
SLOCorrectionCategory:
|
|
7136
|
-
description: Category the SLO correction belongs to
|
|
7515
|
+
description: Category the SLO correction belongs to.
|
|
7137
7516
|
enum:
|
|
7138
7517
|
- Scheduled Maintenance
|
|
7139
7518
|
- Outside Business Hours
|
|
@@ -7147,21 +7526,23 @@ components:
|
|
|
7147
7526
|
- DEPLOYMENT
|
|
7148
7527
|
- OTHER
|
|
7149
7528
|
SLOCorrectionCreateData:
|
|
7150
|
-
description: The data object associated with the SLO correction to be created
|
|
7529
|
+
description: The data object associated with the SLO correction to be created.
|
|
7151
7530
|
properties:
|
|
7152
7531
|
attributes:
|
|
7153
7532
|
$ref: '#/components/schemas/SLOCorrectionCreateRequestAttributes'
|
|
7154
7533
|
type:
|
|
7155
7534
|
$ref: '#/components/schemas/SLOCorrectionType'
|
|
7535
|
+
required:
|
|
7536
|
+
- type
|
|
7156
7537
|
type: object
|
|
7157
7538
|
SLOCorrectionCreateRequest:
|
|
7158
|
-
description: An object that defines a correction to be applied to an SLO
|
|
7539
|
+
description: An object that defines a correction to be applied to an SLO.
|
|
7159
7540
|
properties:
|
|
7160
7541
|
data:
|
|
7161
7542
|
$ref: '#/components/schemas/SLOCorrectionCreateData'
|
|
7162
7543
|
type: object
|
|
7163
7544
|
SLOCorrectionCreateRequestAttributes:
|
|
7164
|
-
description: The attribute object associated with the SLO correction to be created
|
|
7545
|
+
description: The attribute object associated with the SLO correction to be created.
|
|
7165
7546
|
properties:
|
|
7166
7547
|
category:
|
|
7167
7548
|
$ref: '#/components/schemas/SLOCorrectionCategory'
|
|
@@ -7169,22 +7550,22 @@ components:
|
|
|
7169
7550
|
description: Description of the correction being made.
|
|
7170
7551
|
type: string
|
|
7171
7552
|
end:
|
|
7172
|
-
description: Ending time of the correction in epoch seconds
|
|
7553
|
+
description: Ending time of the correction in epoch seconds.
|
|
7173
7554
|
example: 1600000000
|
|
7174
7555
|
format: int64
|
|
7175
7556
|
type: integer
|
|
7176
7557
|
slo_id:
|
|
7177
|
-
description: ID of the SLO that this correction will be applied to
|
|
7558
|
+
description: ID of the SLO that this correction will be applied to.
|
|
7178
7559
|
example: sloId
|
|
7179
7560
|
type: string
|
|
7180
7561
|
start:
|
|
7181
|
-
description: Starting time of the correction in epoch seconds
|
|
7562
|
+
description: Starting time of the correction in epoch seconds.
|
|
7182
7563
|
example: 1600000000
|
|
7183
7564
|
format: int64
|
|
7184
7565
|
type: integer
|
|
7185
7566
|
timezone:
|
|
7186
7567
|
description: The timezone to display in the UI for the correction times
|
|
7187
|
-
(defaults to "UTC")
|
|
7568
|
+
(defaults to "UTC").
|
|
7188
7569
|
example: UTC
|
|
7189
7570
|
type: string
|
|
7190
7571
|
required:
|
|
@@ -7194,10 +7575,10 @@ components:
|
|
|
7194
7575
|
- category
|
|
7195
7576
|
type: object
|
|
7196
7577
|
SLOCorrectionListResponse:
|
|
7197
|
-
description: A list of SLO correction objects
|
|
7578
|
+
description: A list of SLO correction objects.
|
|
7198
7579
|
properties:
|
|
7199
7580
|
data:
|
|
7200
|
-
description: The list of of SLO corrections objects
|
|
7581
|
+
description: The list of of SLO corrections objects.
|
|
7201
7582
|
items:
|
|
7202
7583
|
$ref: '#/components/schemas/SLOCorrection'
|
|
7203
7584
|
type: array
|
|
@@ -7205,13 +7586,13 @@ components:
|
|
|
7205
7586
|
$ref: '#/components/schemas/ResponseMetaAttributes'
|
|
7206
7587
|
type: object
|
|
7207
7588
|
SLOCorrectionResponse:
|
|
7208
|
-
description: The response object of an SLO correction
|
|
7589
|
+
description: The response object of an SLO correction.
|
|
7209
7590
|
properties:
|
|
7210
7591
|
data:
|
|
7211
7592
|
$ref: '#/components/schemas/SLOCorrection'
|
|
7212
7593
|
type: object
|
|
7213
7594
|
SLOCorrectionResponseAttributes:
|
|
7214
|
-
description: The attribute object associated with the SLO correction
|
|
7595
|
+
description: The attribute object associated with the SLO correction.
|
|
7215
7596
|
properties:
|
|
7216
7597
|
category:
|
|
7217
7598
|
$ref: '#/components/schemas/SLOCorrectionCategory'
|
|
@@ -7221,19 +7602,19 @@ components:
|
|
|
7221
7602
|
description: Description of the correction being made.
|
|
7222
7603
|
type: string
|
|
7223
7604
|
end:
|
|
7224
|
-
description: Ending time of the correction in epoch seconds
|
|
7605
|
+
description: Ending time of the correction in epoch seconds.
|
|
7225
7606
|
format: int64
|
|
7226
7607
|
type: integer
|
|
7227
7608
|
slo_id:
|
|
7228
|
-
description: ID of the SLO that this correction will be applied to
|
|
7609
|
+
description: ID of the SLO that this correction will be applied to.
|
|
7229
7610
|
type: string
|
|
7230
7611
|
start:
|
|
7231
|
-
description: Starting time of the correction in epoch seconds
|
|
7612
|
+
description: Starting time of the correction in epoch seconds.
|
|
7232
7613
|
format: int64
|
|
7233
7614
|
type: integer
|
|
7234
7615
|
timezone:
|
|
7235
7616
|
description: The timezone to display in the UI for the correction times
|
|
7236
|
-
(defaults to "UTC")
|
|
7617
|
+
(defaults to "UTC").
|
|
7237
7618
|
type: string
|
|
7238
7619
|
type: object
|
|
7239
7620
|
SLOCorrectionType:
|
|
@@ -7246,7 +7627,7 @@ components:
|
|
|
7246
7627
|
x-enum-varnames:
|
|
7247
7628
|
- CORRECTION
|
|
7248
7629
|
SLOCorrectionUpdateData:
|
|
7249
|
-
description: The data object associated with the SLO correction to be updated
|
|
7630
|
+
description: The data object associated with the SLO correction to be updated.
|
|
7250
7631
|
properties:
|
|
7251
7632
|
attributes:
|
|
7252
7633
|
$ref: '#/components/schemas/SLOCorrectionUpdateRequestAttributes'
|
|
@@ -7254,13 +7635,13 @@ components:
|
|
|
7254
7635
|
$ref: '#/components/schemas/SLOCorrectionType'
|
|
7255
7636
|
type: object
|
|
7256
7637
|
SLOCorrectionUpdateRequest:
|
|
7257
|
-
description: An object that defines a correction to be applied to an SLO
|
|
7638
|
+
description: An object that defines a correction to be applied to an SLO.
|
|
7258
7639
|
properties:
|
|
7259
7640
|
data:
|
|
7260
7641
|
$ref: '#/components/schemas/SLOCorrectionUpdateData'
|
|
7261
7642
|
type: object
|
|
7262
7643
|
SLOCorrectionUpdateRequestAttributes:
|
|
7263
|
-
description: The attribute object associated with the SLO correction to be updated
|
|
7644
|
+
description: The attribute object associated with the SLO correction to be updated.
|
|
7264
7645
|
properties:
|
|
7265
7646
|
category:
|
|
7266
7647
|
$ref: '#/components/schemas/SLOCorrectionCategory'
|
|
@@ -7268,18 +7649,18 @@ components:
|
|
|
7268
7649
|
description: Description of the correction being made.
|
|
7269
7650
|
type: string
|
|
7270
7651
|
end:
|
|
7271
|
-
description: Ending time of the correction in epoch seconds
|
|
7652
|
+
description: Ending time of the correction in epoch seconds.
|
|
7272
7653
|
example: 1600000000
|
|
7273
7654
|
format: int64
|
|
7274
7655
|
type: integer
|
|
7275
7656
|
start:
|
|
7276
|
-
description: Starting time of the correction in epoch seconds
|
|
7657
|
+
description: Starting time of the correction in epoch seconds.
|
|
7277
7658
|
example: 1600000000
|
|
7278
7659
|
format: int64
|
|
7279
7660
|
type: integer
|
|
7280
7661
|
timezone:
|
|
7281
7662
|
description: The timezone to display in the UI for the correction times
|
|
7282
|
-
(defaults to "UTC")
|
|
7663
|
+
(defaults to "UTC").
|
|
7283
7664
|
example: UTC
|
|
7284
7665
|
type: string
|
|
7285
7666
|
type: object
|
|
@@ -7319,6 +7700,7 @@ components:
|
|
|
7319
7700
|
- 30d
|
|
7320
7701
|
- 90d
|
|
7321
7702
|
- all
|
|
7703
|
+
example: 30d
|
|
7322
7704
|
type: string
|
|
7323
7705
|
x-enum-varnames:
|
|
7324
7706
|
- SEVEN_DAYS
|
|
@@ -7992,6 +8374,7 @@ components:
|
|
|
7992
8374
|
- 30d
|
|
7993
8375
|
- 90d
|
|
7994
8376
|
- custom
|
|
8377
|
+
example: 30d
|
|
7995
8378
|
type: string
|
|
7996
8379
|
x-enum-varnames:
|
|
7997
8380
|
- SEVEN_DAYS
|
|
@@ -8120,13 +8503,12 @@ components:
|
|
|
8120
8503
|
y:
|
|
8121
8504
|
q: system.mem.used
|
|
8122
8505
|
properties:
|
|
8506
|
+
table:
|
|
8507
|
+
$ref: '#/components/schemas/ScatterplotTableRequest'
|
|
8123
8508
|
x:
|
|
8124
8509
|
$ref: '#/components/schemas/ScatterPlotRequest'
|
|
8125
8510
|
y:
|
|
8126
8511
|
$ref: '#/components/schemas/ScatterPlotRequest'
|
|
8127
|
-
required:
|
|
8128
|
-
- x
|
|
8129
|
-
- y
|
|
8130
8512
|
type: object
|
|
8131
8513
|
time:
|
|
8132
8514
|
$ref: '#/components/schemas/WidgetTime'
|
|
@@ -8157,6 +8539,38 @@ components:
|
|
|
8157
8539
|
type: string
|
|
8158
8540
|
x-enum-varnames:
|
|
8159
8541
|
- SCATTERPLOT
|
|
8542
|
+
ScatterplotDimension:
|
|
8543
|
+
description: Dimension of the Scatterplot.
|
|
8544
|
+
enum:
|
|
8545
|
+
- x
|
|
8546
|
+
- y
|
|
8547
|
+
- radius
|
|
8548
|
+
- color
|
|
8549
|
+
example: radius
|
|
8550
|
+
type: string
|
|
8551
|
+
x-enum-varnames:
|
|
8552
|
+
- X
|
|
8553
|
+
- Y
|
|
8554
|
+
- RADIUS
|
|
8555
|
+
- COLOR
|
|
8556
|
+
ScatterplotTableRequest:
|
|
8557
|
+
description: Scatterplot request containing formulas and functions.
|
|
8558
|
+
properties:
|
|
8559
|
+
formulas:
|
|
8560
|
+
description: List of Scatterplot formulas that operate on queries. **This
|
|
8561
|
+
feature is currently in beta.**
|
|
8562
|
+
items:
|
|
8563
|
+
$ref: '#/components/schemas/ScatterplotWidgetFormula'
|
|
8564
|
+
type: array
|
|
8565
|
+
queries:
|
|
8566
|
+
description: List of queries that can be returned directly or used in formulas.
|
|
8567
|
+
**This feature is currently in beta.**
|
|
8568
|
+
items:
|
|
8569
|
+
$ref: '#/components/schemas/FormulaAndFunctionQueryDefinition'
|
|
8570
|
+
type: array
|
|
8571
|
+
response_format:
|
|
8572
|
+
$ref: '#/components/schemas/FormulaAndFunctionResponseFormat'
|
|
8573
|
+
type: object
|
|
8160
8574
|
ScatterplotWidgetAggregator:
|
|
8161
8575
|
description: Aggregator used for the request.
|
|
8162
8576
|
enum:
|
|
@@ -8172,6 +8586,23 @@ components:
|
|
|
8172
8586
|
- MAXIMUM
|
|
8173
8587
|
- MINIMUM
|
|
8174
8588
|
- SUM
|
|
8589
|
+
ScatterplotWidgetFormula:
|
|
8590
|
+
description: Formula to be used in a Scatterplot widget query.
|
|
8591
|
+
properties:
|
|
8592
|
+
alias:
|
|
8593
|
+
description: Expression alias.
|
|
8594
|
+
example: my-query
|
|
8595
|
+
type: string
|
|
8596
|
+
dimension:
|
|
8597
|
+
$ref: '#/components/schemas/ScatterplotDimension'
|
|
8598
|
+
formula:
|
|
8599
|
+
description: String expression built from queries, formulas, and functions.
|
|
8600
|
+
example: func(a) + b
|
|
8601
|
+
type: string
|
|
8602
|
+
required:
|
|
8603
|
+
- formula
|
|
8604
|
+
- dimension
|
|
8605
|
+
type: object
|
|
8175
8606
|
Series:
|
|
8176
8607
|
description: 'A metric to submit to Datadog.
|
|
8177
8608
|
|
|
@@ -8198,9 +8629,6 @@ components:
|
|
|
8198
8629
|
timestamp and a scalar value (cannot be a string). Timestamps should be
|
|
8199
8630
|
in POSIX time in seconds, and cannot be more than ten minutes in the future
|
|
8200
8631
|
or more than one hour in the past.
|
|
8201
|
-
example:
|
|
8202
|
-
- - 1575317847
|
|
8203
|
-
- 0.5
|
|
8204
8632
|
items:
|
|
8205
8633
|
$ref: '#/components/schemas/Point'
|
|
8206
8634
|
type: array
|
|
@@ -8676,7 +9104,6 @@ components:
|
|
|
8676
9104
|
assertions:
|
|
8677
9105
|
default: []
|
|
8678
9106
|
description: Array of assertions used for the test.
|
|
8679
|
-
example: []
|
|
8680
9107
|
items:
|
|
8681
9108
|
$ref: '#/components/schemas/SyntheticsAssertion'
|
|
8682
9109
|
type: array
|
|
@@ -8885,6 +9312,7 @@ components:
|
|
|
8885
9312
|
description: Assertion operator to apply.
|
|
8886
9313
|
enum:
|
|
8887
9314
|
- validatesJSONPath
|
|
9315
|
+
example: validatesJSONPath
|
|
8888
9316
|
type: string
|
|
8889
9317
|
x-enum-varnames:
|
|
8890
9318
|
- VALIDATES_JSON_PATH
|
|
@@ -8930,6 +9358,7 @@ components:
|
|
|
8930
9358
|
- validates
|
|
8931
9359
|
- isInMoreThan
|
|
8932
9360
|
- isInLessThan
|
|
9361
|
+
example: contains
|
|
8933
9362
|
type: string
|
|
8934
9363
|
x-enum-varnames:
|
|
8935
9364
|
- CONTAINS
|
|
@@ -8979,6 +9408,7 @@ components:
|
|
|
8979
9408
|
- packetLossPercentage
|
|
8980
9409
|
- packetsReceived
|
|
8981
9410
|
- networkHop
|
|
9411
|
+
example: statusCode
|
|
8982
9412
|
type: string
|
|
8983
9413
|
x-enum-varnames:
|
|
8984
9414
|
- BODY
|
|
@@ -9010,19 +9440,71 @@ components:
|
|
|
9010
9440
|
- password
|
|
9011
9441
|
- username
|
|
9012
9442
|
type: object
|
|
9443
|
+
SyntheticsBatchDetails:
|
|
9444
|
+
description: Details about a batch response.
|
|
9445
|
+
properties:
|
|
9446
|
+
data:
|
|
9447
|
+
$ref: '#/components/schemas/SyntheticsBatchDetailsData'
|
|
9448
|
+
type: object
|
|
9449
|
+
SyntheticsBatchDetailsData:
|
|
9450
|
+
description: Wrapper object that contains the details of a batch.
|
|
9451
|
+
properties:
|
|
9452
|
+
metadata:
|
|
9453
|
+
$ref: '#/components/schemas/SyntheticsCIBatchMetadata'
|
|
9454
|
+
results:
|
|
9455
|
+
description: List of results for the batch.
|
|
9456
|
+
items:
|
|
9457
|
+
$ref: '#/components/schemas/SyntheticsBatchResult'
|
|
9458
|
+
type: array
|
|
9459
|
+
status:
|
|
9460
|
+
$ref: '#/components/schemas/SyntheticsStatus'
|
|
9461
|
+
type: object
|
|
9462
|
+
SyntheticsBatchResult:
|
|
9463
|
+
description: Object with the results of a Synthetics batch.
|
|
9464
|
+
properties:
|
|
9465
|
+
device:
|
|
9466
|
+
$ref: '#/components/schemas/SyntheticsDeviceID'
|
|
9467
|
+
duration:
|
|
9468
|
+
description: Total duration in millisecond of the test.
|
|
9469
|
+
format: double
|
|
9470
|
+
type: number
|
|
9471
|
+
execution_rule:
|
|
9472
|
+
$ref: '#/components/schemas/SyntheticsTestExecutionRule'
|
|
9473
|
+
location:
|
|
9474
|
+
description: Name of the location.
|
|
9475
|
+
type: string
|
|
9476
|
+
result_id:
|
|
9477
|
+
description: The ID of the result to get.
|
|
9478
|
+
type: string
|
|
9479
|
+
retries:
|
|
9480
|
+
description: Total duration in millisecond of the test.
|
|
9481
|
+
format: double
|
|
9482
|
+
type: number
|
|
9483
|
+
status:
|
|
9484
|
+
$ref: '#/components/schemas/SyntheticsStatus'
|
|
9485
|
+
test_name:
|
|
9486
|
+
description: Name of the test.
|
|
9487
|
+
type: string
|
|
9488
|
+
test_public_id:
|
|
9489
|
+
description: The public ID of the Synthetic test.
|
|
9490
|
+
type: string
|
|
9491
|
+
test_type:
|
|
9492
|
+
$ref: '#/components/schemas/SyntheticsTestDetailsType'
|
|
9493
|
+
type: object
|
|
9013
9494
|
SyntheticsBrowserError:
|
|
9014
9495
|
description: Error response object for a browser test.
|
|
9015
9496
|
properties:
|
|
9016
9497
|
description:
|
|
9017
9498
|
description: Description of the error.
|
|
9018
|
-
example:
|
|
9499
|
+
example: Example error message
|
|
9019
9500
|
type: string
|
|
9020
9501
|
name:
|
|
9021
9502
|
description: Name of the error.
|
|
9022
|
-
example:
|
|
9503
|
+
example: Failed test
|
|
9023
9504
|
type: string
|
|
9024
9505
|
status:
|
|
9025
9506
|
description: Status Code of the error.
|
|
9507
|
+
example: 500
|
|
9026
9508
|
format: int64
|
|
9027
9509
|
type: integer
|
|
9028
9510
|
type:
|
|
@@ -9037,6 +9519,7 @@ components:
|
|
|
9037
9519
|
enum:
|
|
9038
9520
|
- network
|
|
9039
9521
|
- js
|
|
9522
|
+
example: network
|
|
9040
9523
|
type: string
|
|
9041
9524
|
x-enum-varnames:
|
|
9042
9525
|
- NETWORK
|
|
@@ -9274,6 +9757,7 @@ components:
|
|
|
9274
9757
|
- global
|
|
9275
9758
|
- javascript
|
|
9276
9759
|
- text
|
|
9760
|
+
example: text
|
|
9277
9761
|
type: string
|
|
9278
9762
|
x-enum-varnames:
|
|
9279
9763
|
- ELEMENT
|
|
@@ -9281,6 +9765,34 @@ components:
|
|
|
9281
9765
|
- GLOBAL
|
|
9282
9766
|
- JAVASCRIPT
|
|
9283
9767
|
- TEXT
|
|
9768
|
+
SyntheticsCIBatchMetadata:
|
|
9769
|
+
description: Metadata for the Synthetics tests run.
|
|
9770
|
+
properties:
|
|
9771
|
+
ci:
|
|
9772
|
+
$ref: '#/components/schemas/SyntheticsCIBatchMetadataCI'
|
|
9773
|
+
git:
|
|
9774
|
+
$ref: '#/components/schemas/SyntheticsCIBatchMetadataGit'
|
|
9775
|
+
type: object
|
|
9776
|
+
SyntheticsCIBatchMetadataCI:
|
|
9777
|
+
description: Description of the CI provider.
|
|
9778
|
+
properties:
|
|
9779
|
+
pipeline:
|
|
9780
|
+
description: Name of the pipeline.
|
|
9781
|
+
type: string
|
|
9782
|
+
provider:
|
|
9783
|
+
description: Name of the CI provider.
|
|
9784
|
+
type: string
|
|
9785
|
+
type: object
|
|
9786
|
+
SyntheticsCIBatchMetadataGit:
|
|
9787
|
+
description: Git information.
|
|
9788
|
+
properties:
|
|
9789
|
+
branch:
|
|
9790
|
+
description: The branch name.
|
|
9791
|
+
type: string
|
|
9792
|
+
commit_sha:
|
|
9793
|
+
description: The commit SHA.
|
|
9794
|
+
type: string
|
|
9795
|
+
type: object
|
|
9284
9796
|
SyntheticsCITest:
|
|
9285
9797
|
description: Test configuration for Synthetics CI
|
|
9286
9798
|
properties:
|
|
@@ -9316,29 +9828,7 @@ components:
|
|
|
9316
9828
|
type: string
|
|
9317
9829
|
type: array
|
|
9318
9830
|
metadata:
|
|
9319
|
-
|
|
9320
|
-
properties:
|
|
9321
|
-
ci:
|
|
9322
|
-
description: Describe CI provider.
|
|
9323
|
-
properties:
|
|
9324
|
-
pipeline:
|
|
9325
|
-
description: Name of the pipeline.
|
|
9326
|
-
type: string
|
|
9327
|
-
provider:
|
|
9328
|
-
description: Name of the CI provider.
|
|
9329
|
-
type: string
|
|
9330
|
-
type: object
|
|
9331
|
-
git:
|
|
9332
|
-
description: Git information.
|
|
9333
|
-
properties:
|
|
9334
|
-
branch:
|
|
9335
|
-
description: Branch name.
|
|
9336
|
-
type: string
|
|
9337
|
-
commit_sha:
|
|
9338
|
-
description: Commit SHA.
|
|
9339
|
-
type: string
|
|
9340
|
-
type: object
|
|
9341
|
-
type: object
|
|
9831
|
+
$ref: '#/components/schemas/SyntheticsCIBatchMetadata'
|
|
9342
9832
|
public_id:
|
|
9343
9833
|
description: The public ID of the Synthetics test to trigger.
|
|
9344
9834
|
example: aaa-aaa-aaa
|
|
@@ -9426,6 +9916,7 @@ components:
|
|
|
9426
9916
|
enum:
|
|
9427
9917
|
- global
|
|
9428
9918
|
- text
|
|
9919
|
+
example: text
|
|
9429
9920
|
type: string
|
|
9430
9921
|
x-enum-varnames:
|
|
9431
9922
|
- GLOBAL
|
|
@@ -9526,6 +10017,7 @@ components:
|
|
|
9526
10017
|
- edge.laptop_large
|
|
9527
10018
|
- edge.tablet
|
|
9528
10019
|
- edge.mobile_small
|
|
10020
|
+
example: laptop_large
|
|
9529
10021
|
type: string
|
|
9530
10022
|
x-enum-varnames:
|
|
9531
10023
|
- LAPTOP_LARGE
|
|
@@ -9656,6 +10148,7 @@ components:
|
|
|
9656
10148
|
enum:
|
|
9657
10149
|
- http_body
|
|
9658
10150
|
- http_header
|
|
10151
|
+
example: http_body
|
|
9659
10152
|
type: string
|
|
9660
10153
|
x-enum-varnames:
|
|
9661
10154
|
- HTTP_BODY
|
|
@@ -9668,6 +10161,7 @@ components:
|
|
|
9668
10161
|
- json_path
|
|
9669
10162
|
- regex
|
|
9670
10163
|
- x_path
|
|
10164
|
+
example: raw
|
|
9671
10165
|
type: string
|
|
9672
10166
|
x-enum-varnames:
|
|
9673
10167
|
- RAW
|
|
@@ -9732,6 +10226,7 @@ components:
|
|
|
9732
10226
|
type: object
|
|
9733
10227
|
SyntheticsParsingOptions:
|
|
9734
10228
|
description: Parsing options for variables to extract.
|
|
10229
|
+
example: {}
|
|
9735
10230
|
properties:
|
|
9736
10231
|
field:
|
|
9737
10232
|
description: When type is `http_header`, name of the header to use to extract
|
|
@@ -9925,6 +10420,18 @@ components:
|
|
|
9925
10420
|
format: date-time
|
|
9926
10421
|
type: string
|
|
9927
10422
|
type: object
|
|
10423
|
+
SyntheticsStatus:
|
|
10424
|
+
description: Determines whether or not the batch has passed, failed, or is in
|
|
10425
|
+
progress.
|
|
10426
|
+
enum:
|
|
10427
|
+
- passed
|
|
10428
|
+
- skipped
|
|
10429
|
+
- failed
|
|
10430
|
+
type: string
|
|
10431
|
+
x-enum-varnames:
|
|
10432
|
+
- PASSED
|
|
10433
|
+
- skipped
|
|
10434
|
+
- failed
|
|
9928
10435
|
SyntheticsStep:
|
|
9929
10436
|
description: The steps used in a Synthetics browser test.
|
|
9930
10437
|
properties:
|
|
@@ -10050,6 +10557,7 @@ components:
|
|
|
10050
10557
|
- typeText
|
|
10051
10558
|
- uploadFiles
|
|
10052
10559
|
- wait
|
|
10560
|
+
example: assertElementContent
|
|
10053
10561
|
type: string
|
|
10054
10562
|
x-enum-varnames:
|
|
10055
10563
|
- ASSERT_CURRENT_URL
|
|
@@ -10105,6 +10613,8 @@ components:
|
|
|
10105
10613
|
properties:
|
|
10106
10614
|
config:
|
|
10107
10615
|
$ref: '#/components/schemas/SyntheticsTestConfig'
|
|
10616
|
+
creator:
|
|
10617
|
+
$ref: '#/components/schemas/Creator'
|
|
10108
10618
|
locations:
|
|
10109
10619
|
description: Array of locations used to run the test.
|
|
10110
10620
|
items:
|
|
@@ -10174,6 +10684,17 @@ components:
|
|
|
10174
10684
|
x-enum-varnames:
|
|
10175
10685
|
- API
|
|
10176
10686
|
- BROWSER
|
|
10687
|
+
SyntheticsTestExecutionRule:
|
|
10688
|
+
description: Execution rule for a Synthetics test.
|
|
10689
|
+
enum:
|
|
10690
|
+
- blocking
|
|
10691
|
+
- non_blocking
|
|
10692
|
+
- skipped
|
|
10693
|
+
type: string
|
|
10694
|
+
x-enum-varnames:
|
|
10695
|
+
- BLOCKING
|
|
10696
|
+
- NON_BLOCKING
|
|
10697
|
+
- SKIPPED
|
|
10177
10698
|
SyntheticsTestHeaders:
|
|
10178
10699
|
additionalProperties:
|
|
10179
10700
|
description: A single Header.
|
|
@@ -10362,6 +10883,14 @@ components:
|
|
|
10362
10883
|
query:
|
|
10363
10884
|
description: Query to use for the test.
|
|
10364
10885
|
type: object
|
|
10886
|
+
servername:
|
|
10887
|
+
description: 'For SSL tests, it specifies on which server you want to initiate
|
|
10888
|
+
the TLS handshake,
|
|
10889
|
+
|
|
10890
|
+
allowing the server to present one of multiple possible certificates on
|
|
10891
|
+
|
|
10892
|
+
the same IP address and TCP port number.'
|
|
10893
|
+
type: string
|
|
10365
10894
|
shouldTrackHops:
|
|
10366
10895
|
description: Turns on a traceroute probe to discover all gateways along
|
|
10367
10896
|
the path to the host destination.
|
|
@@ -10513,6 +11042,7 @@ components:
|
|
|
10513
11042
|
description: User locator used.
|
|
10514
11043
|
enum:
|
|
10515
11044
|
- user_locator
|
|
11045
|
+
example: user_locator
|
|
10516
11046
|
type: string
|
|
10517
11047
|
x-enum-varnames:
|
|
10518
11048
|
- USER_LOCATOR
|
|
@@ -11386,11 +11916,11 @@ components:
|
|
|
11386
11916
|
description: The network host usage by tag(s).
|
|
11387
11917
|
format: double
|
|
11388
11918
|
type: number
|
|
11389
|
-
|
|
11919
|
+
profiled_container_percentage:
|
|
11390
11920
|
description: The percentage of profiled containers usage by tag(s).
|
|
11391
11921
|
format: double
|
|
11392
11922
|
type: number
|
|
11393
|
-
|
|
11923
|
+
profiled_container_usage:
|
|
11394
11924
|
description: The profiled container usage by tag(s).
|
|
11395
11925
|
format: double
|
|
11396
11926
|
type: number
|
|
@@ -12200,6 +12730,37 @@ components:
|
|
|
12200
12730
|
$ref: '#/components/schemas/UsageRumSessionsHour'
|
|
12201
12731
|
type: array
|
|
12202
12732
|
type: object
|
|
12733
|
+
UsageSDSHour:
|
|
12734
|
+
description: Sensitive Data Scanner usage for a given organization for a given
|
|
12735
|
+
hour.
|
|
12736
|
+
properties:
|
|
12737
|
+
hour:
|
|
12738
|
+
description: The hour for the usage.
|
|
12739
|
+
format: date-time
|
|
12740
|
+
type: string
|
|
12741
|
+
logs_scanned_bytes:
|
|
12742
|
+
description: "The total number of bytes scanned of logs usage by the Sensitive
|
|
12743
|
+
Data Scanner from the start of the given hour\u2019s month until the given
|
|
12744
|
+
hour."
|
|
12745
|
+
format: int64
|
|
12746
|
+
type: integer
|
|
12747
|
+
total_scanned_bytes:
|
|
12748
|
+
description: "The total number of bytes scanned across all usage types by
|
|
12749
|
+
the Sensitive Data Scanner from the start of the given hour\u2019s month
|
|
12750
|
+
until the given hour."
|
|
12751
|
+
format: int64
|
|
12752
|
+
type: integer
|
|
12753
|
+
type: object
|
|
12754
|
+
UsageSDSResponse:
|
|
12755
|
+
description: Response containing the Sensitive Data Scanner usage for each hour
|
|
12756
|
+
for a given organization.
|
|
12757
|
+
properties:
|
|
12758
|
+
usage:
|
|
12759
|
+
description: Get hourly usage for Sensitive Data Scanner.
|
|
12760
|
+
items:
|
|
12761
|
+
$ref: '#/components/schemas/UsageSDSHour'
|
|
12762
|
+
type: array
|
|
12763
|
+
type: object
|
|
12203
12764
|
UsageSNMPHour:
|
|
12204
12765
|
description: The number of SNMP devices for each hour for a given organization.
|
|
12205
12766
|
properties:
|
|
@@ -12510,6 +13071,17 @@ components:
|
|
|
12510
13071
|
hours in the current date for all organizations.
|
|
12511
13072
|
format: int64
|
|
12512
13073
|
type: integer
|
|
13074
|
+
sds_logs_scanned_bytes_sum:
|
|
13075
|
+
description: Shows the sum of all bytes scanned of logs usage by the Sensitive
|
|
13076
|
+
Data Scanner over all hours in the current month for all organizations.
|
|
13077
|
+
format: int64
|
|
13078
|
+
type: integer
|
|
13079
|
+
sds_total_scanned_bytes_sum:
|
|
13080
|
+
description: Shows the sum of all bytes scanned across all usage types by
|
|
13081
|
+
the Sensitive Data Scanner over all hours in the current month for all
|
|
13082
|
+
organizations.
|
|
13083
|
+
format: int64
|
|
13084
|
+
type: integer
|
|
12513
13085
|
synthetics_browser_check_calls_count_sum:
|
|
12514
13086
|
description: Shows the sum of all Synthetic browser tests over all hours
|
|
12515
13087
|
in the current date for all organizations.
|
|
@@ -12630,8 +13202,8 @@ components:
|
|
|
12630
13202
|
over all hours in the current month for all organizations.
|
|
12631
13203
|
format: int64
|
|
12632
13204
|
type: integer
|
|
12633
|
-
|
|
12634
|
-
description: Shows the
|
|
13205
|
+
dbm_queries_avg_sum:
|
|
13206
|
+
description: Shows the average of all distinct Database Monitoring normalized
|
|
12635
13207
|
queries over all hours in the current month for all organizations.
|
|
12636
13208
|
format: int64
|
|
12637
13209
|
type: integer
|
|
@@ -12739,6 +13311,17 @@ components:
|
|
|
12739
13311
|
hours in the current date for the given org.
|
|
12740
13312
|
format: int64
|
|
12741
13313
|
type: integer
|
|
13314
|
+
sds_logs_scanned_bytes_sum:
|
|
13315
|
+
description: Shows the sum of all bytes scanned of logs usage by the Sensitive
|
|
13316
|
+
Data Scanner over all hours in the current month for all organizations.
|
|
13317
|
+
format: int64
|
|
13318
|
+
type: integer
|
|
13319
|
+
sds_total_scanned_bytes_sum:
|
|
13320
|
+
description: Shows the sum of all bytes scanned across all usage types by
|
|
13321
|
+
the Sensitive Data Scanner over all hours in the current month for all
|
|
13322
|
+
organizations.
|
|
13323
|
+
format: int64
|
|
13324
|
+
type: integer
|
|
12742
13325
|
synthetics_browser_check_calls_count_sum:
|
|
12743
13326
|
description: Shows the sum of all Synthetic browser tests over all hours
|
|
12744
13327
|
in the current date for the given org.
|
|
@@ -12766,7 +13349,8 @@ components:
|
|
|
12766
13349
|
type: integer
|
|
12767
13350
|
type: object
|
|
12768
13351
|
UsageSummaryResponse:
|
|
12769
|
-
description: Response
|
|
13352
|
+
description: Response summarizing all usage aggregated across the months in
|
|
13353
|
+
the request for all organizations, and broken down by month and by organization.
|
|
12770
13354
|
properties:
|
|
12771
13355
|
agent_host_top99p_sum:
|
|
12772
13356
|
description: Shows the 99th percentile of all agent hosts over all hours
|
|
@@ -12864,8 +13448,8 @@ components:
|
|
|
12864
13448
|
over all hours in the current month for all organizations.
|
|
12865
13449
|
format: int64
|
|
12866
13450
|
type: integer
|
|
12867
|
-
|
|
12868
|
-
description: Shows the
|
|
13451
|
+
dbm_queries_avg_sum:
|
|
13452
|
+
description: Shows the average of all distinct Database Monitoring Normalized
|
|
12869
13453
|
Queries over all hours in the current month for all organizations.
|
|
12870
13454
|
format: int64
|
|
12871
13455
|
type: integer
|
|
@@ -13006,6 +13590,17 @@ components:
|
|
|
13006
13590
|
hours in the current months for all organizations.
|
|
13007
13591
|
format: int64
|
|
13008
13592
|
type: integer
|
|
13593
|
+
sds_logs_scanned_bytes_sum:
|
|
13594
|
+
description: Shows the sum of all bytes scanned of logs usage by the Sensitive
|
|
13595
|
+
Data Scanner over all hours in the current month for all organizations.
|
|
13596
|
+
format: int64
|
|
13597
|
+
type: integer
|
|
13598
|
+
sds_total_scanned_bytes_sum:
|
|
13599
|
+
description: Shows the sum of all bytes scanned across all usage types by
|
|
13600
|
+
the Sensitive Data Scanner over all hours in the current month for all
|
|
13601
|
+
organizations.
|
|
13602
|
+
format: int64
|
|
13603
|
+
type: integer
|
|
13009
13604
|
start_date:
|
|
13010
13605
|
description: Shows the first date of usage in the current months for all
|
|
13011
13606
|
organizations.
|
|
@@ -13128,7 +13723,8 @@ components:
|
|
|
13128
13723
|
format: int64
|
|
13129
13724
|
type: integer
|
|
13130
13725
|
num_custom_timeseries:
|
|
13131
|
-
description: Contains
|
|
13726
|
+
description: Contains sum of non-aggregation custom metrics and custom metrics
|
|
13727
|
+
that are outputs for aggregations.
|
|
13132
13728
|
format: int64
|
|
13133
13729
|
type: integer
|
|
13134
13730
|
type: object
|
|
@@ -13258,7 +13854,7 @@ components:
|
|
|
13258
13854
|
|
|
13259
13855
|
Learn more on how to use it in
|
|
13260
13856
|
|
|
13261
|
-
[monitor notifications](https://docs.datadoghq.com/monitors/
|
|
13857
|
+
[monitor notifications](https://docs.datadoghq.com/monitors/notify).'
|
|
13262
13858
|
example: WEBHOOK_NAME
|
|
13263
13859
|
type: string
|
|
13264
13860
|
payload:
|
|
@@ -13376,7 +13972,7 @@ components:
|
|
|
13376
13972
|
|
|
13377
13973
|
Learn more on how to use it in
|
|
13378
13974
|
|
|
13379
|
-
[monitor notifications](https://docs.datadoghq.com/monitors/
|
|
13975
|
+
[monitor notifications](https://docs.datadoghq.com/monitors/notify).'
|
|
13380
13976
|
example: WEBHOOK_NAME
|
|
13381
13977
|
type: string
|
|
13382
13978
|
payload:
|
|
@@ -13479,6 +14075,7 @@ components:
|
|
|
13479
14075
|
- '>='
|
|
13480
14076
|
- <
|
|
13481
14077
|
- <=
|
|
14078
|
+
example: '>'
|
|
13482
14079
|
type: string
|
|
13483
14080
|
x-enum-varnames:
|
|
13484
14081
|
- GREATER_THAN
|
|
@@ -13589,6 +14186,7 @@ components:
|
|
|
13589
14186
|
- $ref: '#/components/schemas/ToplistWidgetDefinition'
|
|
13590
14187
|
- $ref: '#/components/schemas/TreeMapWidgetDefinition'
|
|
13591
14188
|
- $ref: '#/components/schemas/ListStreamWidgetDefinition'
|
|
14189
|
+
- $ref: '#/components/schemas/FunnelWidgetDefinition'
|
|
13592
14190
|
type: object
|
|
13593
14191
|
WidgetDisplayType:
|
|
13594
14192
|
description: Type of display to use for the request.
|
|
@@ -13676,6 +14274,7 @@ components:
|
|
|
13676
14274
|
enum:
|
|
13677
14275
|
- check
|
|
13678
14276
|
- cluster
|
|
14277
|
+
example: check
|
|
13679
14278
|
type: string
|
|
13680
14279
|
x-enum-varnames:
|
|
13681
14280
|
- CHECK
|
|
@@ -13762,6 +14361,7 @@ components:
|
|
|
13762
14361
|
description: Layout type of the group.
|
|
13763
14362
|
enum:
|
|
13764
14363
|
- ordered
|
|
14364
|
+
example: ordered
|
|
13765
14365
|
type: string
|
|
13766
14366
|
x-enum-varnames:
|
|
13767
14367
|
- ORDERED
|
|
@@ -13809,6 +14409,7 @@ components:
|
|
|
13809
14409
|
- 6mo
|
|
13810
14410
|
- 1y
|
|
13811
14411
|
- alert
|
|
14412
|
+
example: 5m
|
|
13812
14413
|
type: string
|
|
13813
14414
|
x-enum-varnames:
|
|
13814
14415
|
- PAST_ONE_MINUTE
|
|
@@ -13970,6 +14571,7 @@ components:
|
|
|
13970
14571
|
- black_on_light_yellow
|
|
13971
14572
|
- black_on_light_green
|
|
13972
14573
|
- black_on_light_red
|
|
14574
|
+
example: blue
|
|
13973
14575
|
type: string
|
|
13974
14576
|
x-enum-varnames:
|
|
13975
14577
|
- BLUE
|
|
@@ -14127,6 +14729,7 @@ components:
|
|
|
14127
14729
|
enum:
|
|
14128
14730
|
- timeseries
|
|
14129
14731
|
- toplist
|
|
14732
|
+
example: timeseries
|
|
14130
14733
|
type: string
|
|
14131
14734
|
x-enum-varnames:
|
|
14132
14735
|
- TIMESERIES
|
|
@@ -14221,6 +14824,7 @@ paths:
|
|
|
14221
14824
|
enum:
|
|
14222
14825
|
- datadoghq.com
|
|
14223
14826
|
- us3.datadoghq.com
|
|
14827
|
+
- us5.datadoghq.com
|
|
14224
14828
|
- datadoghq.eu
|
|
14225
14829
|
- ddog-gov.com
|
|
14226
14830
|
subdomain:
|
|
@@ -14642,31 +15246,31 @@ paths:
|
|
|
14642
15246
|
responses:
|
|
14643
15247
|
'202':
|
|
14644
15248
|
content:
|
|
14645
|
-
|
|
15249
|
+
text/json:
|
|
14646
15250
|
schema:
|
|
14647
15251
|
$ref: '#/components/schemas/IntakePayloadAccepted'
|
|
14648
15252
|
description: Payload accepted
|
|
14649
15253
|
'400':
|
|
14650
15254
|
content:
|
|
14651
|
-
|
|
15255
|
+
text/json:
|
|
14652
15256
|
schema:
|
|
14653
15257
|
$ref: '#/components/schemas/APIErrorResponse'
|
|
14654
15258
|
description: Bad Request
|
|
14655
15259
|
'403':
|
|
14656
15260
|
content:
|
|
14657
|
-
|
|
15261
|
+
text/json:
|
|
14658
15262
|
schema:
|
|
14659
15263
|
$ref: '#/components/schemas/APIErrorResponse'
|
|
14660
15264
|
description: Authentication Error
|
|
14661
15265
|
'408':
|
|
14662
15266
|
content:
|
|
14663
|
-
|
|
15267
|
+
text/json:
|
|
14664
15268
|
schema:
|
|
14665
15269
|
$ref: '#/components/schemas/APIErrorResponse'
|
|
14666
15270
|
description: Request timeout
|
|
14667
15271
|
'413':
|
|
14668
15272
|
content:
|
|
14669
|
-
|
|
15273
|
+
text/json:
|
|
14670
15274
|
schema:
|
|
14671
15275
|
$ref: '#/components/schemas/APIErrorResponse'
|
|
14672
15276
|
description: Payload too large
|
|
@@ -15040,6 +15644,12 @@ paths:
|
|
|
15040
15644
|
tags:
|
|
15041
15645
|
- Dashboard Lists
|
|
15042
15646
|
x-codegen-request-body-name: body
|
|
15647
|
+
x-given:
|
|
15648
|
+
dashboard_list:
|
|
15649
|
+
parameters:
|
|
15650
|
+
- name: body
|
|
15651
|
+
value: "{\n \"name\": \"{{ unique }}\"\n}"
|
|
15652
|
+
step: there is a valid "dashboard_list" in the system
|
|
15043
15653
|
x-menu-order: 2
|
|
15044
15654
|
x-undo:
|
|
15045
15655
|
operationId: DeleteDashboardList
|
|
@@ -15349,7 +15959,8 @@ paths:
|
|
|
15349
15959
|
security:
|
|
15350
15960
|
- apiKeyAuth: []
|
|
15351
15961
|
appKeyAuth: []
|
|
15352
|
-
- AuthZ:
|
|
15962
|
+
- AuthZ:
|
|
15963
|
+
- monitors_read
|
|
15353
15964
|
summary: Get all downtimes
|
|
15354
15965
|
tags:
|
|
15355
15966
|
- Downtimes
|
|
@@ -15394,10 +16005,22 @@ paths:
|
|
|
15394
16005
|
tags:
|
|
15395
16006
|
- Downtimes
|
|
15396
16007
|
x-codegen-request-body-name: body
|
|
16008
|
+
x-given:
|
|
16009
|
+
downtime:
|
|
16010
|
+
parameters:
|
|
16011
|
+
- name: body
|
|
16012
|
+
value: "{\n \"message\": \"{{ unique }}\",\n \"start\": {{ timestamp(\"now\")
|
|
16013
|
+
}},\n \"timezone\": \"Etc/UTC\",\n \"scope\": [\"test:{{ unique_lower_alnum
|
|
16014
|
+
}}\"],\n \"recurrence\": {\n \"type\": \"weeks\",\n \"period\":
|
|
16015
|
+
1,\n \"week_days\": [\"Mon\", \"Tue\", \"Wed\", \"Thu\", \"Fri\"],\n
|
|
16016
|
+
\ \"until_date\": {{ timestamp(\"now + 21d\")}}\n }\n}"
|
|
16017
|
+
step: there is a valid "downtime" in the system
|
|
15397
16018
|
x-menu-order: 2
|
|
15398
16019
|
x-undo:
|
|
15399
|
-
operationId:
|
|
15400
|
-
parameters:
|
|
16020
|
+
operationId: CancelDowntime
|
|
16021
|
+
parameters:
|
|
16022
|
+
- name: downtime_id
|
|
16023
|
+
source: id
|
|
15401
16024
|
type: unsafe
|
|
15402
16025
|
/api/v1/downtime/cancel/by_scope:
|
|
15403
16026
|
post:
|
|
@@ -15520,7 +16143,8 @@ paths:
|
|
|
15520
16143
|
security:
|
|
15521
16144
|
- apiKeyAuth: []
|
|
15522
16145
|
appKeyAuth: []
|
|
15523
|
-
- AuthZ:
|
|
16146
|
+
- AuthZ:
|
|
16147
|
+
- monitors_read
|
|
15524
16148
|
summary: Get a downtime
|
|
15525
16149
|
tags:
|
|
15526
16150
|
- Downtimes
|
|
@@ -17497,12 +18121,12 @@ paths:
|
|
|
17497
18121
|
- Webhooks Integration
|
|
17498
18122
|
x-codegen-request-body-name: body
|
|
17499
18123
|
x-given:
|
|
17500
|
-
|
|
18124
|
+
webhook_custom_variable:
|
|
17501
18125
|
parameters:
|
|
17502
18126
|
- name: body
|
|
17503
18127
|
value: "{\n \"name\": \"{{ unique_upper_alnum }}\",\n \"value\": \"variable-value\",\n
|
|
17504
18128
|
\ \"is_secret\": false\n}"
|
|
17505
|
-
step: there is a valid "
|
|
18129
|
+
step: there is a valid "webhook_custom_variable" in the system
|
|
17506
18130
|
x-menu-order: 5
|
|
17507
18131
|
x-undo:
|
|
17508
18132
|
operationId: DeleteWebhooksIntegrationCustomVariable
|
|
@@ -18527,7 +19151,7 @@ paths:
|
|
|
18527
19151
|
example: service:my-app
|
|
18528
19152
|
type: string
|
|
18529
19153
|
- description: If this argument is set to true, then the returned data includes
|
|
18530
|
-
all current downtimes for each monitor.
|
|
19154
|
+
all current active downtimes for each monitor.
|
|
18531
19155
|
in: query
|
|
18532
19156
|
name: with_downtimes
|
|
18533
19157
|
required: false
|
|
@@ -18678,7 +19302,7 @@ paths:
|
|
|
18678
19302
|
|
|
18679
19303
|
- `change_aggr` change, pct_change
|
|
18680
19304
|
|
|
18681
|
-
- `time_aggr` avg, sum, max, min [Learn more](https://docs.datadoghq.com/monitors/
|
|
19305
|
+
- `time_aggr` avg, sum, max, min [Learn more](https://docs.datadoghq.com/monitors/create/types/#define-the-conditions)
|
|
18682
19306
|
|
|
18683
19307
|
- `time_window` last\_#m (between 1 and 2880 depending on the monitor type),
|
|
18684
19308
|
last\_#h (between 1 and 48 depending on the monitor type), or last_#d (1 or
|
|
@@ -18776,7 +19400,8 @@ paths:
|
|
|
18776
19400
|
- **`#`** an integer or decimal number used to set the threshold.
|
|
18777
19401
|
|
|
18778
19402
|
|
|
18779
|
-
**NOTE** Only available on US1-FED, US3, and in closed beta on EU and
|
|
19403
|
+
**NOTE** Only available on US1-FED, US3, US5 and in closed beta on EU and
|
|
19404
|
+
US1.
|
|
18780
19405
|
|
|
18781
19406
|
|
|
18782
19407
|
**Process Alert Query**
|
|
@@ -18889,7 +19514,8 @@ paths:
|
|
|
18889
19514
|
- **`#`** an integer or decimal number used to set the threshold.
|
|
18890
19515
|
|
|
18891
19516
|
|
|
18892
|
-
**NOTE** Only available on US1-FED and in closed beta on EU, US3, and
|
|
19517
|
+
**NOTE** Only available on US1-FED and in closed beta on US1, EU, US3, and
|
|
19518
|
+
US5.'
|
|
18893
19519
|
operationId: CreateMonitor
|
|
18894
19520
|
requestBody:
|
|
18895
19521
|
content:
|
|
@@ -18939,6 +19565,12 @@ paths:
|
|
|
18939
19565
|
tags:
|
|
18940
19566
|
- Monitors
|
|
18941
19567
|
x-codegen-request-body-name: body
|
|
19568
|
+
x-given:
|
|
19569
|
+
monitor:
|
|
19570
|
+
parameters:
|
|
19571
|
+
- file: monitor_payload.json
|
|
19572
|
+
name: body
|
|
19573
|
+
step: there is a valid "monitor" in the system
|
|
18942
19574
|
x-menu-order: 1
|
|
18943
19575
|
x-undo:
|
|
18944
19576
|
operationId: DeleteMonitor
|
|
@@ -18952,6 +19584,7 @@ paths:
|
|
|
18952
19584
|
operationId: CheckCanDeleteMonitor
|
|
18953
19585
|
parameters:
|
|
18954
19586
|
- description: The IDs of the monitor to check.
|
|
19587
|
+
explode: false
|
|
18955
19588
|
in: query
|
|
18956
19589
|
name: monitor_ids
|
|
18957
19590
|
required: true
|
|
@@ -18960,6 +19593,7 @@ paths:
|
|
|
18960
19593
|
format: int64
|
|
18961
19594
|
type: integer
|
|
18962
19595
|
type: array
|
|
19596
|
+
style: form
|
|
18963
19597
|
responses:
|
|
18964
19598
|
'200':
|
|
18965
19599
|
content:
|
|
@@ -19016,7 +19650,7 @@ paths:
|
|
|
19016
19650
|
|
|
19017
19651
|
[1]: https://app.datadoghq.com/monitors/manage
|
|
19018
19652
|
|
|
19019
|
-
[2]: /monitors/
|
|
19653
|
+
[2]: /monitors/manage/#find-the-monitors'
|
|
19020
19654
|
in: query
|
|
19021
19655
|
name: query
|
|
19022
19656
|
required: false
|
|
@@ -19103,7 +19737,7 @@ paths:
|
|
|
19103
19737
|
|
|
19104
19738
|
[1]: https://app.datadoghq.com/monitors/manage
|
|
19105
19739
|
|
|
19106
|
-
[2]: /monitors/
|
|
19740
|
+
[2]: /monitors/manage/#find-the-monitors'
|
|
19107
19741
|
in: query
|
|
19108
19742
|
name: query
|
|
19109
19743
|
required: false
|
|
@@ -19571,7 +20205,7 @@ paths:
|
|
|
19571
20205
|
format: int64
|
|
19572
20206
|
type: integer
|
|
19573
20207
|
style: form
|
|
19574
|
-
- description: Sort by field `modified` or `
|
|
20208
|
+
- description: Sort by field `modified`, `name`, or `created`.
|
|
19575
20209
|
in: query
|
|
19576
20210
|
name: sort_field
|
|
19577
20211
|
required: false
|
|
@@ -19608,6 +20242,25 @@ paths:
|
|
|
19608
20242
|
example: false
|
|
19609
20243
|
type: boolean
|
|
19610
20244
|
style: form
|
|
20245
|
+
- description: True value returns only template notebooks. Default is false
|
|
20246
|
+
(returns only non-template notebooks).
|
|
20247
|
+
in: query
|
|
20248
|
+
name: is_template
|
|
20249
|
+
required: false
|
|
20250
|
+
schema:
|
|
20251
|
+
default: false
|
|
20252
|
+
example: false
|
|
20253
|
+
type: boolean
|
|
20254
|
+
style: form
|
|
20255
|
+
- description: If type is provided, returns only notebooks with that metadata
|
|
20256
|
+
type. Default does not have type filtering.
|
|
20257
|
+
in: query
|
|
20258
|
+
name: type
|
|
20259
|
+
required: false
|
|
20260
|
+
schema:
|
|
20261
|
+
example: investigation
|
|
20262
|
+
type: string
|
|
20263
|
+
style: form
|
|
19611
20264
|
responses:
|
|
19612
20265
|
'200':
|
|
19613
20266
|
content:
|
|
@@ -20209,9 +20862,16 @@ paths:
|
|
|
20209
20862
|
100 bytes. However, with the DogStatsD API,\ncompression is applied, which
|
|
20210
20863
|
reduces the payload size."
|
|
20211
20864
|
operationId: SubmitMetrics
|
|
20865
|
+
parameters:
|
|
20866
|
+
- description: HTTP header used to compress the media-type.
|
|
20867
|
+
in: header
|
|
20868
|
+
name: Content-Encoding
|
|
20869
|
+
required: false
|
|
20870
|
+
schema:
|
|
20871
|
+
$ref: '#/components/schemas/MetricContentEncoding'
|
|
20212
20872
|
requestBody:
|
|
20213
20873
|
content:
|
|
20214
|
-
|
|
20874
|
+
text/json:
|
|
20215
20875
|
examples:
|
|
20216
20876
|
dynamic-points:
|
|
20217
20877
|
description: "Post time-series data that can be graphed on Datadog\u2019s
|
|
@@ -20231,31 +20891,31 @@ paths:
|
|
|
20231
20891
|
responses:
|
|
20232
20892
|
'202':
|
|
20233
20893
|
content:
|
|
20234
|
-
|
|
20894
|
+
text/json:
|
|
20235
20895
|
schema:
|
|
20236
20896
|
$ref: '#/components/schemas/IntakePayloadAccepted'
|
|
20237
20897
|
description: Payload accepted
|
|
20238
20898
|
'400':
|
|
20239
20899
|
content:
|
|
20240
|
-
|
|
20900
|
+
text/json:
|
|
20241
20901
|
schema:
|
|
20242
20902
|
$ref: '#/components/schemas/APIErrorResponse'
|
|
20243
20903
|
description: Bad Request
|
|
20244
20904
|
'403':
|
|
20245
20905
|
content:
|
|
20246
|
-
|
|
20906
|
+
text/json:
|
|
20247
20907
|
schema:
|
|
20248
20908
|
$ref: '#/components/schemas/APIErrorResponse'
|
|
20249
20909
|
description: Authentication error
|
|
20250
20910
|
'408':
|
|
20251
20911
|
content:
|
|
20252
|
-
|
|
20912
|
+
text/json:
|
|
20253
20913
|
schema:
|
|
20254
20914
|
$ref: '#/components/schemas/APIErrorResponse'
|
|
20255
20915
|
description: Request timeout
|
|
20256
20916
|
'413':
|
|
20257
20917
|
content:
|
|
20258
|
-
|
|
20918
|
+
text/json:
|
|
20259
20919
|
schema:
|
|
20260
20920
|
$ref: '#/components/schemas/APIErrorResponse'
|
|
20261
20921
|
description: Payload too large
|
|
@@ -20496,7 +21156,7 @@ paths:
|
|
|
20496
21156
|
type: safe
|
|
20497
21157
|
/api/v1/slo/correction:
|
|
20498
21158
|
get:
|
|
20499
|
-
description: Get all Service Level Objective corrections
|
|
21159
|
+
description: Get all Service Level Objective corrections.
|
|
20500
21160
|
operationId: ListSLOCorrection
|
|
20501
21161
|
responses:
|
|
20502
21162
|
'200':
|
|
@@ -20521,7 +21181,7 @@ paths:
|
|
|
20521
21181
|
|
|
20522
21182
|
If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).'
|
|
20523
21183
|
post:
|
|
20524
|
-
description: Create an SLO Correction
|
|
21184
|
+
description: Create an SLO Correction.
|
|
20525
21185
|
operationId: CreateSLOCorrection
|
|
20526
21186
|
requestBody:
|
|
20527
21187
|
content:
|
|
@@ -20581,10 +21241,10 @@ paths:
|
|
|
20581
21241
|
If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).'
|
|
20582
21242
|
/api/v1/slo/correction/{slo_correction_id}:
|
|
20583
21243
|
delete:
|
|
20584
|
-
description: Permanently delete the specified SLO correction object
|
|
21244
|
+
description: Permanently delete the specified SLO correction object.
|
|
20585
21245
|
operationId: DeleteSLOCorrection
|
|
20586
21246
|
parameters:
|
|
20587
|
-
- description: The ID of the SLO correction object
|
|
21247
|
+
- description: The ID of the SLO correction object.
|
|
20588
21248
|
in: path
|
|
20589
21249
|
name: slo_correction_id
|
|
20590
21250
|
required: true
|
|
@@ -20615,10 +21275,10 @@ paths:
|
|
|
20615
21275
|
|
|
20616
21276
|
If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).'
|
|
20617
21277
|
get:
|
|
20618
|
-
description: Get an SLO correction
|
|
21278
|
+
description: Get an SLO correction.
|
|
20619
21279
|
operationId: GetSLOCorrection
|
|
20620
21280
|
parameters:
|
|
20621
|
-
- description: The ID of the SLO correction object
|
|
21281
|
+
- description: The ID of the SLO correction object.
|
|
20622
21282
|
in: path
|
|
20623
21283
|
name: slo_correction_id
|
|
20624
21284
|
required: true
|
|
@@ -20653,10 +21313,10 @@ paths:
|
|
|
20653
21313
|
|
|
20654
21314
|
If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).'
|
|
20655
21315
|
patch:
|
|
20656
|
-
description: Update the specified SLO correction object object
|
|
21316
|
+
description: Update the specified SLO correction object object.
|
|
20657
21317
|
operationId: UpdateSLOCorrection
|
|
20658
21318
|
parameters:
|
|
20659
|
-
- description: The ID of the SLO correction object
|
|
21319
|
+
- description: The ID of the SLO correction object.
|
|
20660
21320
|
in: path
|
|
20661
21321
|
name: slo_correction_id
|
|
20662
21322
|
required: true
|
|
@@ -20932,6 +21592,36 @@ paths:
|
|
|
20932
21592
|
x-unstable: '**Note**: This endpoint is in public beta.
|
|
20933
21593
|
|
|
20934
21594
|
If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).'
|
|
21595
|
+
/api/v1/synthetics/ci/batch/{batch_id}:
|
|
21596
|
+
get:
|
|
21597
|
+
description: Get a batch's updated details.
|
|
21598
|
+
operationId: GetSyntheticsCIBatch
|
|
21599
|
+
parameters:
|
|
21600
|
+
- description: The ID of the batch.
|
|
21601
|
+
in: path
|
|
21602
|
+
name: batch_id
|
|
21603
|
+
required: true
|
|
21604
|
+
schema:
|
|
21605
|
+
type: string
|
|
21606
|
+
responses:
|
|
21607
|
+
'200':
|
|
21608
|
+
content:
|
|
21609
|
+
application/json:
|
|
21610
|
+
schema:
|
|
21611
|
+
$ref: '#/components/schemas/SyntheticsBatchDetails'
|
|
21612
|
+
description: OK
|
|
21613
|
+
'404':
|
|
21614
|
+
content:
|
|
21615
|
+
application/json:
|
|
21616
|
+
schema:
|
|
21617
|
+
$ref: '#/components/schemas/APIErrorResponse'
|
|
21618
|
+
description: Batch does not exist.
|
|
21619
|
+
summary: Get details of batch
|
|
21620
|
+
tags:
|
|
21621
|
+
- Synthetics
|
|
21622
|
+
x-menu-order: 26
|
|
21623
|
+
x-undo:
|
|
21624
|
+
type: safe
|
|
20935
21625
|
/api/v1/synthetics/locations:
|
|
20936
21626
|
get:
|
|
20937
21627
|
description: 'Get the list of public and private locations available for Synthetic
|
|
@@ -21176,6 +21866,12 @@ paths:
|
|
|
21176
21866
|
tags:
|
|
21177
21867
|
- Synthetics
|
|
21178
21868
|
x-codegen-request-body-name: body
|
|
21869
|
+
x-given:
|
|
21870
|
+
synthetics_api_test:
|
|
21871
|
+
parameters:
|
|
21872
|
+
- file: synthetics_api_test_payload.json
|
|
21873
|
+
name: body
|
|
21874
|
+
step: there is a valid "synthetics_api_test" in the system
|
|
21179
21875
|
x-menu-order: 1
|
|
21180
21876
|
x-undo:
|
|
21181
21877
|
operationId: DeleteTests
|
|
@@ -22666,7 +23362,7 @@ paths:
|
|
|
22666
23362
|
summary: Get hourly usage for Cloud Workload Security
|
|
22667
23363
|
tags:
|
|
22668
23364
|
- Usage Metering
|
|
22669
|
-
x-menu-order:
|
|
23365
|
+
x-menu-order: 32
|
|
22670
23366
|
x-undo:
|
|
22671
23367
|
type: safe
|
|
22672
23368
|
/api/v1/usage/dbm:
|
|
@@ -22714,7 +23410,7 @@ paths:
|
|
|
22714
23410
|
summary: Get hourly usage for Database Monitoring
|
|
22715
23411
|
tags:
|
|
22716
23412
|
- Usage Metering
|
|
22717
|
-
x-menu-order:
|
|
23413
|
+
x-menu-order: 33
|
|
22718
23414
|
x-undo:
|
|
22719
23415
|
type: safe
|
|
22720
23416
|
/api/v1/usage/fargate:
|
|
@@ -23401,6 +24097,54 @@ paths:
|
|
|
23401
24097
|
x-menu-order: 13
|
|
23402
24098
|
x-undo:
|
|
23403
24099
|
type: safe
|
|
24100
|
+
/api/v1/usage/sds:
|
|
24101
|
+
get:
|
|
24102
|
+
description: Get hourly usage for Sensitive Data Scanner.
|
|
24103
|
+
operationId: GetUsageSDS
|
|
24104
|
+
parameters:
|
|
24105
|
+
- description: 'Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]`
|
|
24106
|
+
for usage beginning at this hour.'
|
|
24107
|
+
in: query
|
|
24108
|
+
name: start_hr
|
|
24109
|
+
required: true
|
|
24110
|
+
schema:
|
|
24111
|
+
format: date-time
|
|
24112
|
+
type: string
|
|
24113
|
+
- description: 'Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]`
|
|
24114
|
+
for usage ending
|
|
24115
|
+
|
|
24116
|
+
**before** this hour.'
|
|
24117
|
+
in: query
|
|
24118
|
+
name: end_hr
|
|
24119
|
+
required: false
|
|
24120
|
+
schema:
|
|
24121
|
+
format: date-time
|
|
24122
|
+
type: string
|
|
24123
|
+
responses:
|
|
24124
|
+
'200':
|
|
24125
|
+
content:
|
|
24126
|
+
application/json;datetime-format=rfc3339:
|
|
24127
|
+
schema:
|
|
24128
|
+
$ref: '#/components/schemas/UsageSDSResponse'
|
|
24129
|
+
description: OK
|
|
24130
|
+
'400':
|
|
24131
|
+
content:
|
|
24132
|
+
application/json;datetime-format=rfc3339:
|
|
24133
|
+
schema:
|
|
24134
|
+
$ref: '#/components/schemas/APIErrorResponse'
|
|
24135
|
+
description: Bad Request
|
|
24136
|
+
'403':
|
|
24137
|
+
content:
|
|
24138
|
+
application/json;datetime-format=rfc3339:
|
|
24139
|
+
schema:
|
|
24140
|
+
$ref: '#/components/schemas/APIErrorResponse'
|
|
24141
|
+
description: Forbidden - User is not authorized
|
|
24142
|
+
summary: Get hourly usage for Sensitive Data Scanner
|
|
24143
|
+
tags:
|
|
24144
|
+
- Usage Metering
|
|
24145
|
+
x-menu-order: 34
|
|
24146
|
+
x-undo:
|
|
24147
|
+
type: safe
|
|
23404
24148
|
/api/v1/usage/snmp:
|
|
23405
24149
|
get:
|
|
23406
24150
|
description: Get hourly usage for SNMP devices.
|
|
@@ -24183,6 +24927,7 @@ paths:
|
|
|
24183
24927
|
enum:
|
|
24184
24928
|
- datadoghq.com
|
|
24185
24929
|
- us3.datadoghq.com
|
|
24930
|
+
- us5.datadoghq.com
|
|
24186
24931
|
- datadoghq.eu
|
|
24187
24932
|
- ddog-gov.com
|
|
24188
24933
|
subdomain:
|
|
@@ -24223,6 +24968,7 @@ servers:
|
|
|
24223
24968
|
enum:
|
|
24224
24969
|
- datadoghq.com
|
|
24225
24970
|
- us3.datadoghq.com
|
|
24971
|
+
- us5.datadoghq.com
|
|
24226
24972
|
- datadoghq.eu
|
|
24227
24973
|
- ddog-gov.com
|
|
24228
24974
|
subdomain:
|
|
@@ -24284,7 +25030,8 @@ tags:
|
|
|
24284
25030
|
|
|
24285
25031
|
find, and share all of your dashboards with your team and organization.'
|
|
24286
25032
|
name: Dashboards
|
|
24287
|
-
- description: '[Downtiming](https://docs.datadoghq.com/monitors/downtimes)
|
|
25033
|
+
- description: '[Downtiming](https://docs.datadoghq.com/monitors/notify/downtimes)
|
|
25034
|
+
gives
|
|
24288
25035
|
|
|
24289
25036
|
you greater control over monitor notifications by allowing you to globally exclude
|
|
24290
25037
|
|
|
@@ -24361,10 +25108,10 @@ tags:
|
|
|
24361
25108
|
notifies your team when a defined threshold has exceeded.
|
|
24362
25109
|
|
|
24363
25110
|
|
|
24364
|
-
For more information, see [Creating Monitors](https://docs.datadoghq.com/monitors/
|
|
25111
|
+
For more information, see [Creating Monitors](https://docs.datadoghq.com/monitors/create/types/).'
|
|
24365
25112
|
externalDocs:
|
|
24366
25113
|
description: Find out more at
|
|
24367
|
-
url: https://docs.datadoghq.com/monitors/
|
|
25114
|
+
url: https://docs.datadoghq.com/monitors/create/types/
|
|
24368
25115
|
name: Monitors
|
|
24369
25116
|
- description: 'Interact with your notebooks through the API to make it easier to
|
|
24370
25117
|
organize, find, and
|
|
@@ -24415,13 +25162,13 @@ tags:
|
|
|
24415
25162
|
- [Read more about Service Check and status codes.][5]
|
|
24416
25163
|
|
|
24417
25164
|
|
|
24418
|
-
[1]: https://docs.datadoghq.com/monitors/
|
|
25165
|
+
[1]: https://docs.datadoghq.com/monitors/create/types/host/?tab=checkalert
|
|
24419
25166
|
|
|
24420
|
-
[2]: https://docs.datadoghq.com/monitors/
|
|
25167
|
+
[2]: https://docs.datadoghq.com/monitors/create/types/process_check/?tab=checkalert
|
|
24421
25168
|
|
|
24422
|
-
[3]: https://docs.datadoghq.com/monitors/
|
|
25169
|
+
[3]: https://docs.datadoghq.com/monitors/create/types/network/?tab=checkalert
|
|
24423
25170
|
|
|
24424
|
-
[4]: https://docs.datadoghq.com/monitors/
|
|
25171
|
+
[4]: https://docs.datadoghq.com/monitors/create/types/custom_check/?tab=checkalert
|
|
24425
25172
|
|
|
24426
25173
|
[5]: https://docs.datadoghq.com/developers/service_checks/'
|
|
24427
25174
|
name: Service Checks
|