datadog_api_client 1.9.0 → 1.10.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/.generator/schemas/v1/openapi.yaml +489 -124
- data/.generator/schemas/v2/openapi.yaml +701 -28
- data/.generator/src/generator/formatter.py +6 -1
- data/.generator/src/generator/openapi.py +5 -5
- data/.generator/src/generator/templates/api_client.j2 +1 -4
- data/.generator/src/generator/templates/model_generic.j2 +42 -3
- data/.github/workflows/prepare_release.yml +15 -3
- data/CHANGELOG.md +32 -0
- data/Makefile +1 -1
- data/README.md +16 -0
- data/check-examples.sh +0 -2
- data/examples/v1/aws-integration/UpdateAWSAccount.rb +8 -4
- data/examples/v1/downtimes/CreateDowntime_2908359488.rb +1 -0
- data/examples/v1/downtimes/CreateDowntime_3059354445.rb +1 -0
- data/examples/v1/downtimes/UpdateDowntime.rb +1 -0
- data/examples/v1/monitors/CreateMonitor_1969035628.rb +52 -0
- data/examples/v1/monitors/CreateMonitor_2520912138.rb +22 -0
- data/examples/v1/security-monitoring/AddSecurityMonitoringSignalToIncident.rb +9 -0
- data/examples/v1/security-monitoring/EditSecurityMonitoringSignalAssignee.rb +9 -0
- data/examples/v1/security-monitoring/EditSecurityMonitoringSignalState.rb +10 -0
- data/examples/v1/service-level-objective-corrections/CreateSLOCorrection.rb +0 -3
- data/examples/v1/service-level-objective-corrections/CreateSLOCorrection_1326388368.rb +0 -3
- data/examples/v1/service-level-objective-corrections/DeleteSLOCorrection.rb +0 -3
- data/examples/v1/service-level-objective-corrections/GetSLOCorrection.rb +0 -3
- data/examples/v1/service-level-objective-corrections/ListSLOCorrection.rb +0 -3
- data/examples/v1/service-level-objective-corrections/UpdateSLOCorrection.rb +0 -3
- data/examples/v1/service-level-objectives/GetSLOCorrections.rb +0 -3
- data/examples/v1/synthetics/CreateSyntheticsAPITest.rb +5 -0
- data/examples/v1/synthetics/CreateSyntheticsAPITest_1402674167.rb +44 -0
- data/examples/v1/synthetics/CreateSyntheticsBrowserTest_2932742688.rb +64 -0
- data/examples/v1/synthetics/UpdateBrowserTest.rb +5 -0
- data/examples/v1/usage-metering/GetHourlyUsageAttribution.rb +1 -1
- data/examples/v1/usage-metering/GetMonthlyUsageAttribution.rb +1 -1
- data/examples/v1/usage-metering/{GetMonthlyUsageAttribution_3738504447.rb → GetMonthlyUsageAttribution_3849653599.rb} +1 -1
- data/examples/v1/usage-metering/GetUsageAttribution.rb +1 -1
- data/examples/v1/usage-metering/GetUsageRumSessions_3271366243.rb +9 -0
- data/examples/v2/logs/SubmitLog.rb +1 -0
- data/examples/v2/logs-archives/CreateLogsArchive.rb +1 -0
- data/examples/v2/logs-archives/UpdateLogsArchive.rb +1 -0
- data/examples/v2/metrics/EstimateMetricsOutputSeries.rb +9 -0
- data/examples/v2/metrics/SubmitMetrics.rb +20 -0
- data/examples/v2/security-monitoring/UpdateSecurityMonitoringRule.rb +1 -0
- data/examples/v2/usage-metering/GetCostByOrg.rb +5 -0
- data/examples/v2/usage-metering/GetUsageApplicationSecurityMonitoring.rb +8 -0
- data/examples/v2/usage-metering/GetUsageLambdaTracedInvocations.rb +8 -0
- data/lib/datadog_api_client/v1/api/metrics_api.rb +1 -1
- data/lib/datadog_api_client/v1/api/monitors_api.rb +69 -56
- data/lib/datadog_api_client/v1/api/security_monitoring_api.rb +266 -0
- data/lib/datadog_api_client/v1/api/service_level_objective_corrections_api.rb +1 -1
- data/lib/datadog_api_client/v1/api/usage_metering_api.rb +10 -10
- data/lib/datadog_api_client/v1/api_client.rb +1 -4
- data/lib/datadog_api_client/v1/configuration.rb +0 -6
- data/lib/datadog_api_client/v1/models/add_signal_to_incident_request.rb +142 -0
- data/lib/datadog_api_client/v1/models/downtime.rb +11 -1
- data/lib/datadog_api_client/v1/models/downtime_child.rb +11 -1
- data/lib/datadog_api_client/v1/models/event.rb +1 -1
- data/lib/datadog_api_client/v1/models/http_log_item.rb +29 -4
- data/lib/datadog_api_client/v1/models/logs_category_processor.rb +1 -1
- data/lib/datadog_api_client/v1/models/logs_list_request.rb +1 -1
- data/lib/datadog_api_client/v1/models/logs_sort.rb +1 -1
- data/lib/datadog_api_client/v1/models/monitor_formula_and_function_events_data_source.rb +1 -0
- data/lib/datadog_api_client/v1/models/monitor_group_search_response_counts.rb +2 -2
- data/lib/datadog_api_client/v1/models/{monitor_search_response_counts_tag_item.rb → monitor_search_count_item.rb} +3 -3
- data/lib/datadog_api_client/v1/models/monitor_search_response_counts.rb +4 -4
- data/lib/datadog_api_client/v1/models/monitor_type.rb +1 -0
- data/lib/datadog_api_client/v1/models/monthly_usage_attribution_response.rb +1 -1
- data/lib/datadog_api_client/v1/models/notebook_cell_create_request.rb +146 -0
- data/lib/datadog_api_client/v1/models/notebook_cell_create_request_attributes.rb +68 -0
- data/lib/datadog_api_client/v1/models/series.rb +2 -2
- data/lib/datadog_api_client/v1/models/signal_archive_reason.rb +29 -0
- data/lib/datadog_api_client/v1/models/signal_assignee_update_request.rb +132 -0
- data/lib/datadog_api_client/v1/models/signal_state_update_request.rb +152 -0
- data/lib/datadog_api_client/v1/models/signal_triage_state.rb +28 -0
- data/lib/datadog_api_client/v1/models/slo_correction_create_request_attributes.rb +1 -1
- data/lib/datadog_api_client/v1/models/slo_correction_response_attributes.rb +4 -4
- data/lib/datadog_api_client/v1/models/slo_correction_update_request_attributes.rb +1 -1
- data/lib/datadog_api_client/v1/models/{monitor_search_response_counts_status_item.rb → successful_signal_update_response.rb} +12 -22
- data/lib/datadog_api_client/v1/models/synthetics_api_test.rb +1 -1
- data/lib/datadog_api_client/v1/models/synthetics_assertion_type.rb +2 -0
- data/lib/datadog_api_client/v1/models/synthetics_browser_test_rum_settings.rb +152 -0
- data/lib/datadog_api_client/v1/models/synthetics_test_details.rb +1 -1
- data/lib/datadog_api_client/v1/models/synthetics_test_details_sub_type.rb +2 -1
- data/lib/datadog_api_client/v1/models/synthetics_test_options.rb +21 -1
- data/lib/datadog_api_client/v1/models/synthetics_test_request.rb +21 -1
- data/lib/datadog_api_client/v1/models/usage_attribution_response.rb +1 -1
- data/lib/datadog_api_client/v1/models/usage_rum_sessions_hour.rb +18 -4
- data/lib/datadog_api_client/v1/models/usage_summary_date.rb +11 -1
- data/lib/datadog_api_client/v1/models/usage_summary_date_org.rb +11 -1
- data/lib/datadog_api_client/v1/models/usage_summary_response.rb +11 -1
- data/lib/datadog_api_client/v1.rb +11 -6
- data/lib/datadog_api_client/v2/api/authn_mappings_api.rb +0 -2
- data/lib/datadog_api_client/v2/api/metrics_api.rb +173 -0
- data/lib/datadog_api_client/v2/api/usage_metering_api.rb +228 -0
- data/lib/datadog_api_client/v2/api_client.rb +1 -4
- data/lib/datadog_api_client/v2/models/authn_mapping.rb +1 -13
- data/lib/datadog_api_client/v2/models/authn_mapping_attributes.rb +1 -12
- data/lib/datadog_api_client/v2/models/authn_mapping_response.rb +16 -4
- data/lib/datadog_api_client/v2/models/authn_mappings_response.rb +13 -1
- data/lib/datadog_api_client/v2/models/chargeback_breakdown.rb +131 -0
- data/lib/datadog_api_client/v2/models/cost_by_org.rb +133 -0
- data/lib/datadog_api_client/v2/models/cost_by_org_attributes.rb +153 -0
- data/lib/datadog_api_client/v2/models/cost_by_org_response.rb +113 -0
- data/lib/datadog_api_client/v2/models/cost_by_org_type.rb +26 -0
- data/lib/datadog_api_client/v2/models/hourly_usage_type.rb +2 -0
- data/lib/datadog_api_client/v2/models/http_log_item.rb +40 -4
- data/lib/datadog_api_client/v2/models/intake_payload_accepted.rb +111 -0
- data/lib/datadog_api_client/v2/models/logs_archive_attributes.rb +12 -1
- data/lib/datadog_api_client/v2/models/logs_archive_create_request_attributes.rb +12 -1
- data/lib/datadog_api_client/v2/models/metric_content_encoding.rb +26 -0
- data/lib/datadog_api_client/v2/models/metric_estimate.rb +133 -0
- data/lib/datadog_api_client/v2/models/metric_estimate_attributes.rb +133 -0
- data/lib/datadog_api_client/v2/models/metric_estimate_resource_type.rb +26 -0
- data/lib/datadog_api_client/v2/models/metric_estimate_response.rb +111 -0
- data/lib/datadog_api_client/v2/models/metric_estimate_type.rb +28 -0
- data/lib/datadog_api_client/v2/models/metric_intake_type.rb +30 -0
- data/lib/datadog_api_client/v2/models/metric_metadata.rb +111 -0
- data/lib/datadog_api_client/v2/models/metric_origin.rb +170 -0
- data/lib/datadog_api_client/{v1/models/monitor_group_search_response_counts_type_item.rb → v2/models/metric_payload.rb} +27 -24
- data/lib/datadog_api_client/v2/models/metric_point.rb +122 -0
- data/lib/datadog_api_client/{v1/models/monitor_search_response_counts_type_item.rb → v2/models/metric_resource.rb} +21 -21
- data/lib/datadog_api_client/v2/models/metric_series.rb +220 -0
- data/lib/datadog_api_client/v2/models/relationship_to_saml_assertion_attribute_data.rb +1 -5
- data/lib/datadog_api_client/v2/models/saml_assertion_attribute.rb +1 -5
- data/lib/datadog_api_client/v2/models/security_monitoring_rule_detection_method.rb +1 -0
- data/lib/datadog_api_client/v2/models/security_monitoring_rule_hardcoded_evaluator_type.rb +26 -0
- data/lib/datadog_api_client/v2/models/security_monitoring_rule_options.rb +11 -1
- data/lib/datadog_api_client/{v1/models/monitor_group_search_response_counts_status_item.rb → v2/models/usage_application_security_monitoring_response.rb} +16 -24
- data/lib/datadog_api_client/{v1/models/monitor_search_response_counts_muted_item.rb → v2/models/usage_lambda_traced_invocations_response.rb} +16 -24
- data/lib/datadog_api_client/v2.rb +22 -0
- data/lib/datadog_api_client/version.rb +1 -1
- data/spec/v1/api_client_spec.rb +3 -3
- data/spec/v2/api_client_spec.rb +3 -3
- metadata +49 -11
- data/extract-code-blocks.awk +0 -81
- data/extract-code-blocks.sh +0 -3
@@ -4,6 +4,13 @@ components:
|
|
4
4
|
headers: {}
|
5
5
|
links: {}
|
6
6
|
parameters:
|
7
|
+
SignalID:
|
8
|
+
description: The ID of the signal.
|
9
|
+
in: path
|
10
|
+
name: signal_id
|
11
|
+
required: true
|
12
|
+
schema:
|
13
|
+
type: string
|
7
14
|
SlackAccountNamePathParameter:
|
8
15
|
description: Your Slack account name.
|
9
16
|
in: path
|
@@ -360,6 +367,23 @@ components:
|
|
360
367
|
- ADMIN
|
361
368
|
- READ_ONLY
|
362
369
|
- ERROR
|
370
|
+
AddSignalToIncidentRequest:
|
371
|
+
description: Attributes describing which incident to add the signal to.
|
372
|
+
properties:
|
373
|
+
add_to_signal_timeline:
|
374
|
+
description: Whether to post the signal on the incident timeline.
|
375
|
+
type: boolean
|
376
|
+
incident_id:
|
377
|
+
description: Public ID attribute of the incident to which the signal will
|
378
|
+
be added.
|
379
|
+
example: 2066
|
380
|
+
format: int64
|
381
|
+
type: integer
|
382
|
+
version:
|
383
|
+
$ref: '#/components/schemas/Version'
|
384
|
+
required:
|
385
|
+
- incident_id
|
386
|
+
type: object
|
363
387
|
AgentCheck:
|
364
388
|
description: Array of strings.
|
365
389
|
example:
|
@@ -1499,6 +1523,11 @@ components:
|
|
1499
1523
|
description: A monitor tag.
|
1500
1524
|
type: string
|
1501
1525
|
type: array
|
1526
|
+
mute_first_recovery_notification:
|
1527
|
+
description: If the first recovery notification during a downtime should
|
1528
|
+
be muted.
|
1529
|
+
example: false
|
1530
|
+
type: boolean
|
1502
1531
|
parent_id:
|
1503
1532
|
description: ID of the parent Downtime.
|
1504
1533
|
example: 123
|
@@ -1628,6 +1657,11 @@ components:
|
|
1628
1657
|
description: A monitor tag.
|
1629
1658
|
type: string
|
1630
1659
|
type: array
|
1660
|
+
mute_first_recovery_notification:
|
1661
|
+
description: If the first recovery notification during a downtime should
|
1662
|
+
be muted.
|
1663
|
+
example: false
|
1664
|
+
type: boolean
|
1631
1665
|
parent_id:
|
1632
1666
|
description: ID of the parent Downtime.
|
1633
1667
|
example: 123
|
@@ -1783,7 +1817,7 @@ components:
|
|
1783
1817
|
description: 'The type of event being posted. Option examples include nagios,
|
1784
1818
|
hudson, jenkins, my_apps, chef, puppet, git, bitbucket, etc.
|
1785
1819
|
|
1786
|
-
|
1820
|
+
The list of standard source attribute values [available here](https://docs.datadoghq.com/integrations/faq/list-of-api-source-attribute-value).'
|
1787
1821
|
type: string
|
1788
1822
|
tags:
|
1789
1823
|
description: A list of tags to apply to the event.
|
@@ -2887,6 +2921,9 @@ components:
|
|
2887
2921
|
- message
|
2888
2922
|
type: object
|
2889
2923
|
HTTPLogItem:
|
2924
|
+
additionalProperties:
|
2925
|
+
description: Additional log attributes.
|
2926
|
+
type: string
|
2890
2927
|
description: Logs that are sent over HTTP.
|
2891
2928
|
properties:
|
2892
2929
|
ddsource:
|
@@ -4298,7 +4335,7 @@ components:
|
|
4298
4335
|
categories:
|
4299
4336
|
description: 'Array of filters to match or not a log and their
|
4300
4337
|
|
4301
|
-
corresponding `name`to assign a custom value to the log.'
|
4338
|
+
corresponding `name` to assign a custom value to the log.'
|
4302
4339
|
example: []
|
4303
4340
|
items:
|
4304
4341
|
$ref: '#/components/schemas/LogsCategoryProcessorCategory'
|
@@ -5084,7 +5121,7 @@ components:
|
|
5084
5121
|
x-enum-varnames:
|
5085
5122
|
- SERVICE_REMAPPER
|
5086
5123
|
LogsSort:
|
5087
|
-
description: Time-ascending `asc` or time-descending `desc`results.
|
5124
|
+
description: Time-ascending `asc` or time-descending `desc` results.
|
5088
5125
|
enum:
|
5089
5126
|
- asc
|
5090
5127
|
- desc
|
@@ -5801,11 +5838,13 @@ components:
|
|
5801
5838
|
enum:
|
5802
5839
|
- rum
|
5803
5840
|
- ci_pipelines
|
5841
|
+
- ci_tests
|
5804
5842
|
example: rum
|
5805
5843
|
type: string
|
5806
5844
|
x-enum-varnames:
|
5807
5845
|
- RUM
|
5808
5846
|
- CI_PIPELINES
|
5847
|
+
- CI_TESTS
|
5809
5848
|
MonitorFormulaAndFunctionQueryDefinition:
|
5810
5849
|
description: A formula and function query.
|
5811
5850
|
oneOf:
|
@@ -6059,7 +6098,8 @@ components:
|
|
6059
6098
|
type: boolean
|
6060
6099
|
silenced:
|
6061
6100
|
additionalProperties:
|
6062
|
-
description:
|
6101
|
+
description: UTC epoch timestamp in seconds when the downtime for the
|
6102
|
+
group expires.
|
6063
6103
|
format: int64
|
6064
6104
|
nullable: true
|
6065
6105
|
type: integer
|
@@ -6499,6 +6539,7 @@ components:
|
|
6499
6539
|
- event-v2 alert
|
6500
6540
|
- audit alert
|
6501
6541
|
- ci-pipelines alert
|
6542
|
+
- ci-tests alert
|
6502
6543
|
- error-tracking alert
|
6503
6544
|
example: query alert
|
6504
6545
|
type: string
|
@@ -6517,6 +6558,7 @@ components:
|
|
6517
6558
|
- EVENT_V2_ALERT
|
6518
6559
|
- AUDIT_ALERT
|
6519
6560
|
- CI_PIPELINES_ALERT
|
6561
|
+
- CI_TESTS_ALERT
|
6520
6562
|
- ERROR_TRACKING_ALERT
|
6521
6563
|
MonitorUpdateRequest:
|
6522
6564
|
description: Object describing a monitor update request.
|
@@ -6641,7 +6683,7 @@ components:
|
|
6641
6683
|
metadata:
|
6642
6684
|
$ref: '#/components/schemas/MonthlyUsageAttributionMetadata'
|
6643
6685
|
usage:
|
6644
|
-
description: Get
|
6686
|
+
description: Get usage summary by tag(s).
|
6645
6687
|
items:
|
6646
6688
|
$ref: '#/components/schemas/MonthlyUsageAttributionBody'
|
6647
6689
|
type: array
|
@@ -8195,7 +8237,7 @@ components:
|
|
8195
8237
|
example: FREQ=DAILY;INTERVAL=10;COUNT=5
|
8196
8238
|
type: string
|
8197
8239
|
slo_id:
|
8198
|
-
description: ID of the SLO that this correction
|
8240
|
+
description: ID of the SLO that this correction applies to.
|
8199
8241
|
example: sloId
|
8200
8242
|
type: string
|
8201
8243
|
start:
|
@@ -8236,7 +8278,7 @@ components:
|
|
8236
8278
|
category:
|
8237
8279
|
$ref: '#/components/schemas/SLOCorrectionCategory'
|
8238
8280
|
created_at:
|
8239
|
-
description: The epoch timestamp of when the correction was created at
|
8281
|
+
description: The epoch timestamp of when the correction was created at.
|
8240
8282
|
format: int64
|
8241
8283
|
type: integer
|
8242
8284
|
creator:
|
@@ -8256,7 +8298,7 @@ components:
|
|
8256
8298
|
format: int64
|
8257
8299
|
type: integer
|
8258
8300
|
modified_at:
|
8259
|
-
description: The epoch timestamp of when the correction was modified at
|
8301
|
+
description: The epoch timestamp of when the correction was modified at.
|
8260
8302
|
format: int64
|
8261
8303
|
type: integer
|
8262
8304
|
modifier:
|
@@ -8265,12 +8307,12 @@ components:
|
|
8265
8307
|
description: 'The recurrence rules as defined in the iCalendar RFC 5545.
|
8266
8308
|
The supported rules for SLO corrections
|
8267
8309
|
|
8268
|
-
are `FREQ`, `INTERVAL`, `COUNT
|
8310
|
+
are `FREQ`, `INTERVAL`, `COUNT`, and `UNTIL`.'
|
8269
8311
|
example: FREQ=DAILY;INTERVAL=10;COUNT=5
|
8270
8312
|
nullable: true
|
8271
8313
|
type: string
|
8272
8314
|
slo_id:
|
8273
|
-
description: ID of the SLO that this correction
|
8315
|
+
description: ID of the SLO that this correction applies to.
|
8274
8316
|
type: string
|
8275
8317
|
start:
|
8276
8318
|
description: Starting time of the correction in epoch seconds.
|
@@ -8341,7 +8383,7 @@ components:
|
|
8341
8383
|
description: 'The recurrence rules as defined in the iCalendar RFC 5545.
|
8342
8384
|
The supported rules for SLO corrections
|
8343
8385
|
|
8344
|
-
are `FREQ`, `INTERVAL`, `COUNT
|
8386
|
+
are `FREQ`, `INTERVAL`, `COUNT`, and `UNTIL`.'
|
8345
8387
|
example: FREQ=DAILY;INTERVAL=10;COUNT=5
|
8346
8388
|
type: string
|
8347
8389
|
start:
|
@@ -9340,8 +9382,9 @@ components:
|
|
9340
9382
|
type: string
|
9341
9383
|
type: array
|
9342
9384
|
type:
|
9343
|
-
default:
|
9344
|
-
description: The type of the metric
|
9385
|
+
default: ''
|
9386
|
+
description: The type of the metric. Valid types are "",`count`, `gauge`,
|
9387
|
+
and `rate`.
|
9345
9388
|
example: rate
|
9346
9389
|
type: string
|
9347
9390
|
required:
|
@@ -9747,6 +9790,59 @@ components:
|
|
9747
9790
|
type: string
|
9748
9791
|
x-enum-varnames:
|
9749
9792
|
- TRACE_SERVICE
|
9793
|
+
SignalArchiveReason:
|
9794
|
+
description: Reason why a signal has been archived.
|
9795
|
+
enum:
|
9796
|
+
- none
|
9797
|
+
- false_positive
|
9798
|
+
- testing_or_maintenance
|
9799
|
+
- other
|
9800
|
+
type: string
|
9801
|
+
x-enum-varnames:
|
9802
|
+
- NONE
|
9803
|
+
- FALSE_POSITIVE
|
9804
|
+
- TESTING_OR_MAINTENANCE
|
9805
|
+
- OTHER
|
9806
|
+
SignalAssigneeUpdateRequest:
|
9807
|
+
description: Attributes describing an assignee update operation over a security
|
9808
|
+
signal.
|
9809
|
+
properties:
|
9810
|
+
assignee:
|
9811
|
+
description: The UUID of the user being assigned. Use empty string to return
|
9812
|
+
signal to unassigned.
|
9813
|
+
example: 773b045d-ccf8-4808-bd3b-955ef6a8c940
|
9814
|
+
type: string
|
9815
|
+
version:
|
9816
|
+
$ref: '#/components/schemas/Version'
|
9817
|
+
required:
|
9818
|
+
- assignee
|
9819
|
+
type: object
|
9820
|
+
SignalStateUpdateRequest:
|
9821
|
+
description: Attributes describing the change of state for a given state.
|
9822
|
+
properties:
|
9823
|
+
archiveComment:
|
9824
|
+
description: Optional comment to explain why a signal is being archived.
|
9825
|
+
type: string
|
9826
|
+
archiveReason:
|
9827
|
+
$ref: '#/components/schemas/SignalArchiveReason'
|
9828
|
+
state:
|
9829
|
+
$ref: '#/components/schemas/SignalTriageState'
|
9830
|
+
version:
|
9831
|
+
$ref: '#/components/schemas/Version'
|
9832
|
+
required:
|
9833
|
+
- state
|
9834
|
+
type: object
|
9835
|
+
SignalTriageState:
|
9836
|
+
description: The new triage state of the signal.
|
9837
|
+
enum:
|
9838
|
+
- open
|
9839
|
+
- archived
|
9840
|
+
- under_review
|
9841
|
+
type: string
|
9842
|
+
x-enum-varnames:
|
9843
|
+
- OPEN
|
9844
|
+
- ARCHIVED
|
9845
|
+
- UNDER_REVIEW
|
9750
9846
|
SlackIntegrationChannel:
|
9751
9847
|
description: The Slack channel configuration.
|
9752
9848
|
properties:
|
@@ -9795,6 +9891,13 @@ components:
|
|
9795
9891
|
items:
|
9796
9892
|
$ref: '#/components/schemas/SlackIntegrationChannel'
|
9797
9893
|
type: array
|
9894
|
+
SuccessfulSignalUpdateResponse:
|
9895
|
+
description: Updated signal data following a successfully performed update.
|
9896
|
+
properties:
|
9897
|
+
status:
|
9898
|
+
description: Status of the response.
|
9899
|
+
type: string
|
9900
|
+
type: object
|
9798
9901
|
SunburstWidgetDefinition:
|
9799
9902
|
description: Sunbursts are spot on to highlight how groups contribute to the
|
9800
9903
|
total of a query.
|
@@ -10350,6 +10453,8 @@ components:
|
|
10350
10453
|
- packetsReceived
|
10351
10454
|
- networkHop
|
10352
10455
|
- receivedMessage
|
10456
|
+
- grpcHealthcheckStatus
|
10457
|
+
- connection
|
10353
10458
|
example: statusCode
|
10354
10459
|
type: string
|
10355
10460
|
x-enum-varnames:
|
@@ -10368,6 +10473,8 @@ components:
|
|
10368
10473
|
- PACKETS_RECEIVED
|
10369
10474
|
- NETWORK_HOP
|
10370
10475
|
- RECEIVED_MESSAGE
|
10476
|
+
- GRPC_HEALTHCHECK_STATUS
|
10477
|
+
- CONNECTION
|
10371
10478
|
SyntheticsBasicAuth:
|
10372
10479
|
description: Object to handle basic authentication when performing the test.
|
10373
10480
|
oneOf:
|
@@ -10853,6 +10960,50 @@ components:
|
|
10853
10960
|
format: int64
|
10854
10961
|
type: integer
|
10855
10962
|
type: object
|
10963
|
+
SyntheticsBrowserTestRumSettings:
|
10964
|
+
description: 'The RUM data collection settings for the Synthetic browser test.
|
10965
|
+
|
10966
|
+
**Note:** There are 3 ways to format RUM settings:
|
10967
|
+
|
10968
|
+
|
10969
|
+
`{ isEnabled: false }`
|
10970
|
+
|
10971
|
+
RUM data is not collected.
|
10972
|
+
|
10973
|
+
|
10974
|
+
`{ isEnabled: true }`
|
10975
|
+
|
10976
|
+
RUM data is collected from the Synthetic test''s default application.
|
10977
|
+
|
10978
|
+
|
10979
|
+
`{ isEnabled: true, applicationId: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
|
10980
|
+
clientTokenId: 12345 }`
|
10981
|
+
|
10982
|
+
RUM data is collected using the specified application.'
|
10983
|
+
example:
|
10984
|
+
applicationId: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
|
10985
|
+
clientTokenId: 12345
|
10986
|
+
isEnabled: true
|
10987
|
+
properties:
|
10988
|
+
applicationId:
|
10989
|
+
description: RUM application ID used to collect RUM data for the browser
|
10990
|
+
test.
|
10991
|
+
example: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
|
10992
|
+
type: string
|
10993
|
+
clientTokenId:
|
10994
|
+
description: RUM application API key ID used to collect RUM data for the
|
10995
|
+
browser test.
|
10996
|
+
example: 12345
|
10997
|
+
format: int64
|
10998
|
+
type: integer
|
10999
|
+
x-secret: true
|
11000
|
+
isEnabled:
|
11001
|
+
description: Determines whether RUM data is collected during test runs.
|
11002
|
+
example: true
|
11003
|
+
type: boolean
|
11004
|
+
required:
|
11005
|
+
- isEnabled
|
11006
|
+
type: object
|
10856
11007
|
SyntheticsBrowserTestType:
|
10857
11008
|
default: browser
|
10858
11009
|
description: Type of the Synthetic test, `browser`.
|
@@ -11827,7 +11978,7 @@ components:
|
|
11827
11978
|
SyntheticsTestDetailsSubType:
|
11828
11979
|
description: 'The subtype of the Synthetic API test, `http`, `ssl`, `tcp`,
|
11829
11980
|
|
11830
|
-
`dns`, `icmp`, `udp`, `websocket` or `multi`.'
|
11981
|
+
`dns`, `icmp`, `udp`, `websocket`, `grpc` or `multi`.'
|
11831
11982
|
enum:
|
11832
11983
|
- http
|
11833
11984
|
- ssl
|
@@ -11837,6 +11988,7 @@ components:
|
|
11837
11988
|
- icmp
|
11838
11989
|
- udp
|
11839
11990
|
- websocket
|
11991
|
+
- grpc
|
11840
11992
|
example: http
|
11841
11993
|
type: string
|
11842
11994
|
x-enum-varnames:
|
@@ -11848,6 +12000,7 @@ components:
|
|
11848
12000
|
- ICMP
|
11849
12001
|
- UDP
|
11850
12002
|
- WEBSOCKET
|
12003
|
+
- GRPC
|
11851
12004
|
SyntheticsTestDetailsType:
|
11852
12005
|
description: Type of the Synthetic test, either `api` or `browser`.
|
11853
12006
|
enum:
|
@@ -11874,6 +12027,12 @@ components:
|
|
11874
12027
|
type: string
|
11875
12028
|
description: Headers to include when performing the test.
|
11876
12029
|
type: object
|
12030
|
+
SyntheticsTestMetadata:
|
12031
|
+
additionalProperties:
|
12032
|
+
description: A single Metadatum.
|
12033
|
+
type: string
|
12034
|
+
description: Metadata to include when performing the gRPC test.
|
12035
|
+
type: object
|
11877
12036
|
SyntheticsTestMonitorStatus:
|
11878
12037
|
description: 'The status of your Synthetic monitor.
|
11879
12038
|
|
@@ -11948,6 +12107,8 @@ components:
|
|
11948
12107
|
$ref: '#/components/schemas/SyntheticsRestrictedRoles'
|
11949
12108
|
retry:
|
11950
12109
|
$ref: '#/components/schemas/SyntheticsTestOptionsRetry'
|
12110
|
+
rumSettings:
|
12111
|
+
$ref: '#/components/schemas/SyntheticsBrowserTestRumSettings'
|
11951
12112
|
tick_every:
|
11952
12113
|
description: The frequency at which to run the Synthetic test (in seconds).
|
11953
12114
|
format: int64
|
@@ -12049,6 +12210,8 @@ components:
|
|
12049
12210
|
message:
|
12050
12211
|
description: Message to send for UDP or WebSocket tests.
|
12051
12212
|
type: string
|
12213
|
+
metadata:
|
12214
|
+
$ref: '#/components/schemas/SyntheticsTestMetadata'
|
12052
12215
|
method:
|
12053
12216
|
$ref: '#/components/schemas/HTTPMethod'
|
12054
12217
|
noSavingResponseBody:
|
@@ -12077,6 +12240,9 @@ components:
|
|
12077
12240
|
|
12078
12241
|
the same IP address and TCP port number.'
|
12079
12242
|
type: string
|
12243
|
+
service:
|
12244
|
+
description: gRPC service on which you want to perform the healthcheck.
|
12245
|
+
type: string
|
12080
12246
|
shouldTrackHops:
|
12081
12247
|
description: Turns on a traceroute probe to discover all gateways along
|
12082
12248
|
the path to the host destination.
|
@@ -12907,7 +13073,7 @@ components:
|
|
12907
13073
|
metadata:
|
12908
13074
|
$ref: '#/components/schemas/UsageAttributionMetadata'
|
12909
13075
|
usage:
|
12910
|
-
description: Get
|
13076
|
+
description: Get usage summary by tag(s).
|
12911
13077
|
items:
|
12912
13078
|
$ref: '#/components/schemas/UsageAttributionBody'
|
12913
13079
|
type: array
|
@@ -14171,16 +14337,25 @@ components:
|
|
14171
14337
|
session_count:
|
14172
14338
|
description: Contains the number of browser RUM Lite Sessions.
|
14173
14339
|
format: int64
|
14340
|
+
nullable: true
|
14174
14341
|
type: integer
|
14175
14342
|
session_count_android:
|
14176
14343
|
description: Contains the number of mobile RUM Sessions on Android (data
|
14177
14344
|
available beginning December 1, 2020).
|
14178
14345
|
format: int64
|
14346
|
+
nullable: true
|
14179
14347
|
type: integer
|
14180
14348
|
session_count_ios:
|
14181
14349
|
description: Contains the number of mobile RUM Sessions on iOS (data available
|
14182
14350
|
beginning December 1, 2020).
|
14183
14351
|
format: int64
|
14352
|
+
nullable: true
|
14353
|
+
type: integer
|
14354
|
+
session_count_reactnative:
|
14355
|
+
description: Contains the number of mobile RUM Sessions on React Native
|
14356
|
+
(data available beginning May 1, 2022).
|
14357
|
+
format: int64
|
14358
|
+
nullable: true
|
14184
14359
|
type: integer
|
14185
14360
|
type: object
|
14186
14361
|
UsageRumSessionsResponse:
|
@@ -14593,6 +14768,11 @@ components:
|
|
14593
14768
|
in the current date for all organizations.
|
14594
14769
|
format: int64
|
14595
14770
|
type: integer
|
14771
|
+
mobile_rum_session_count_reactnative_sum:
|
14772
|
+
description: Shows the sum of all mobile RUM Sessions on React Native over
|
14773
|
+
all hours in the current date for all organizations.
|
14774
|
+
format: int64
|
14775
|
+
type: integer
|
14596
14776
|
mobile_rum_session_count_sum:
|
14597
14777
|
description: Shows the sum of all mobile RUM Sessions over all hours in
|
14598
14778
|
the current date for all organizations
|
@@ -14912,6 +15092,11 @@ components:
|
|
14912
15092
|
in the current date for the given org.
|
14913
15093
|
format: int64
|
14914
15094
|
type: integer
|
15095
|
+
mobile_rum_session_count_reactnative_sum:
|
15096
|
+
description: Shows the sum of all mobile RUM Sessions on React Native over
|
15097
|
+
all hours in the current date for the given org.
|
15098
|
+
format: int64
|
15099
|
+
type: integer
|
14915
15100
|
mobile_rum_session_count_sum:
|
14916
15101
|
description: Shows the sum of all mobile RUM Sessions over all hours in
|
14917
15102
|
the current date for the given org.
|
@@ -15266,6 +15451,11 @@ components:
|
|
15266
15451
|
in the current months for all organizations.
|
15267
15452
|
format: int64
|
15268
15453
|
type: integer
|
15454
|
+
mobile_rum_session_count_reactnative_agg_sum:
|
15455
|
+
description: Shows the sum of all mobile RUM Sessions on React Native over
|
15456
|
+
all hours in the current months for all organizations.
|
15457
|
+
format: int64
|
15458
|
+
type: integer
|
15269
15459
|
mobile_rum_units_agg_sum:
|
15270
15460
|
description: Shows the sum of all mobile RUM units over all hours in the
|
15271
15461
|
current months for all organizations.
|
@@ -15628,6 +15818,11 @@ components:
|
|
15628
15818
|
user:
|
15629
15819
|
$ref: '#/components/schemas/User'
|
15630
15820
|
type: object
|
15821
|
+
Version:
|
15822
|
+
description: Version of the updated signal. If server side version is higher,
|
15823
|
+
update will be rejected.
|
15824
|
+
format: int64
|
15825
|
+
type: integer
|
15631
15826
|
WebhooksIntegration:
|
15632
15827
|
description: Datadog-Webhooks integration.
|
15633
15828
|
properties:
|
@@ -16547,6 +16742,8 @@ components:
|
|
16547
16742
|
downtimes.
|
16548
16743
|
monitors_read: View monitors.
|
16549
16744
|
monitors_write: Edit, mute, and delete individual monitors.
|
16745
|
+
security_monitoring_signals_read: View Security Signals.
|
16746
|
+
security_monitoring_signals_write: Modify Security Signals.
|
16550
16747
|
synthetics_global_variable_read: View, search, and use in tests the list
|
16551
16748
|
of global variables available for Synthetics.
|
16552
16749
|
synthetics_global_variable_write: Create, edit, and delete global variables
|
@@ -17110,6 +17307,7 @@ paths:
|
|
17110
17307
|
type: safe
|
17111
17308
|
/api/v1/daily_custom_reports:
|
17112
17309
|
get:
|
17310
|
+
deprecated: true
|
17113
17311
|
description: Get daily custom reports.
|
17114
17312
|
operationId: GetDailyCustomReports
|
17115
17313
|
parameters:
|
@@ -17175,6 +17373,7 @@ paths:
|
|
17175
17373
|
If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).'
|
17176
17374
|
/api/v1/daily_custom_reports/{report_id}:
|
17177
17375
|
get:
|
17376
|
+
deprecated: true
|
17178
17377
|
description: Get specified daily custom reports.
|
17179
17378
|
operationId: GetSpecifiedDailyCustomReports
|
17180
17379
|
parameters:
|
@@ -21386,19 +21585,19 @@ paths:
|
|
21386
21585
|
Example: `"check".over(tags).last(count).by(group).count_by_status()`
|
21387
21586
|
|
21388
21587
|
|
21389
|
-
-
|
21588
|
+
- `check` name of the check, for example `datadog.agent.up`
|
21390
21589
|
|
21391
|
-
-
|
21392
|
-
|
21590
|
+
- `tags` one or more quoted tags (comma-separated), or "*". for example: `.over("env:prod",
|
21591
|
+
"role:db")`; `over` cannot be blank.
|
21393
21592
|
|
21394
|
-
-
|
21593
|
+
- `count` must be at greater than or equal to your max threshold (defined
|
21395
21594
|
in the `options`). It is limited to 100.
|
21396
21595
|
|
21397
21596
|
For example, if you''ve specified to notify on 1 critical, 3 ok, and 2 warn
|
21398
21597
|
statuses, `count` should be at least 3.
|
21399
21598
|
|
21400
|
-
-
|
21401
|
-
|
21599
|
+
- `group` must be specified for check monitors. Per-check grouping is already
|
21600
|
+
explicitly known for some service checks.
|
21402
21601
|
|
21403
21602
|
For example, Postgres integration monitors are tagged by `db`, `host`, and
|
21404
21603
|
`port`, and Network monitors by `host`, `instance`, and `url`. See [Service
|
@@ -21413,28 +21612,28 @@ paths:
|
|
21413
21612
|
"string query"'').rollup("count").last("1h")"`
|
21414
21613
|
|
21415
21614
|
|
21416
|
-
-
|
21615
|
+
- `event`, the event query string:
|
21417
21616
|
|
21418
|
-
-
|
21617
|
+
- `string_query` free text query to match against event title and text.
|
21419
21618
|
|
21420
|
-
-
|
21619
|
+
- `sources` event sources (comma-separated).
|
21421
21620
|
|
21422
|
-
-
|
21423
|
-
|
21621
|
+
- `status` event statuses (comma-separated). Valid options: error, warn, and
|
21622
|
+
info.
|
21424
21623
|
|
21425
|
-
-
|
21624
|
+
- `priority` event priorities (comma-separated). Valid options: low, normal,
|
21426
21625
|
all.
|
21427
21626
|
|
21428
|
-
-
|
21627
|
+
- `host` event reporting host (comma-separated).
|
21429
21628
|
|
21430
|
-
-
|
21629
|
+
- `tags` event tags (comma-separated).
|
21431
21630
|
|
21432
|
-
-
|
21631
|
+
- `excluded_tags` excluded event tags (comma-separated).
|
21433
21632
|
|
21434
|
-
-
|
21633
|
+
- `rollup` the stats roll-up method. `count` is the only supported method
|
21435
21634
|
now.
|
21436
21635
|
|
21437
|
-
-
|
21636
|
+
- `last` the timeframe to roll up the counts. Examples: 45m, 4h. Supported
|
21438
21637
|
timeframes: m, h and d. This value should not exceed 48 hours.
|
21439
21638
|
|
21440
21639
|
|
@@ -21449,19 +21648,18 @@ paths:
|
|
21449
21648
|
operator #`
|
21450
21649
|
|
21451
21650
|
|
21452
|
-
-
|
21651
|
+
- `query` The search query - following the [Log search syntax](https://docs.datadoghq.com/logs/search_syntax/).
|
21453
21652
|
|
21454
|
-
-
|
21455
|
-
`cardinality`.
|
21653
|
+
- `rollup_method` The stats roll-up method - supports `count`, `avg` and `cardinality`.
|
21456
21654
|
|
21457
|
-
-
|
21655
|
+
- `measure` For `avg` and cardinality `rollup_method` - specify the measure
|
21458
21656
|
or the facet name you want to use.
|
21459
21657
|
|
21460
|
-
-
|
21658
|
+
- `time_window` #m (between 1 and 2880), #h (between 1 and 48).
|
21461
21659
|
|
21462
|
-
-
|
21660
|
+
- `operator` `<`, `<=`, `>`, `>=`, `==`, or `!=`.
|
21463
21661
|
|
21464
|
-
-
|
21662
|
+
- `#` an integer or decimal number used to set the threshold.
|
21465
21663
|
|
21466
21664
|
|
21467
21665
|
**Process Alert Query**
|
@@ -21471,19 +21669,19 @@ paths:
|
|
21471
21669
|
#`
|
21472
21670
|
|
21473
21671
|
|
21474
|
-
-
|
21672
|
+
- `search` free text search string for querying processes.
|
21475
21673
|
|
21476
21674
|
Matching processes match results on the [Live Processes](https://docs.datadoghq.com/infrastructure/process/?tab=linuxwindows)
|
21477
21675
|
page.
|
21478
21676
|
|
21479
|
-
-
|
21677
|
+
- `tags` one or more tags (comma-separated)
|
21480
21678
|
|
21481
|
-
-
|
21482
|
-
|
21679
|
+
- `timeframe` the timeframe to roll up the counts. Examples: 10m, 4h. Supported
|
21680
|
+
timeframes: s, m, h and d
|
21483
21681
|
|
21484
|
-
-
|
21682
|
+
- `operator` <, <=, >, >=, ==, or !=
|
21485
21683
|
|
21486
|
-
-
|
21684
|
+
- `#` an integer or decimal number used to set the threshold
|
21487
21685
|
|
21488
21686
|
|
21489
21687
|
**Logs Alert Query**
|
@@ -21493,22 +21691,21 @@ paths:
|
|
21493
21691
|
operator #`
|
21494
21692
|
|
21495
21693
|
|
21496
|
-
-
|
21694
|
+
- `query` The search query - following the [Log search syntax](https://docs.datadoghq.com/logs/search_syntax/).
|
21497
21695
|
|
21498
|
-
-
|
21499
|
-
|
21696
|
+
- `index_name` For multi-index organizations, the log index in which the request
|
21697
|
+
is performed.
|
21500
21698
|
|
21501
|
-
-
|
21502
|
-
`cardinality`.
|
21699
|
+
- `rollup_method` The stats roll-up method - supports `count`, `avg` and `cardinality`.
|
21503
21700
|
|
21504
|
-
-
|
21701
|
+
- `measure` For `avg` and cardinality `rollup_method` - specify the measure
|
21505
21702
|
or the facet name you want to use.
|
21506
21703
|
|
21507
|
-
-
|
21704
|
+
- `time_window` #m (between 1 and 2880), #h (between 1 and 48).
|
21508
21705
|
|
21509
|
-
-
|
21706
|
+
- `operator` `<`, `<=`, `>`, `>=`, `==`, or `!=`.
|
21510
21707
|
|
21511
|
-
-
|
21708
|
+
- `#` an integer or decimal number used to set the threshold.
|
21512
21709
|
|
21513
21710
|
|
21514
21711
|
**Composite Query**
|
@@ -21518,16 +21715,16 @@ paths:
|
|
21518
21715
|
monitors
|
21519
21716
|
|
21520
21717
|
|
21521
|
-
*
|
21522
|
-
|
21718
|
+
* `name` [*required*, *default* = **dynamic, based on query**]: The name of
|
21719
|
+
the alert.
|
21523
21720
|
|
21524
|
-
*
|
21721
|
+
* `message` [*required*, *default* = **dynamic, based on query**]: A message
|
21525
21722
|
to include with notifications for this monitor.
|
21526
21723
|
|
21527
21724
|
Email notifications can be sent to specific users by using the same ''@username''
|
21528
21725
|
notation as events.
|
21529
21726
|
|
21530
|
-
*
|
21727
|
+
* `tags` [*optional*, *default* = **empty list**]: A list of tags to associate
|
21531
21728
|
with your monitor.
|
21532
21729
|
|
21533
21730
|
When getting all monitor details via the API, use the `monitor_tags` argument
|
@@ -21543,13 +21740,13 @@ paths:
|
|
21543
21740
|
Example: `error_budget("slo_id").over("time_window") operator #`
|
21544
21741
|
|
21545
21742
|
|
21546
|
-
-
|
21547
|
-
|
21743
|
+
- `slo_id`: The alphanumeric SLO ID of the SLO you are configuring the alert
|
21744
|
+
for.
|
21548
21745
|
|
21549
|
-
-
|
21550
|
-
|
21746
|
+
- `time_window`: The time window of the SLO target you wish to alert on. Valid
|
21747
|
+
options: `7d`, `30d`, `90d`.
|
21551
21748
|
|
21552
|
-
-
|
21749
|
+
- `operator`: `>=` or `>`
|
21553
21750
|
|
21554
21751
|
|
21555
21752
|
**Audit Alert Query**
|
@@ -21559,19 +21756,18 @@ paths:
|
|
21559
21756
|
operator #`
|
21560
21757
|
|
21561
21758
|
|
21562
|
-
-
|
21759
|
+
- `query` The search query - following the [Log search syntax](https://docs.datadoghq.com/logs/search_syntax/).
|
21563
21760
|
|
21564
|
-
-
|
21565
|
-
`cardinality`.
|
21761
|
+
- `rollup_method` The stats roll-up method - supports `count`, `avg` and `cardinality`.
|
21566
21762
|
|
21567
|
-
-
|
21763
|
+
- `measure` For `avg` and cardinality `rollup_method` - specify the measure
|
21568
21764
|
or the facet name you want to use.
|
21569
21765
|
|
21570
|
-
-
|
21766
|
+
- `time_window` #m (between 1 and 2880), #h (between 1 and 48).
|
21571
21767
|
|
21572
|
-
-
|
21768
|
+
- `operator` `<`, `<=`, `>`, `>=`, `==`, or `!=`.
|
21573
21769
|
|
21574
|
-
-
|
21770
|
+
- `#` an integer or decimal number used to set the threshold.
|
21575
21771
|
|
21576
21772
|
|
21577
21773
|
**NOTE** Only available on US1-FED and in closed beta on US1, EU, US3, and
|
@@ -21585,24 +21781,50 @@ paths:
|
|
21585
21781
|
operator #`
|
21586
21782
|
|
21587
21783
|
|
21588
|
-
-
|
21784
|
+
- `query` The search query - following the [Log search syntax](https://docs.datadoghq.com/logs/search_syntax/).
|
21589
21785
|
|
21590
|
-
-
|
21591
|
-
|
21786
|
+
- `rollup_method` The stats roll-up method - supports `count`, `avg`, and
|
21787
|
+
`cardinality`.
|
21592
21788
|
|
21593
|
-
-
|
21789
|
+
- `measure` For `avg` and cardinality `rollup_method` - specify the measure
|
21594
21790
|
or the facet name you want to use.
|
21595
21791
|
|
21596
|
-
-
|
21792
|
+
- `time_window` #m (between 1 and 2880), #h (between 1 and 48).
|
21597
21793
|
|
21598
|
-
-
|
21794
|
+
- `operator` `<`, `<=`, `>`, `>=`, `==`, or `!=`.
|
21599
21795
|
|
21600
|
-
-
|
21796
|
+
- `#` an integer or decimal number used to set the threshold.
|
21601
21797
|
|
21602
21798
|
|
21603
21799
|
**NOTE** CI Pipeline monitors are in alpha on US1, EU, US3 and US5.
|
21604
21800
|
|
21605
21801
|
|
21802
|
+
**CI Tests Alert Query**
|
21803
|
+
|
21804
|
+
|
21805
|
+
Example: `ci-tests(query).rollup(rollup_method[, measure]).last(time_window)
|
21806
|
+
operator #`
|
21807
|
+
|
21808
|
+
|
21809
|
+
- `query` The search query - following the [Log search syntax](https://docs.datadoghq.com/logs/search_syntax/).
|
21810
|
+
|
21811
|
+
- `rollup_method` The stats roll-up method - supports `count`, `avg`, and
|
21812
|
+
`cardinality`.
|
21813
|
+
|
21814
|
+
- `measure` For `avg` and cardinality `rollup_method` - specify the measure
|
21815
|
+
or the facet name you want to use.
|
21816
|
+
|
21817
|
+
- `time_window` #m (between 1 and 2880), #h (between 1 and 48).
|
21818
|
+
|
21819
|
+
- `operator` `<`, `<=`, `>`, `>=`, `==`, or `!=`.
|
21820
|
+
|
21821
|
+
- `#` an integer or decimal number used to set the threshold.
|
21822
|
+
|
21823
|
+
|
21824
|
+
**NOTE** CI Test monitors are available only in closed beta on US1, EU, US3
|
21825
|
+
and US5.
|
21826
|
+
|
21827
|
+
|
21606
21828
|
**Error Tracking Alert Query**
|
21607
21829
|
|
21608
21830
|
|
@@ -21613,19 +21835,19 @@ paths:
|
|
21613
21835
|
measure]).last(time_window) operator #`
|
21614
21836
|
|
21615
21837
|
|
21616
|
-
-
|
21838
|
+
- `query` The search query - following the [Log search syntax](https://docs.datadoghq.com/logs/search_syntax/).
|
21617
21839
|
|
21618
|
-
-
|
21619
|
-
|
21840
|
+
- `rollup_method` The stats roll-up method - supports `count`, `avg`, and
|
21841
|
+
`cardinality`.
|
21620
21842
|
|
21621
|
-
-
|
21843
|
+
- `measure` For `avg` and cardinality `rollup_method` - specify the measure
|
21622
21844
|
or the facet name you want to use.
|
21623
21845
|
|
21624
|
-
-
|
21846
|
+
- `time_window` #m (between 1 and 2880), #h (between 1 and 48).
|
21625
21847
|
|
21626
|
-
-
|
21848
|
+
- `operator` `<`, `<=`, `>`, `>=`, `==`, or `!=`.
|
21627
21849
|
|
21628
|
-
-
|
21850
|
+
- `#` an integer or decimal number used to set the threshold.'
|
21629
21851
|
operationId: CreateMonitor
|
21630
21852
|
requestBody:
|
21631
21853
|
content:
|
@@ -22257,6 +22479,7 @@ paths:
|
|
22257
22479
|
type: idempotent
|
22258
22480
|
/api/v1/monthly_custom_reports:
|
22259
22481
|
get:
|
22482
|
+
deprecated: true
|
22260
22483
|
description: Get monthly custom reports.
|
22261
22484
|
operationId: GetMonthlyCustomReports
|
22262
22485
|
parameters:
|
@@ -22322,6 +22545,7 @@ paths:
|
|
22322
22545
|
If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).'
|
22323
22546
|
/api/v1/monthly_custom_reports/{report_id}:
|
22324
22547
|
get:
|
22548
|
+
deprecated: true
|
22325
22549
|
description: Get specified monthly custom reports.
|
22326
22550
|
operationId: GetSpecifiedMonthlyCustomReports
|
22327
22551
|
parameters:
|
@@ -23088,6 +23312,161 @@ paths:
|
|
23088
23312
|
x-menu-order: 4
|
23089
23313
|
x-undo:
|
23090
23314
|
type: safe
|
23315
|
+
/api/v1/security_analytics/signals/{signal_id}/add_to_incident:
|
23316
|
+
patch:
|
23317
|
+
description: Add a security signal to an incident. This makes it possible to
|
23318
|
+
search for signals by incident within the signal explorer and to view the
|
23319
|
+
signals on the incident timeline.
|
23320
|
+
operationId: AddSecurityMonitoringSignalToIncident
|
23321
|
+
parameters:
|
23322
|
+
- $ref: '#/components/parameters/SignalID'
|
23323
|
+
requestBody:
|
23324
|
+
content:
|
23325
|
+
application/json:
|
23326
|
+
schema:
|
23327
|
+
$ref: '#/components/schemas/AddSignalToIncidentRequest'
|
23328
|
+
description: Attributes describing the signal update.
|
23329
|
+
required: true
|
23330
|
+
responses:
|
23331
|
+
'200':
|
23332
|
+
content:
|
23333
|
+
application/json:
|
23334
|
+
schema:
|
23335
|
+
$ref: '#/components/schemas/SuccessfulSignalUpdateResponse'
|
23336
|
+
description: OK
|
23337
|
+
'400':
|
23338
|
+
content:
|
23339
|
+
application/json:
|
23340
|
+
schema:
|
23341
|
+
$ref: '#/components/schemas/APIErrorResponse'
|
23342
|
+
description: Bad Request
|
23343
|
+
'403':
|
23344
|
+
content:
|
23345
|
+
application/json:
|
23346
|
+
schema:
|
23347
|
+
$ref: '#/components/schemas/APIErrorResponse'
|
23348
|
+
description: Forbidden
|
23349
|
+
'404':
|
23350
|
+
content:
|
23351
|
+
application/json:
|
23352
|
+
schema:
|
23353
|
+
$ref: '#/components/schemas/APIErrorResponse'
|
23354
|
+
description: Not Found
|
23355
|
+
'429':
|
23356
|
+
$ref: '#/components/responses/TooManyRequestsResponse'
|
23357
|
+
security:
|
23358
|
+
- AuthZ:
|
23359
|
+
- security_monitoring_signals_write
|
23360
|
+
apiKeyAuth: []
|
23361
|
+
appKeyAuth: []
|
23362
|
+
summary: Add a security signal to an incident
|
23363
|
+
tags:
|
23364
|
+
- Security Monitoring
|
23365
|
+
x-codegen-request-body-name: body
|
23366
|
+
x-undo:
|
23367
|
+
type: idempotent
|
23368
|
+
/api/v1/security_analytics/signals/{signal_id}/assignee:
|
23369
|
+
patch:
|
23370
|
+
description: Modify the triage assignee of a security signal.
|
23371
|
+
operationId: EditSecurityMonitoringSignalAssignee
|
23372
|
+
parameters:
|
23373
|
+
- $ref: '#/components/parameters/SignalID'
|
23374
|
+
requestBody:
|
23375
|
+
content:
|
23376
|
+
application/json:
|
23377
|
+
schema:
|
23378
|
+
$ref: '#/components/schemas/SignalAssigneeUpdateRequest'
|
23379
|
+
description: Attributes describing the signal update.
|
23380
|
+
required: true
|
23381
|
+
responses:
|
23382
|
+
'200':
|
23383
|
+
content:
|
23384
|
+
application/json:
|
23385
|
+
schema:
|
23386
|
+
$ref: '#/components/schemas/SuccessfulSignalUpdateResponse'
|
23387
|
+
description: OK
|
23388
|
+
'400':
|
23389
|
+
content:
|
23390
|
+
application/json:
|
23391
|
+
schema:
|
23392
|
+
$ref: '#/components/schemas/APIErrorResponse'
|
23393
|
+
description: Bad Request
|
23394
|
+
'403':
|
23395
|
+
content:
|
23396
|
+
application/json:
|
23397
|
+
schema:
|
23398
|
+
$ref: '#/components/schemas/APIErrorResponse'
|
23399
|
+
description: Forbidden
|
23400
|
+
'404':
|
23401
|
+
content:
|
23402
|
+
application/json:
|
23403
|
+
schema:
|
23404
|
+
$ref: '#/components/schemas/APIErrorResponse'
|
23405
|
+
description: Not Found
|
23406
|
+
'429':
|
23407
|
+
$ref: '#/components/responses/TooManyRequestsResponse'
|
23408
|
+
security:
|
23409
|
+
- AuthZ:
|
23410
|
+
- security_monitoring_signals_write
|
23411
|
+
apiKeyAuth: []
|
23412
|
+
appKeyAuth: []
|
23413
|
+
summary: Modify the triage assignee of a security signal
|
23414
|
+
tags:
|
23415
|
+
- Security Monitoring
|
23416
|
+
x-codegen-request-body-name: body
|
23417
|
+
x-undo:
|
23418
|
+
type: idempotent
|
23419
|
+
/api/v1/security_analytics/signals/{signal_id}/state:
|
23420
|
+
patch:
|
23421
|
+
description: Change the triage state of a security signal.
|
23422
|
+
operationId: EditSecurityMonitoringSignalState
|
23423
|
+
parameters:
|
23424
|
+
- $ref: '#/components/parameters/SignalID'
|
23425
|
+
requestBody:
|
23426
|
+
content:
|
23427
|
+
application/json:
|
23428
|
+
schema:
|
23429
|
+
$ref: '#/components/schemas/SignalStateUpdateRequest'
|
23430
|
+
description: Attributes describing the signal update.
|
23431
|
+
required: true
|
23432
|
+
responses:
|
23433
|
+
'200':
|
23434
|
+
content:
|
23435
|
+
application/json:
|
23436
|
+
schema:
|
23437
|
+
$ref: '#/components/schemas/SuccessfulSignalUpdateResponse'
|
23438
|
+
description: OK
|
23439
|
+
'400':
|
23440
|
+
content:
|
23441
|
+
application/json:
|
23442
|
+
schema:
|
23443
|
+
$ref: '#/components/schemas/APIErrorResponse'
|
23444
|
+
description: Bad Request
|
23445
|
+
'403':
|
23446
|
+
content:
|
23447
|
+
application/json:
|
23448
|
+
schema:
|
23449
|
+
$ref: '#/components/schemas/APIErrorResponse'
|
23450
|
+
description: Forbidden
|
23451
|
+
'404':
|
23452
|
+
content:
|
23453
|
+
application/json:
|
23454
|
+
schema:
|
23455
|
+
$ref: '#/components/schemas/APIErrorResponse'
|
23456
|
+
description: Not Found
|
23457
|
+
'429':
|
23458
|
+
$ref: '#/components/responses/TooManyRequestsResponse'
|
23459
|
+
security:
|
23460
|
+
- AuthZ:
|
23461
|
+
- security_monitoring_signals_write
|
23462
|
+
apiKeyAuth: []
|
23463
|
+
appKeyAuth: []
|
23464
|
+
summary: Change the triage state of a security signal
|
23465
|
+
tags:
|
23466
|
+
- Security Monitoring
|
23467
|
+
x-codegen-request-body-name: body
|
23468
|
+
x-undo:
|
23469
|
+
type: idempotent
|
23091
23470
|
/api/v1/series:
|
23092
23471
|
post:
|
23093
23472
|
description: "The metrics end-point allows you to post time-series data that
|
@@ -23095,7 +23474,7 @@ paths:
|
|
23095
23474
|
3.2 megabytes (3200000 bytes). Compressed payloads must have a decompressed
|
23096
23475
|
size of less than 62 megabytes (62914560 bytes).\n\nIf you\u2019re submitting
|
23097
23476
|
metrics directly to the Datadog API without using DogStatsD, expect:\n\n-
|
23098
|
-
64 bits for the timestamp\n-
|
23477
|
+
64 bits for the timestamp\n- 64 bits for the value\n- 40 bytes for the metric
|
23099
23478
|
names\n- 50 bytes for the timeseries\n- The full payload is approximately
|
23100
23479
|
100 bytes. However, with the DogStatsD API,\ncompression is applied, which
|
23101
23480
|
reduces the payload size."
|
@@ -23428,9 +23807,6 @@ paths:
|
|
23428
23807
|
x-menu-order: 2
|
23429
23808
|
x-undo:
|
23430
23809
|
type: safe
|
23431
|
-
x-unstable: '**Note**: This endpoint is in public beta.
|
23432
|
-
|
23433
|
-
If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).'
|
23434
23810
|
post:
|
23435
23811
|
description: Create an SLO Correction.
|
23436
23812
|
operationId: CreateSLOCorrection
|
@@ -23489,9 +23865,6 @@ paths:
|
|
23489
23865
|
- name: slo_correction_id
|
23490
23866
|
source: data.id
|
23491
23867
|
type: unsafe
|
23492
|
-
x-unstable: '**Note**: This endpoint is in public beta.
|
23493
|
-
|
23494
|
-
If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).'
|
23495
23868
|
/api/v1/slo/correction/{slo_correction_id}:
|
23496
23869
|
delete:
|
23497
23870
|
description: Permanently delete the specified SLO correction object.
|
@@ -23526,9 +23899,6 @@ paths:
|
|
23526
23899
|
x-menu-order: 5
|
23527
23900
|
x-undo:
|
23528
23901
|
type: idempotent
|
23529
|
-
x-unstable: '**Note**: This endpoint is in public beta.
|
23530
|
-
|
23531
|
-
If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).'
|
23532
23902
|
get:
|
23533
23903
|
description: Get an SLO correction.
|
23534
23904
|
operationId: GetSLOCorrection
|
@@ -23566,11 +23936,8 @@ paths:
|
|
23566
23936
|
x-menu-order: 3
|
23567
23937
|
x-undo:
|
23568
23938
|
type: safe
|
23569
|
-
x-unstable: '**Note**: This endpoint is in public beta.
|
23570
|
-
|
23571
|
-
If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).'
|
23572
23939
|
patch:
|
23573
|
-
description: Update the specified SLO correction object
|
23940
|
+
description: Update the specified SLO correction object.
|
23574
23941
|
operationId: UpdateSLOCorrection
|
23575
23942
|
parameters:
|
23576
23943
|
- description: The ID of the SLO correction object.
|
@@ -23620,9 +23987,6 @@ paths:
|
|
23620
23987
|
x-menu-order: 4
|
23621
23988
|
x-undo:
|
23622
23989
|
type: idempotent
|
23623
|
-
x-unstable: '**Note**: This endpoint is in public beta.
|
23624
|
-
|
23625
|
-
If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).'
|
23626
23990
|
/api/v1/slo/{slo_id}:
|
23627
23991
|
delete:
|
23628
23992
|
description: 'Permanently delete the specified service level objective object.
|
@@ -23826,9 +24190,6 @@ paths:
|
|
23826
24190
|
x-menu-order: 6
|
23827
24191
|
x-undo:
|
23828
24192
|
type: safe
|
23829
|
-
x-unstable: '**Note**: This endpoint is in public beta.
|
23830
|
-
|
23831
|
-
If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).'
|
23832
24193
|
/api/v1/slo/{slo_id}/history:
|
23833
24194
|
get:
|
23834
24195
|
description: "Get a specific SLO\u2019s history, regardless of its SLO type.\n\nThe
|
@@ -23954,7 +24315,7 @@ paths:
|
|
23954
24315
|
summary: Get details of batch
|
23955
24316
|
tags:
|
23956
24317
|
- Synthetics
|
23957
|
-
x-menu-order:
|
24318
|
+
x-menu-order: 15
|
23958
24319
|
x-undo:
|
23959
24320
|
type: safe
|
23960
24321
|
/api/v1/synthetics/locations:
|
@@ -23980,7 +24341,7 @@ paths:
|
|
23980
24341
|
summary: Get all locations (public and private)
|
23981
24342
|
tags:
|
23982
24343
|
- Synthetics
|
23983
|
-
x-menu-order:
|
24344
|
+
x-menu-order: 25
|
23984
24345
|
x-undo:
|
23985
24346
|
type: safe
|
23986
24347
|
/api/v1/synthetics/private-locations:
|
@@ -24024,7 +24385,7 @@ paths:
|
|
24024
24385
|
tags:
|
24025
24386
|
- Synthetics
|
24026
24387
|
x-codegen-request-body-name: body
|
24027
|
-
x-menu-order:
|
24388
|
+
x-menu-order: 22
|
24028
24389
|
x-undo:
|
24029
24390
|
operationId: DeletePrivateLocation
|
24030
24391
|
parameters:
|
@@ -24063,7 +24424,7 @@ paths:
|
|
24063
24424
|
summary: Delete a private location
|
24064
24425
|
tags:
|
24065
24426
|
- Synthetics
|
24066
|
-
x-menu-order:
|
24427
|
+
x-menu-order: 26
|
24067
24428
|
x-undo:
|
24068
24429
|
type: idempotent
|
24069
24430
|
get:
|
@@ -24101,7 +24462,7 @@ paths:
|
|
24101
24462
|
summary: Get a private location
|
24102
24463
|
tags:
|
24103
24464
|
- Synthetics
|
24104
|
-
x-menu-order:
|
24465
|
+
x-menu-order: 23
|
24105
24466
|
x-undo:
|
24106
24467
|
type: safe
|
24107
24468
|
put:
|
@@ -24147,7 +24508,7 @@ paths:
|
|
24147
24508
|
tags:
|
24148
24509
|
- Synthetics
|
24149
24510
|
x-codegen-request-body-name: body
|
24150
|
-
x-menu-order:
|
24511
|
+
x-menu-order: 24
|
24151
24512
|
x-undo:
|
24152
24513
|
type: idempotent
|
24153
24514
|
/api/v1/synthetics/tests:
|
@@ -24824,7 +25185,7 @@ paths:
|
|
24824
25185
|
tags:
|
24825
25186
|
- Synthetics
|
24826
25187
|
x-codegen-request-body-name: body
|
24827
|
-
x-menu-order:
|
25188
|
+
x-menu-order: 16
|
24828
25189
|
x-undo:
|
24829
25190
|
type: idempotent
|
24830
25191
|
/api/v1/synthetics/tests/trigger:
|
@@ -24952,7 +25313,7 @@ paths:
|
|
24952
25313
|
summary: Get a test configuration
|
24953
25314
|
tags:
|
24954
25315
|
- Synthetics
|
24955
|
-
x-menu-order:
|
25316
|
+
x-menu-order: 27
|
24956
25317
|
x-undo:
|
24957
25318
|
type: safe
|
24958
25319
|
/api/v1/synthetics/tests/{public_id}/results:
|
@@ -25161,7 +25522,7 @@ paths:
|
|
25161
25522
|
summary: Get all global variables
|
25162
25523
|
tags:
|
25163
25524
|
- Synthetics
|
25164
|
-
x-menu-order:
|
25525
|
+
x-menu-order: 17
|
25165
25526
|
x-undo:
|
25166
25527
|
type: safe
|
25167
25528
|
post:
|
@@ -25204,7 +25565,7 @@ paths:
|
|
25204
25565
|
tags:
|
25205
25566
|
- Synthetics
|
25206
25567
|
x-codegen-request-body-name: body
|
25207
|
-
x-menu-order:
|
25568
|
+
x-menu-order: 18
|
25208
25569
|
x-undo:
|
25209
25570
|
operationId: DeleteGlobalVariable
|
25210
25571
|
parameters:
|
@@ -25253,7 +25614,7 @@ paths:
|
|
25253
25614
|
summary: Delete a global variable
|
25254
25615
|
tags:
|
25255
25616
|
- Synthetics
|
25256
|
-
x-menu-order:
|
25617
|
+
x-menu-order: 21
|
25257
25618
|
x-undo:
|
25258
25619
|
type: idempotent
|
25259
25620
|
get:
|
@@ -25345,7 +25706,7 @@ paths:
|
|
25345
25706
|
tags:
|
25346
25707
|
- Synthetics
|
25347
25708
|
x-codegen-request-body-name: body
|
25348
|
-
x-menu-order:
|
25709
|
+
x-menu-order: 20
|
25349
25710
|
x-undo:
|
25350
25711
|
type: idempotent
|
25351
25712
|
/api/v1/tags/hosts:
|
@@ -25660,7 +26021,8 @@ paths:
|
|
25660
26021
|
type: safe
|
25661
26022
|
/api/v1/usage/attribution:
|
25662
26023
|
get:
|
25663
|
-
|
26024
|
+
deprecated: true
|
26025
|
+
description: Get usage attribution.
|
25664
26026
|
operationId: GetUsageAttribution
|
25665
26027
|
parameters:
|
25666
26028
|
- description: 'Datetime in ISO-8601 format, UTC, precise to month: `[YYYY-MM]`
|
@@ -25743,7 +26105,7 @@ paths:
|
|
25743
26105
|
appKeyAuth: []
|
25744
26106
|
- AuthZ:
|
25745
26107
|
- usage_read
|
25746
|
-
summary: Get
|
26108
|
+
summary: Get usage attribution
|
25747
26109
|
tags:
|
25748
26110
|
- Usage Metering
|
25749
26111
|
x-menu-order: 29
|
@@ -25919,8 +26281,7 @@ paths:
|
|
25919
26281
|
type: safe
|
25920
26282
|
/api/v1/usage/ci-app:
|
25921
26283
|
get:
|
25922
|
-
description: Get hourly usage for CI Visibility (Tests, Pipeline,
|
25923
|
-
Spans).
|
26284
|
+
description: Get hourly usage for CI Visibility (Tests, Pipeline, and Spans).
|
25924
26285
|
operationId: GetUsageCIApp
|
25925
26286
|
parameters:
|
25926
26287
|
- description: 'Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]`
|
@@ -26270,7 +26631,7 @@ paths:
|
|
26270
26631
|
type: safe
|
26271
26632
|
/api/v1/usage/hourly-attribution:
|
26272
26633
|
get:
|
26273
|
-
description: "Get
|
26634
|
+
description: "Get hourly usage attribution.\n\nThis API endpoint is paginated.
|
26274
26635
|
To make sure you receive all records, check if the value of `next_record_id`
|
26275
26636
|
is\nset in the response. If it is, make another request and pass `next_record_id`
|
26276
26637
|
as a parameter.\nPseudo code example:\n\n```\nresponse := GetHourlyUsageAttribution(start_month)\ncursor
|
@@ -26345,7 +26706,7 @@ paths:
|
|
26345
26706
|
appKeyAuth: []
|
26346
26707
|
- AuthZ:
|
26347
26708
|
- usage_read
|
26348
|
-
summary: Get
|
26709
|
+
summary: Get hourly usage attribution
|
26349
26710
|
tags:
|
26350
26711
|
- Usage Metering
|
26351
26712
|
x-menu-order: 30
|
@@ -26770,7 +27131,7 @@ paths:
|
|
26770
27131
|
type: safe
|
26771
27132
|
/api/v1/usage/monthly-attribution:
|
26772
27133
|
get:
|
26773
|
-
description: "Get
|
27134
|
+
description: "Get monthly usage attribution.\n\nThis API endpoint is paginated.
|
26774
27135
|
To make sure you receive all records, check if the value of `next_record_id`
|
26775
27136
|
is\nset in the response. If it is, make another request and pass `next_record_id`
|
26776
27137
|
as a parameter.\nPseudo code example:\n\n```\nresponse := GetMonthlyUsageAttribution(start_month)\ncursor
|
@@ -26858,7 +27219,7 @@ paths:
|
|
26858
27219
|
appKeyAuth: []
|
26859
27220
|
- AuthZ:
|
26860
27221
|
- usage_read
|
26861
|
-
summary: Get
|
27222
|
+
summary: Get monthly usage attribution
|
26862
27223
|
tags:
|
26863
27224
|
- Usage Metering
|
26864
27225
|
x-given:
|
@@ -28342,6 +28703,10 @@ tags:
|
|
28342
28703
|
externalDocs:
|
28343
28704
|
url: https://docs.datadoghq.com/api/?lang=bash#integration-pagerduty
|
28344
28705
|
name: PagerDuty Integration
|
28706
|
+
- description: 'Detection rules for generating signals and listing of generated
|
28707
|
+
|
28708
|
+
signals.'
|
28709
|
+
name: Security Monitoring
|
28345
28710
|
- description: 'The service check endpoint allows you to post check statuses for use
|
28346
28711
|
with monitors.
|
28347
28712
|
|