datadog_api_client 2.12.0 → 2.13.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 +6 -6
- data/.generator/conftest.py +7 -0
- data/.generator/poetry.lock +45 -75
- data/.generator/pyproject.toml +7 -7
- data/.generator/schemas/v1/openapi.yaml +76 -3
- data/.generator/schemas/v2/openapi.yaml +2328 -459
- data/.generator/src/generator/formatter.py +9 -3
- data/.generator/src/generator/openapi.py +4 -2
- data/.github/workflows/test_integration.yml +7 -1
- data/.pre-commit-config.yaml +2 -2
- data/CHANGELOG.md +31 -0
- data/examples/v1/dashboards/CreateDashboard_1284514532.rb +43 -0
- data/examples/v1/dashboards/CreateDashboard_2261785072.rb +47 -0
- data/examples/v1/dashboards/CreateDashboard_3513586382.rb +74 -0
- data/examples/v1/dashboards/CreateDashboard_3562282606.rb +1 -0
- data/examples/v1/organizations/UpdateOrg.rb +1 -1
- data/examples/v1/users/CreateUser.rb +1 -1
- data/examples/v1/users/CreateUser_266604071.rb +13 -0
- data/examples/v1/users/UpdateUser.rb +1 -1
- data/examples/v2/confluent-cloud/CreateConfluentAccount.rb +1 -0
- data/examples/v2/confluent-cloud/CreateConfluentResource.rb +1 -0
- data/examples/v2/confluent-cloud/UpdateConfluentResource.rb +1 -0
- data/examples/v2/downtimes/CancelDowntime.rb +11 -0
- data/examples/v2/downtimes/CreateDowntime.rb +26 -0
- data/examples/v2/downtimes/GetDowntime.rb +11 -0
- data/examples/v2/downtimes/ListDowntimes.rb +8 -0
- data/examples/v2/downtimes/ListMonitorDowntimes.rb +8 -0
- data/examples/v2/downtimes/ListMonitorDowntimes_128979780.rb +8 -0
- data/examples/v2/downtimes/UpdateDowntime.rb +21 -0
- data/examples/v2/logs/ListLogsGet_2034110533.rb +3 -1
- data/examples/v2/security-monitoring/CreateSecurityMonitoringRule_1092490364.rb +10 -0
- data/examples/v2/spans/AggregateSpans.rb +25 -0
- data/examples/v2/spans/ListSpans.rb +25 -0
- data/examples/v2/spans/ListSpansGet.rb +5 -0
- data/examples/v2/spans/ListSpansGet_1130763422.rb +8 -0
- data/examples/v2/spans/ListSpans_3495563906.rb +25 -0
- data/lib/datadog_api_client/configuration.rb +6 -0
- data/lib/datadog_api_client/inflector.rb +87 -0
- data/lib/datadog_api_client/v1/models/change_widget_request.rb +1 -1
- data/lib/datadog_api_client/v1/models/formula_and_function_cloud_cost_data_source.rb +26 -0
- data/lib/datadog_api_client/v1/models/formula_and_function_cloud_cost_query_definition.rb +150 -0
- data/lib/datadog_api_client/v1/models/formula_and_function_query_definition.rb +2 -1
- data/lib/datadog_api_client/v1/models/formula_and_function_response_format.rb +2 -1
- data/lib/datadog_api_client/v1/models/formula_and_function_slo_query_definition.rb +11 -1
- data/lib/datadog_api_client/v1/models/geomap_widget_request.rb +24 -2
- data/lib/datadog_api_client/v1/models/ip_prefixes_remote_configuration.rb +94 -0
- data/lib/datadog_api_client/v1/models/ip_ranges.rb +11 -1
- data/lib/datadog_api_client/v1/models/organization_settings.rb +8 -0
- data/lib/datadog_api_client/v1/models/query_value_widget_request.rb +1 -1
- data/lib/datadog_api_client/v1/models/scatterplot_table_request.rb +1 -1
- data/lib/datadog_api_client/v1/models/sunburst_widget_request.rb +1 -1
- data/lib/datadog_api_client/v1/models/table_widget_request.rb +1 -1
- data/lib/datadog_api_client/v1/models/timeseries_widget_request.rb +1 -1
- data/lib/datadog_api_client/v1/models/toplist_widget_request.rb +1 -1
- data/lib/datadog_api_client/v1/models/tree_map_widget_request.rb +1 -1
- data/lib/datadog_api_client/v1/models/user.rb +8 -0
- data/lib/datadog_api_client/v1/models/widget_display_type.rb +1 -0
- data/lib/datadog_api_client/v2/api/ci_visibility_pipelines_api.rb +2 -0
- data/lib/datadog_api_client/v2/api/downtimes_api.rb +462 -0
- data/lib/datadog_api_client/v2/api/logs_api.rb +2 -2
- data/lib/datadog_api_client/v2/api/metrics_api.rb +1 -1
- data/lib/datadog_api_client/v2/api/rum_api.rb +2 -2
- data/lib/datadog_api_client/v2/api/spans_api.rb +294 -0
- data/lib/datadog_api_client/v2/models/ci_app_pipeline_event_pipeline.rb +1 -1
- data/lib/datadog_api_client/v2/models/cloud_configuration_rule_create_payload.rb +13 -1
- data/lib/datadog_api_client/v2/models/cloud_workload_security_agent_rule_attributes.rb +41 -1
- data/lib/datadog_api_client/v2/models/confluent_account_resource_attributes.rb +11 -1
- data/lib/datadog_api_client/v2/models/confluent_resource_request_attributes.rb +11 -1
- data/lib/datadog_api_client/v2/models/confluent_resource_response_attributes.rb +21 -1
- data/lib/datadog_api_client/v2/models/dashboard_list_item.rb +12 -1
- data/lib/datadog_api_client/v2/models/downtime_create_request.rb +98 -0
- data/lib/datadog_api_client/v2/models/downtime_create_request_attributes.rb +194 -0
- data/lib/datadog_api_client/v2/models/downtime_create_request_data.rb +119 -0
- data/lib/datadog_api_client/v2/models/downtime_included_monitor_type.rb +26 -0
- data/lib/datadog_api_client/v2/models/downtime_meta.rb +80 -0
- data/lib/datadog_api_client/v2/models/downtime_meta_page.rb +80 -0
- data/lib/datadog_api_client/v2/models/downtime_monitor_identifier.rb +63 -0
- data/lib/datadog_api_client/v2/models/downtime_monitor_identifier_id.rb +98 -0
- data/lib/datadog_api_client/v2/models/downtime_monitor_identifier_tags.rb +107 -0
- data/lib/datadog_api_client/v2/models/downtime_monitor_included_attributes.rb +80 -0
- data/lib/datadog_api_client/v2/models/downtime_monitor_included_item.rb +100 -0
- data/lib/datadog_api_client/v2/models/downtime_notify_end_state_actions.rb +27 -0
- data/lib/datadog_api_client/v2/models/downtime_notify_end_state_types.rb +28 -0
- data/lib/datadog_api_client/v2/models/downtime_relationships.rb +90 -0
- data/lib/datadog_api_client/v2/models/downtime_relationships_created_by.rb +88 -0
- data/lib/datadog_api_client/v2/models/downtime_relationships_created_by_data.rb +90 -0
- data/lib/datadog_api_client/v2/models/downtime_relationships_monitor.rb +88 -0
- data/lib/datadog_api_client/v2/models/downtime_relationships_monitor_data.rb +90 -0
- data/lib/datadog_api_client/v2/models/downtime_resource_type.rb +26 -0
- data/lib/datadog_api_client/v2/models/downtime_response.rb +95 -0
- data/lib/datadog_api_client/v2/models/downtime_response_attributes.rb +208 -0
- data/lib/datadog_api_client/v2/models/downtime_response_data.rb +110 -0
- data/lib/datadog_api_client/v2/models/downtime_response_included_item.rb +63 -0
- data/lib/datadog_api_client/v2/models/downtime_schedule_create_request.rb +63 -0
- data/lib/datadog_api_client/v2/models/downtime_schedule_current_downtime_response.rb +100 -0
- data/lib/datadog_api_client/v2/models/downtime_schedule_one_time_create_update_request.rb +101 -0
- data/lib/datadog_api_client/v2/models/downtime_schedule_one_time_response.rb +98 -0
- data/lib/datadog_api_client/v2/models/downtime_schedule_recurrence_create_update_request.rb +143 -0
- data/lib/datadog_api_client/v2/models/downtime_schedule_recurrence_response.rb +106 -0
- data/lib/datadog_api_client/v2/models/downtime_schedule_recurrences_create_request.rb +110 -0
- data/lib/datadog_api_client/v2/models/downtime_schedule_recurrences_response.rb +131 -0
- data/lib/datadog_api_client/v2/models/downtime_schedule_recurrences_update_request.rb +92 -0
- data/lib/datadog_api_client/v2/models/downtime_schedule_response.rb +65 -0
- data/lib/datadog_api_client/v2/models/downtime_schedule_update_request.rb +63 -0
- data/lib/datadog_api_client/v2/models/downtime_status.rb +29 -0
- data/lib/datadog_api_client/v2/models/downtime_update_request.rb +98 -0
- data/lib/datadog_api_client/v2/models/downtime_update_request_attributes.rb +165 -0
- data/lib/datadog_api_client/v2/models/downtime_update_request_data.rb +140 -0
- data/lib/datadog_api_client/v2/models/event_response_attributes.rb +11 -1
- data/lib/datadog_api_client/v2/models/events_group_by_sort.rb +1 -1
- data/lib/datadog_api_client/v2/models/events_response_metadata.rb +11 -1
- data/lib/datadog_api_client/v2/models/list_downtimes_response.rb +104 -0
- data/lib/datadog_api_client/v2/models/metrics_aggregator.rb +1 -1
- data/lib/datadog_api_client/v2/models/metrics_scalar_query.rb +1 -1
- data/lib/datadog_api_client/v2/models/monitor_downtime_match_resource_type.rb +26 -0
- data/lib/datadog_api_client/v2/models/monitor_downtime_match_response.rb +92 -0
- data/lib/datadog_api_client/v2/models/monitor_downtime_match_response_attributes.rb +120 -0
- data/lib/datadog_api_client/v2/models/monitor_downtime_match_response_data.rb +108 -0
- data/lib/datadog_api_client/v2/models/restriction_policy_binding.rb +2 -1
- data/lib/datadog_api_client/v2/models/rum_application_list.rb +11 -1
- data/lib/datadog_api_client/v2/models/service_definition_data.rb +11 -1
- data/lib/datadog_api_client/v2/models/service_definition_meta.rb +36 -4
- data/lib/datadog_api_client/v2/models/service_definition_meta_warnings.rb +100 -0
- data/lib/datadog_api_client/v2/models/span.rb +100 -0
- data/lib/datadog_api_client/v2/models/spans_aggregate_bucket.rb +100 -0
- data/lib/datadog_api_client/v2/models/spans_aggregate_bucket_attributes.rb +100 -0
- data/lib/datadog_api_client/v2/models/spans_aggregate_bucket_type.rb +26 -0
- data/lib/datadog_api_client/v2/models/spans_aggregate_bucket_value.rb +64 -0
- data/lib/datadog_api_client/v2/models/spans_aggregate_bucket_value_timeseries_point.rb +90 -0
- data/lib/datadog_api_client/v2/models/spans_aggregate_data.rb +90 -0
- data/lib/datadog_api_client/v2/models/spans_aggregate_request.rb +80 -0
- data/lib/datadog_api_client/v2/models/spans_aggregate_request_attributes.rb +115 -0
- data/lib/datadog_api_client/v2/models/spans_aggregate_request_type.rb +26 -0
- data/lib/datadog_api_client/v2/models/spans_aggregate_response.rb +92 -0
- data/lib/datadog_api_client/v2/models/spans_aggregate_response_metadata.rb +113 -0
- data/lib/datadog_api_client/v2/models/spans_aggregate_response_status.rb +27 -0
- data/lib/datadog_api_client/v2/models/spans_aggregate_sort.rb +110 -0
- data/lib/datadog_api_client/v2/models/spans_aggregate_sort_type.rb +27 -0
- data/lib/datadog_api_client/v2/models/spans_aggregation_function.rb +37 -0
- data/lib/datadog_api_client/v2/models/spans_attributes.rb +244 -0
- data/lib/datadog_api_client/v2/models/spans_compute.rb +129 -0
- data/lib/datadog_api_client/v2/models/spans_compute_type.rb +27 -0
- data/lib/datadog_api_client/v2/models/spans_group_by.rb +149 -0
- data/lib/datadog_api_client/v2/models/spans_group_by_histogram.rb +143 -0
- data/lib/datadog_api_client/v2/models/spans_group_by_missing.rb +63 -0
- data/lib/datadog_api_client/v2/models/spans_group_by_total.rb +64 -0
- data/lib/datadog_api_client/v2/models/spans_list_request.rb +80 -0
- data/lib/datadog_api_client/v2/models/spans_list_request_attributes.rb +111 -0
- data/lib/datadog_api_client/v2/models/spans_list_request_data.rb +90 -0
- data/lib/datadog_api_client/v2/models/spans_list_request_page.rb +108 -0
- data/lib/datadog_api_client/v2/models/spans_list_request_type.rb +26 -0
- data/lib/datadog_api_client/v2/models/spans_list_response.rb +102 -0
- data/lib/datadog_api_client/v2/models/spans_list_response_links.rb +81 -0
- data/lib/datadog_api_client/v2/models/spans_list_response_metadata.rb +123 -0
- data/lib/datadog_api_client/v2/models/spans_query_filter.rb +100 -0
- data/lib/datadog_api_client/v2/models/spans_query_options.rb +91 -0
- data/lib/datadog_api_client/v2/models/spans_response_metadata_page.rb +81 -0
- data/lib/datadog_api_client/v2/models/spans_sort.rb +27 -0
- data/lib/datadog_api_client/v2/models/spans_sort_order.rb +27 -0
- data/lib/datadog_api_client/v2/models/spans_type.rb +26 -0
- data/lib/datadog_api_client/v2/models/spans_warning.rb +100 -0
- data/lib/datadog_api_client/v2/models/user_invitation_response_data.rb +11 -1
- data/lib/datadog_api_client/version.rb +1 -1
- metadata +105 -2
@@ -520,6 +520,30 @@ components:
|
|
520
520
|
schema:
|
521
521
|
$ref: '#/components/schemas/APIErrorResponse'
|
522
522
|
description: Not Found
|
523
|
+
SpansBadRequestResponse:
|
524
|
+
content:
|
525
|
+
application/json:
|
526
|
+
schema:
|
527
|
+
$ref: '#/components/schemas/JSONAPIErrorResponse'
|
528
|
+
description: Bad Request.
|
529
|
+
SpansForbiddenResponse:
|
530
|
+
content:
|
531
|
+
application/json:
|
532
|
+
schema:
|
533
|
+
$ref: '#/components/schemas/JSONAPIErrorResponse'
|
534
|
+
description: 'Forbidden: Access denied.'
|
535
|
+
SpansTooManyRequestsResponse:
|
536
|
+
content:
|
537
|
+
application/json:
|
538
|
+
schema:
|
539
|
+
$ref: '#/components/schemas/JSONAPIErrorResponse'
|
540
|
+
description: 'Too many requests: The rate limit set by the API has been exceeded.'
|
541
|
+
SpansUnprocessableEntityResponse:
|
542
|
+
content:
|
543
|
+
application/json:
|
544
|
+
schema:
|
545
|
+
$ref: '#/components/schemas/JSONAPIErrorResponse'
|
546
|
+
description: Unprocessable Entity.
|
523
547
|
TooManyRequestsResponse:
|
524
548
|
content:
|
525
549
|
application/json:
|
@@ -1800,8 +1824,8 @@ components:
|
|
1800
1824
|
description: Details of the top level pipeline, build, or workflow of your CI.
|
1801
1825
|
properties:
|
1802
1826
|
end:
|
1803
|
-
description: Time when the pipeline run finished.
|
1804
|
-
RFC3339.
|
1827
|
+
description: Time when the pipeline run finished. It cannot be older than
|
1828
|
+
18 hours in the past from the current time. The time format must be RFC3339.
|
1805
1829
|
example: '2023-05-31T15:30:00Z'
|
1806
1830
|
format: date-time
|
1807
1831
|
type: string
|
@@ -2672,6 +2696,12 @@ components:
|
|
2672
2696
|
type: array
|
2673
2697
|
complianceSignalOptions:
|
2674
2698
|
$ref: '#/components/schemas/CloudConfigurationRuleComplianceSignalOptions'
|
2699
|
+
filters:
|
2700
|
+
description: Additional queries to filter matched events before they are
|
2701
|
+
processed.
|
2702
|
+
items:
|
2703
|
+
$ref: '#/components/schemas/SecurityMonitoringFilter'
|
2704
|
+
type: array
|
2675
2705
|
isEnabled:
|
2676
2706
|
description: Whether the rule is enabled.
|
2677
2707
|
example: true
|
@@ -2732,10 +2762,17 @@ components:
|
|
2732
2762
|
CloudWorkloadSecurityAgentRuleAttributes:
|
2733
2763
|
description: A Cloud Workload Security Agent rule returned by the API.
|
2734
2764
|
properties:
|
2765
|
+
agentConstraint:
|
2766
|
+
description: The version of the agent.
|
2767
|
+
type: string
|
2735
2768
|
category:
|
2736
2769
|
description: The category of the Agent rule.
|
2737
2770
|
example: Process Activity
|
2738
2771
|
type: string
|
2772
|
+
creationAuthorUuId:
|
2773
|
+
description: The ID of the user who created the rule.
|
2774
|
+
example: e51c9744-d158-11ec-ad23-da7ad0900002
|
2775
|
+
type: string
|
2739
2776
|
creationDate:
|
2740
2777
|
description: When the Agent rule was created, timestamp in milliseconds.
|
2741
2778
|
example: 1624366480320
|
@@ -2763,6 +2800,15 @@ components:
|
|
2763
2800
|
description: The name of the Agent rule.
|
2764
2801
|
example: my_agent_rule
|
2765
2802
|
type: string
|
2803
|
+
updateAuthorUuId:
|
2804
|
+
description: The ID of the user who updated the rule.
|
2805
|
+
example: e51c9744-d158-11ec-ad23-da7ad0900002
|
2806
|
+
type: string
|
2807
|
+
updateDate:
|
2808
|
+
description: Timestamp in milliseconds when the Agent rule was last updated.
|
2809
|
+
example: 1624366480320
|
2810
|
+
format: int64
|
2811
|
+
type: integer
|
2766
2812
|
updatedAt:
|
2767
2813
|
description: When the Agent rule was last updated, timestamp in milliseconds.
|
2768
2814
|
example: 1624366480320
|
@@ -3092,6 +3138,12 @@ components:
|
|
3092
3138
|
ConfluentAccountResourceAttributes:
|
3093
3139
|
description: Attributes object for updating a Confluent resource.
|
3094
3140
|
properties:
|
3141
|
+
enable_custom_metrics:
|
3142
|
+
default: false
|
3143
|
+
description: Enable the `custom.consumer_lag_offset` metric, which contains
|
3144
|
+
extra metric tags.
|
3145
|
+
example: false
|
3146
|
+
type: boolean
|
3095
3147
|
id:
|
3096
3148
|
description: The ID associated with a Confluent resource.
|
3097
3149
|
example: resource-id-123
|
@@ -3232,6 +3284,12 @@ components:
|
|
3232
3284
|
ConfluentResourceRequestAttributes:
|
3233
3285
|
description: Attributes object for updating a Confluent resource.
|
3234
3286
|
properties:
|
3287
|
+
enable_custom_metrics:
|
3288
|
+
default: false
|
3289
|
+
description: Enable the `custom.consumer_lag_offset` metric, which contains
|
3290
|
+
extra metric tags.
|
3291
|
+
example: false
|
3292
|
+
type: boolean
|
3235
3293
|
resource_type:
|
3236
3294
|
description: The resource type of the Resource. Can be `kafka`, `connector`,
|
3237
3295
|
`ksql`, or `schema_registry`.
|
@@ -3274,6 +3332,16 @@ components:
|
|
3274
3332
|
ConfluentResourceResponseAttributes:
|
3275
3333
|
description: Model representation of a Confluent Cloud resource.
|
3276
3334
|
properties:
|
3335
|
+
enable_custom_metrics:
|
3336
|
+
default: false
|
3337
|
+
description: Enable the `custom.consumer_lag_offset` metric, which contains
|
3338
|
+
extra metric tags.
|
3339
|
+
example: false
|
3340
|
+
type: boolean
|
3341
|
+
id:
|
3342
|
+
description: The ID associated with the Confluent resource.
|
3343
|
+
example: resource_id_abc123
|
3344
|
+
type: string
|
3277
3345
|
resource_type:
|
3278
3346
|
description: The resource type of the Resource. Can be `kafka`, `connector`,
|
3279
3347
|
`ksql`, or `schema_registry`.
|
@@ -3461,6 +3529,11 @@ components:
|
|
3461
3529
|
description: ID of the dashboard.
|
3462
3530
|
example: q5j-nti-fv6
|
3463
3531
|
type: string
|
3532
|
+
integration_id:
|
3533
|
+
description: The short name of the integration.
|
3534
|
+
nullable: true
|
3535
|
+
readOnly: true
|
3536
|
+
type: string
|
3464
3537
|
is_favorite:
|
3465
3538
|
description: Whether or not the dashboard is in the favorites.
|
3466
3539
|
readOnly: true
|
@@ -3660,155 +3733,736 @@ components:
|
|
3660
3733
|
type: string
|
3661
3734
|
x-enum-varnames:
|
3662
3735
|
- DETAILED_FINDING
|
3663
|
-
|
3664
|
-
description:
|
3736
|
+
DowntimeCreateRequest:
|
3737
|
+
description: Request for creating a downtime.
|
3665
3738
|
properties:
|
3666
|
-
|
3667
|
-
|
3668
|
-
|
3669
|
-
|
3670
|
-
name:
|
3671
|
-
description: The event name.
|
3672
|
-
type: string
|
3673
|
-
source_id:
|
3674
|
-
description: Event source ID.
|
3675
|
-
example: 36
|
3676
|
-
format: int64
|
3677
|
-
type: integer
|
3678
|
-
type:
|
3679
|
-
description: Event type.
|
3680
|
-
example: error_tracking_alert
|
3681
|
-
type: string
|
3739
|
+
data:
|
3740
|
+
$ref: '#/components/schemas/DowntimeCreateRequestData'
|
3741
|
+
required:
|
3742
|
+
- data
|
3682
3743
|
type: object
|
3683
|
-
|
3684
|
-
description:
|
3744
|
+
DowntimeCreateRequestAttributes:
|
3745
|
+
description: Downtime details.
|
3685
3746
|
properties:
|
3686
|
-
|
3687
|
-
|
3688
|
-
|
3689
|
-
|
3690
|
-
|
3691
|
-
|
3747
|
+
display_timezone:
|
3748
|
+
$ref: '#/components/schemas/DowntimeDisplayTimezone'
|
3749
|
+
message:
|
3750
|
+
$ref: '#/components/schemas/DowntimeMessage'
|
3751
|
+
monitor_identifier:
|
3752
|
+
$ref: '#/components/schemas/DowntimeMonitorIdentifier'
|
3753
|
+
mute_first_recovery_notification:
|
3754
|
+
$ref: '#/components/schemas/DowntimeMuteFirstRecoveryNotification'
|
3755
|
+
notify_end_states:
|
3756
|
+
$ref: '#/components/schemas/DowntimeNotifyEndStates'
|
3757
|
+
notify_end_types:
|
3758
|
+
$ref: '#/components/schemas/DowntimeNotifyEndTypes'
|
3759
|
+
schedule:
|
3760
|
+
$ref: '#/components/schemas/DowntimeScheduleCreateRequest'
|
3761
|
+
scope:
|
3762
|
+
$ref: '#/components/schemas/DowntimeScope'
|
3763
|
+
required:
|
3764
|
+
- scope
|
3765
|
+
- monitor_identifier
|
3766
|
+
type: object
|
3767
|
+
DowntimeCreateRequestData:
|
3768
|
+
description: Object to create a downtime.
|
3769
|
+
properties:
|
3770
|
+
attributes:
|
3771
|
+
$ref: '#/components/schemas/DowntimeCreateRequestAttributes'
|
3772
|
+
type:
|
3773
|
+
$ref: '#/components/schemas/DowntimeResourceType'
|
3774
|
+
required:
|
3775
|
+
- type
|
3776
|
+
- attributes
|
3777
|
+
type: object
|
3778
|
+
DowntimeDisplayTimezone:
|
3779
|
+
default: UTC
|
3780
|
+
description: 'The timezone in which to display the downtime''s start and end
|
3781
|
+
times in Datadog applications. This is not used
|
3692
3782
|
|
3693
|
-
|
3694
|
-
|
3695
|
-
|
3696
|
-
|
3697
|
-
|
3698
|
-
|
3699
|
-
|
3700
|
-
|
3701
|
-
|
3702
|
-
|
3703
|
-
|
3704
|
-
|
3705
|
-
|
3706
|
-
|
3707
|
-
|
3708
|
-
|
3709
|
-
$ref: '#/components/schemas/Event'
|
3710
|
-
hostname:
|
3711
|
-
description: 'Host name to associate with the event.
|
3783
|
+
as an offset for scheduling.'
|
3784
|
+
example: America/New_York
|
3785
|
+
nullable: true
|
3786
|
+
type: string
|
3787
|
+
DowntimeIncludedMonitorType:
|
3788
|
+
default: monitors
|
3789
|
+
description: Monitor resource type.
|
3790
|
+
enum:
|
3791
|
+
- monitors
|
3792
|
+
example: monitors
|
3793
|
+
type: string
|
3794
|
+
x-enum-varnames:
|
3795
|
+
- MONITORS
|
3796
|
+
DowntimeMessage:
|
3797
|
+
description: 'A message to include with notifications for this downtime. Email
|
3798
|
+
notifications can be sent to specific users
|
3712
3799
|
|
3713
|
-
|
3714
|
-
|
3715
|
-
|
3716
|
-
|
3717
|
-
|
3718
|
-
|
3719
|
-
|
3720
|
-
|
3721
|
-
|
3722
|
-
|
3723
|
-
|
3724
|
-
|
3725
|
-
|
3726
|
-
|
3800
|
+
by using the same `@username` notation as events.'
|
3801
|
+
example: Message about the downtime
|
3802
|
+
nullable: true
|
3803
|
+
type: string
|
3804
|
+
DowntimeMeta:
|
3805
|
+
description: Pagination metadata returned by the API.
|
3806
|
+
properties:
|
3807
|
+
page:
|
3808
|
+
$ref: '#/components/schemas/DowntimeMetaPage'
|
3809
|
+
type: object
|
3810
|
+
DowntimeMetaPage:
|
3811
|
+
description: Object containing the total filtered count.
|
3812
|
+
properties:
|
3813
|
+
total_filtered_count:
|
3814
|
+
description: Total count of elements matched by the filter.
|
3727
3815
|
format: int64
|
3728
|
-
nullable: true
|
3729
3816
|
type: integer
|
3730
|
-
|
3731
|
-
|
3732
|
-
|
3733
|
-
|
3817
|
+
type: object
|
3818
|
+
DowntimeMonitorIdentifier:
|
3819
|
+
description: Monitor identifier for the downtime.
|
3820
|
+
oneOf:
|
3821
|
+
- $ref: '#/components/schemas/DowntimeMonitorIdentifierId'
|
3822
|
+
- $ref: '#/components/schemas/DowntimeMonitorIdentifierTags'
|
3823
|
+
type: object
|
3824
|
+
DowntimeMonitorIdentifierId:
|
3825
|
+
additionalProperties: {}
|
3826
|
+
description: Object of the monitor identifier.
|
3827
|
+
properties:
|
3828
|
+
monitor_id:
|
3829
|
+
description: ID of the monitor to prevent notifications.
|
3830
|
+
example: 123
|
3734
3831
|
format: int64
|
3735
3832
|
type: integer
|
3736
|
-
|
3737
|
-
|
3738
|
-
|
3739
|
-
|
3740
|
-
|
3741
|
-
|
3833
|
+
required:
|
3834
|
+
- monitor_id
|
3835
|
+
type: object
|
3836
|
+
DowntimeMonitorIdentifierTags:
|
3837
|
+
additionalProperties: {}
|
3838
|
+
description: Object of the monitor tags.
|
3839
|
+
properties:
|
3840
|
+
monitor_tags:
|
3841
|
+
description: 'A list of monitor tags. For example, tags that are applied
|
3842
|
+
directly to monitors,
|
3742
3843
|
|
3743
|
-
|
3744
|
-
|
3844
|
+
not tags that are used in monitor queries (which are filtered by the scope
|
3845
|
+
parameter), to which the downtime applies.
|
3745
3846
|
|
3746
|
-
The
|
3747
|
-
|
3748
|
-
|
3749
|
-
|
3750
|
-
an externally-submitted event, or an integration.
|
3751
|
-
type: string
|
3752
|
-
status:
|
3753
|
-
$ref: '#/components/schemas/EventStatusType'
|
3754
|
-
tags:
|
3755
|
-
description: A list of tags to apply to the event.
|
3847
|
+
The resulting downtime applies to monitors that match **all** provided
|
3848
|
+
monitor tags. Setting `monitor_tags`
|
3849
|
+
|
3850
|
+
to `[*]` configures the downtime to mute all monitors for the given scope.'
|
3756
3851
|
example:
|
3757
|
-
-
|
3852
|
+
- service:postgres
|
3853
|
+
- team:frontend
|
3758
3854
|
items:
|
3759
|
-
description: A
|
3855
|
+
description: A list of monitor tags.
|
3856
|
+
example: service:postgres
|
3760
3857
|
type: string
|
3858
|
+
minItems: 1
|
3761
3859
|
type: array
|
3762
|
-
|
3763
|
-
|
3764
|
-
|
3860
|
+
required:
|
3861
|
+
- monitor_tags
|
3862
|
+
type: object
|
3863
|
+
DowntimeMonitorIncludedAttributes:
|
3864
|
+
description: Attributes of the monitor identified by the downtime.
|
3865
|
+
properties:
|
3866
|
+
name:
|
3867
|
+
description: The name of the monitor identified by the downtime.
|
3868
|
+
example: A monitor name
|
3869
|
+
type: string
|
3870
|
+
type: object
|
3871
|
+
DowntimeMonitorIncludedItem:
|
3872
|
+
description: Information about the monitor identified by the downtime.
|
3873
|
+
properties:
|
3874
|
+
attributes:
|
3875
|
+
$ref: '#/components/schemas/DowntimeMonitorIncludedAttributes'
|
3876
|
+
id:
|
3877
|
+
description: ID of the monitor identified by the downtime.
|
3878
|
+
example: 12345
|
3765
3879
|
format: int64
|
3766
3880
|
type: integer
|
3767
|
-
|
3768
|
-
|
3769
|
-
example: Oh boy!
|
3770
|
-
type: string
|
3881
|
+
type:
|
3882
|
+
$ref: '#/components/schemas/DowntimeIncludedMonitorType'
|
3771
3883
|
type: object
|
3772
|
-
|
3773
|
-
description:
|
3884
|
+
DowntimeMuteFirstRecoveryNotification:
|
3885
|
+
description: If the first recovery notification during a downtime should be
|
3886
|
+
muted.
|
3887
|
+
example: false
|
3888
|
+
type: boolean
|
3889
|
+
DowntimeNotifyEndStateActions:
|
3890
|
+
description: Action that will trigger a monitor notification if the downtime
|
3891
|
+
is in the `notify_end_types` state.
|
3774
3892
|
enum:
|
3775
|
-
-
|
3776
|
-
-
|
3777
|
-
example:
|
3778
|
-
nullable: true
|
3893
|
+
- canceled
|
3894
|
+
- expired
|
3895
|
+
example: canceled
|
3779
3896
|
type: string
|
3780
3897
|
x-enum-varnames:
|
3781
|
-
-
|
3782
|
-
-
|
3783
|
-
|
3784
|
-
description:
|
3785
|
-
|
3898
|
+
- CANCELED
|
3899
|
+
- EXPIRED
|
3900
|
+
DowntimeNotifyEndStateTypes:
|
3901
|
+
description: State that will trigger a monitor notification when the `notify_end_types`
|
3902
|
+
action occurs.
|
3903
|
+
enum:
|
3904
|
+
- alert
|
3905
|
+
- no data
|
3906
|
+
- warn
|
3907
|
+
example: alert
|
3908
|
+
type: string
|
3909
|
+
x-enum-varnames:
|
3910
|
+
- ALERT
|
3911
|
+
- NO_DATA
|
3912
|
+
- WARN
|
3913
|
+
DowntimeNotifyEndStates:
|
3914
|
+
description: States that will trigger a monitor notification when the `notify_end_types`
|
3915
|
+
action occurs.
|
3916
|
+
example:
|
3917
|
+
- alert
|
3918
|
+
- warn
|
3919
|
+
items:
|
3920
|
+
$ref: '#/components/schemas/DowntimeNotifyEndStateTypes'
|
3921
|
+
type: array
|
3922
|
+
DowntimeNotifyEndTypes:
|
3923
|
+
description: Actions that will trigger a monitor notification if the downtime
|
3924
|
+
is in the `notify_end_types` state.
|
3925
|
+
example:
|
3926
|
+
- canceled
|
3927
|
+
- expired
|
3928
|
+
items:
|
3929
|
+
$ref: '#/components/schemas/DowntimeNotifyEndStateActions'
|
3930
|
+
type: array
|
3931
|
+
DowntimeRelationships:
|
3932
|
+
description: All relationships associated with downtime.
|
3933
|
+
properties:
|
3934
|
+
created_by:
|
3935
|
+
$ref: '#/components/schemas/DowntimeRelationshipsCreatedBy'
|
3936
|
+
monitor:
|
3937
|
+
$ref: '#/components/schemas/DowntimeRelationshipsMonitor'
|
3938
|
+
type: object
|
3939
|
+
DowntimeRelationshipsCreatedBy:
|
3940
|
+
description: The user who created the downtime.
|
3941
|
+
properties:
|
3942
|
+
data:
|
3943
|
+
$ref: '#/components/schemas/DowntimeRelationshipsCreatedByData'
|
3944
|
+
type: object
|
3945
|
+
DowntimeRelationshipsCreatedByData:
|
3946
|
+
description: Data for the user who created the downtime.
|
3947
|
+
nullable: true
|
3786
3948
|
properties:
|
3787
|
-
attributes:
|
3788
|
-
$ref: '#/components/schemas/EventResponseAttributes'
|
3789
3949
|
id:
|
3790
|
-
description:
|
3791
|
-
example:
|
3950
|
+
description: User ID of the downtime creator.
|
3951
|
+
example: 00000000-0000-1234-0000-000000000000
|
3792
3952
|
type: string
|
3793
3953
|
type:
|
3794
|
-
$ref: '#/components/schemas/
|
3954
|
+
$ref: '#/components/schemas/UsersType'
|
3795
3955
|
type: object
|
3796
|
-
|
3797
|
-
description: The
|
3956
|
+
DowntimeRelationshipsMonitor:
|
3957
|
+
description: The monitor identified by the downtime.
|
3798
3958
|
properties:
|
3799
|
-
|
3800
|
-
$ref: '#/components/schemas/
|
3801
|
-
|
3802
|
-
|
3803
|
-
|
3804
|
-
|
3959
|
+
data:
|
3960
|
+
$ref: '#/components/schemas/DowntimeRelationshipsMonitorData'
|
3961
|
+
type: object
|
3962
|
+
DowntimeRelationshipsMonitorData:
|
3963
|
+
description: Data for the monitor.
|
3964
|
+
nullable: true
|
3965
|
+
properties:
|
3966
|
+
id:
|
3967
|
+
description: Monitor ID of the downtime.
|
3968
|
+
example: 12345
|
3969
|
+
format: int64
|
3970
|
+
type: integer
|
3971
|
+
type:
|
3972
|
+
$ref: '#/components/schemas/DowntimeIncludedMonitorType'
|
3973
|
+
type: object
|
3974
|
+
DowntimeResourceType:
|
3975
|
+
default: downtime
|
3976
|
+
description: Downtime resource type.
|
3977
|
+
enum:
|
3978
|
+
- downtime
|
3979
|
+
example: downtime
|
3980
|
+
type: string
|
3981
|
+
x-enum-varnames:
|
3982
|
+
- DOWNTIME
|
3983
|
+
DowntimeResponse:
|
3984
|
+
description: 'Downtiming gives you greater control over monitor notifications
|
3985
|
+
by
|
3986
|
+
|
3987
|
+
allowing you to globally exclude scopes from alerting.
|
3988
|
+
|
3989
|
+
Downtime settings, which can be scheduled with start and end times,
|
3990
|
+
|
3991
|
+
prevent all alerting related to specified Datadog tags.'
|
3992
|
+
properties:
|
3993
|
+
data:
|
3994
|
+
$ref: '#/components/schemas/DowntimeResponseData'
|
3995
|
+
included:
|
3996
|
+
description: Array of objects related to the downtime that the user requested.
|
3805
3997
|
items:
|
3806
|
-
|
3807
|
-
type: string
|
3998
|
+
$ref: '#/components/schemas/DowntimeResponseIncludedItem'
|
3808
3999
|
type: array
|
3809
|
-
|
3810
|
-
|
3811
|
-
|
4000
|
+
type: object
|
4001
|
+
DowntimeResponseAttributes:
|
4002
|
+
description: Downtime details.
|
4003
|
+
properties:
|
4004
|
+
canceled:
|
4005
|
+
description: Time that the downtime was canceled.
|
4006
|
+
example: 2020-01-02T03:04:05.282979+0000
|
4007
|
+
format: date-time
|
4008
|
+
nullable: true
|
4009
|
+
type: string
|
4010
|
+
created:
|
4011
|
+
description: Creation time of the downtime.
|
4012
|
+
example: 2020-01-02T03:04:05.282979+0000
|
4013
|
+
format: date-time
|
4014
|
+
type: string
|
4015
|
+
display_timezone:
|
4016
|
+
$ref: '#/components/schemas/DowntimeDisplayTimezone'
|
4017
|
+
message:
|
4018
|
+
$ref: '#/components/schemas/DowntimeMessage'
|
4019
|
+
modified:
|
4020
|
+
description: Time that the downtime was last modified.
|
4021
|
+
example: 2020-01-02T03:04:05.282979+0000
|
4022
|
+
format: date-time
|
4023
|
+
type: string
|
4024
|
+
monitor_identifier:
|
4025
|
+
$ref: '#/components/schemas/DowntimeMonitorIdentifier'
|
4026
|
+
mute_first_recovery_notification:
|
4027
|
+
$ref: '#/components/schemas/DowntimeMuteFirstRecoveryNotification'
|
4028
|
+
notify_end_states:
|
4029
|
+
$ref: '#/components/schemas/DowntimeNotifyEndStates'
|
4030
|
+
notify_end_types:
|
4031
|
+
$ref: '#/components/schemas/DowntimeNotifyEndTypes'
|
4032
|
+
schedule:
|
4033
|
+
$ref: '#/components/schemas/DowntimeScheduleResponse'
|
4034
|
+
scope:
|
4035
|
+
$ref: '#/components/schemas/DowntimeScope'
|
4036
|
+
status:
|
4037
|
+
$ref: '#/components/schemas/DowntimeStatus'
|
4038
|
+
type: object
|
4039
|
+
DowntimeResponseData:
|
4040
|
+
description: Downtime data.
|
4041
|
+
properties:
|
4042
|
+
attributes:
|
4043
|
+
$ref: '#/components/schemas/DowntimeResponseAttributes'
|
4044
|
+
id:
|
4045
|
+
description: The downtime ID.
|
4046
|
+
example: 00000000-0000-1234-0000-000000000000
|
4047
|
+
type: string
|
4048
|
+
relationships:
|
4049
|
+
$ref: '#/components/schemas/DowntimeRelationships'
|
4050
|
+
type:
|
4051
|
+
$ref: '#/components/schemas/DowntimeResourceType'
|
4052
|
+
type: object
|
4053
|
+
DowntimeResponseIncludedItem:
|
4054
|
+
description: An object related to a downtime.
|
4055
|
+
oneOf:
|
4056
|
+
- $ref: '#/components/schemas/User'
|
4057
|
+
- $ref: '#/components/schemas/DowntimeMonitorIncludedItem'
|
4058
|
+
type: object
|
4059
|
+
DowntimeScheduleCreateRequest:
|
4060
|
+
description: Schedule for the downtime.
|
4061
|
+
oneOf:
|
4062
|
+
- $ref: '#/components/schemas/DowntimeScheduleRecurrencesCreateRequest'
|
4063
|
+
- $ref: '#/components/schemas/DowntimeScheduleOneTimeCreateUpdateRequest'
|
4064
|
+
type: object
|
4065
|
+
DowntimeScheduleCurrentDowntimeResponse:
|
4066
|
+
description: 'The most recent actual start and end dates for a recurring downtime.
|
4067
|
+
For a canceled downtime,
|
4068
|
+
|
4069
|
+
this is the previously occurring downtime. For active downtimes, this is the
|
4070
|
+
ongoing downtime, and for scheduled
|
4071
|
+
|
4072
|
+
downtimes it is the upcoming downtime.'
|
4073
|
+
properties:
|
4074
|
+
end:
|
4075
|
+
description: The end of the current downtime.
|
4076
|
+
example: 2020-01-02 03:04:00+00:00
|
4077
|
+
format: date-time
|
4078
|
+
nullable: true
|
4079
|
+
type: string
|
4080
|
+
start:
|
4081
|
+
description: The start of the current downtime.
|
4082
|
+
example: 2020-01-02 03:04:00+00:00
|
4083
|
+
format: date-time
|
4084
|
+
type: string
|
4085
|
+
type: object
|
4086
|
+
DowntimeScheduleOneTimeCreateUpdateRequest:
|
4087
|
+
additionalProperties: {}
|
4088
|
+
description: A one-time downtime definition.
|
4089
|
+
properties:
|
4090
|
+
end:
|
4091
|
+
description: 'ISO-8601 Datetime to end the downtime. Must include a UTC
|
4092
|
+
offset of zero. If not provided, the
|
4093
|
+
|
4094
|
+
downtime continues forever.'
|
4095
|
+
example: 2020-01-02 03:04:00+00:00
|
4096
|
+
format: date-time
|
4097
|
+
nullable: true
|
4098
|
+
type: string
|
4099
|
+
start:
|
4100
|
+
description: 'ISO-8601 Datetime to start the downtime. Must include a UTC
|
4101
|
+
offset of zero. If not provided, the
|
4102
|
+
|
4103
|
+
downtime starts the moment it is created.'
|
4104
|
+
example: 2020-01-02 03:04:00+00:00
|
4105
|
+
format: date-time
|
4106
|
+
nullable: true
|
4107
|
+
type: string
|
4108
|
+
type: object
|
4109
|
+
DowntimeScheduleOneTimeResponse:
|
4110
|
+
description: A one-time downtime definition.
|
4111
|
+
properties:
|
4112
|
+
end:
|
4113
|
+
description: ISO-8601 Datetime to end the downtime.
|
4114
|
+
example: 2020-01-02 03:04:00+00:00
|
4115
|
+
format: date-time
|
4116
|
+
nullable: true
|
4117
|
+
type: string
|
4118
|
+
start:
|
4119
|
+
description: ISO-8601 Datetime to start the downtime.
|
4120
|
+
example: 2020-01-02 03:04:00+00:00
|
4121
|
+
format: date-time
|
4122
|
+
type: string
|
4123
|
+
type: object
|
4124
|
+
DowntimeScheduleRecurrenceCreateUpdateRequest:
|
4125
|
+
additionalProperties: {}
|
4126
|
+
description: An object defining the recurrence of the downtime.
|
4127
|
+
properties:
|
4128
|
+
duration:
|
4129
|
+
$ref: '#/components/schemas/DowntimeScheduleRecurrenceDuration'
|
4130
|
+
rrule:
|
4131
|
+
$ref: '#/components/schemas/DowntimeScheduleRecurrenceRrule'
|
4132
|
+
start:
|
4133
|
+
description: 'ISO-8601 Datetime to start the downtime. Must not include
|
4134
|
+
a UTC offset. If not provided, the
|
4135
|
+
|
4136
|
+
downtime starts the moment it is created.'
|
4137
|
+
example: 2020-01-02T03:04
|
4138
|
+
nullable: true
|
4139
|
+
type: string
|
4140
|
+
required:
|
4141
|
+
- duration
|
4142
|
+
- rrule
|
4143
|
+
type: object
|
4144
|
+
DowntimeScheduleRecurrenceDuration:
|
4145
|
+
description: The length of the downtime. Must begin with an integer and end
|
4146
|
+
with one of 'm', 'h', d', or 'w'.
|
4147
|
+
example: 123d
|
4148
|
+
type: string
|
4149
|
+
DowntimeScheduleRecurrenceResponse:
|
4150
|
+
description: An RRULE-based recurring downtime.
|
4151
|
+
properties:
|
4152
|
+
duration:
|
4153
|
+
$ref: '#/components/schemas/DowntimeScheduleRecurrenceDuration'
|
4154
|
+
rrule:
|
4155
|
+
$ref: '#/components/schemas/DowntimeScheduleRecurrenceRrule'
|
4156
|
+
start:
|
4157
|
+
description: 'ISO-8601 Datetime to start the downtime. Must not include
|
4158
|
+
a UTC offset. If not provided, the
|
4159
|
+
|
4160
|
+
downtime starts the moment it is created.'
|
4161
|
+
example: 2020-01-02T03:04
|
4162
|
+
type: string
|
4163
|
+
type: object
|
4164
|
+
DowntimeScheduleRecurrenceRrule:
|
4165
|
+
description: 'The `RRULE` standard for defining recurring events.
|
4166
|
+
|
4167
|
+
For example, to have a recurring event on the first day of each month, set
|
4168
|
+
the type to `rrule` and set the `FREQ` to `MONTHLY` and `BYMONTHDAY` to `1`.
|
4169
|
+
|
4170
|
+
Most common `rrule` options from the [iCalendar Spec](https://tools.ietf.org/html/rfc5545)
|
4171
|
+
are supported.
|
4172
|
+
|
4173
|
+
|
4174
|
+
**Note**: Attributes specifying the duration in `RRULE` are not supported
|
4175
|
+
(for example, `DTSTART`, `DTEND`, `DURATION`).
|
4176
|
+
|
4177
|
+
More examples available in this [downtime guide](https://docs.datadoghq.com/monitors/guide/suppress-alert-with-downtimes/?tab=api).'
|
4178
|
+
example: FREQ=MONTHLY;BYSETPOS=3;BYDAY=WE;INTERVAL=1
|
4179
|
+
type: string
|
4180
|
+
DowntimeScheduleRecurrencesCreateRequest:
|
4181
|
+
description: A recurring downtime schedule definition.
|
4182
|
+
properties:
|
4183
|
+
recurrences:
|
4184
|
+
description: A list of downtime recurrences.
|
4185
|
+
items:
|
4186
|
+
$ref: '#/components/schemas/DowntimeScheduleRecurrenceCreateUpdateRequest'
|
4187
|
+
type: array
|
4188
|
+
timezone:
|
4189
|
+
default: UTC
|
4190
|
+
description: The timezone in which to schedule the downtime.
|
4191
|
+
example: America/New_York
|
4192
|
+
type: string
|
4193
|
+
required:
|
4194
|
+
- recurrences
|
4195
|
+
type: object
|
4196
|
+
DowntimeScheduleRecurrencesResponse:
|
4197
|
+
description: A recurring downtime schedule definition.
|
4198
|
+
properties:
|
4199
|
+
current_downtime:
|
4200
|
+
$ref: '#/components/schemas/DowntimeScheduleCurrentDowntimeResponse'
|
4201
|
+
recurrences:
|
4202
|
+
description: A list of downtime recurrences.
|
4203
|
+
items:
|
4204
|
+
$ref: '#/components/schemas/DowntimeScheduleRecurrenceResponse'
|
4205
|
+
maxItems: 5
|
4206
|
+
minItems: 1
|
4207
|
+
type: array
|
4208
|
+
timezone:
|
4209
|
+
default: UTC
|
4210
|
+
description: 'The timezone in which to schedule the downtime. This affects
|
4211
|
+
recurring start and end dates.
|
4212
|
+
|
4213
|
+
Must match `display_timezone`.'
|
4214
|
+
example: America/New_York
|
4215
|
+
type: string
|
4216
|
+
required:
|
4217
|
+
- recurrences
|
4218
|
+
type: object
|
4219
|
+
DowntimeScheduleRecurrencesUpdateRequest:
|
4220
|
+
description: A recurring downtime schedule definition.
|
4221
|
+
properties:
|
4222
|
+
recurrences:
|
4223
|
+
description: A list of downtime recurrences.
|
4224
|
+
items:
|
4225
|
+
$ref: '#/components/schemas/DowntimeScheduleRecurrenceCreateUpdateRequest'
|
4226
|
+
type: array
|
4227
|
+
timezone:
|
4228
|
+
default: UTC
|
4229
|
+
description: The timezone in which to schedule the downtime.
|
4230
|
+
example: America/New_York
|
4231
|
+
type: string
|
4232
|
+
type: object
|
4233
|
+
DowntimeScheduleResponse:
|
4234
|
+
description: 'The schedule that defines when the monitor starts, stops, and
|
4235
|
+
recurs. There are two types of schedules:
|
4236
|
+
|
4237
|
+
one-time and recurring. Recurring schedules may have up to five RRULE-based
|
4238
|
+
recurrences. If no schedules are
|
4239
|
+
|
4240
|
+
provided, the downtime will begin immediately and never end.'
|
4241
|
+
oneOf:
|
4242
|
+
- $ref: '#/components/schemas/DowntimeScheduleRecurrencesResponse'
|
4243
|
+
- $ref: '#/components/schemas/DowntimeScheduleOneTimeResponse'
|
4244
|
+
type: object
|
4245
|
+
DowntimeScheduleUpdateRequest:
|
4246
|
+
description: Schedule for the downtime.
|
4247
|
+
oneOf:
|
4248
|
+
- $ref: '#/components/schemas/DowntimeScheduleRecurrencesUpdateRequest'
|
4249
|
+
- $ref: '#/components/schemas/DowntimeScheduleOneTimeCreateUpdateRequest'
|
4250
|
+
type: object
|
4251
|
+
DowntimeScope:
|
4252
|
+
description: The scope to which the downtime applies. Must follow the [common
|
4253
|
+
search syntax](https://docs.datadoghq.com/logs/explorer/search_syntax/).
|
4254
|
+
example: env:(staging OR prod) AND datacenter:us-east-1
|
4255
|
+
type: string
|
4256
|
+
DowntimeStatus:
|
4257
|
+
description: The current status of the downtime.
|
4258
|
+
enum:
|
4259
|
+
- active
|
4260
|
+
- canceled
|
4261
|
+
- ended
|
4262
|
+
- scheduled
|
4263
|
+
example: active
|
4264
|
+
type: string
|
4265
|
+
x-enum-varnames:
|
4266
|
+
- ACTIVE
|
4267
|
+
- CANCELED
|
4268
|
+
- ENDED
|
4269
|
+
- SCHEDULED
|
4270
|
+
DowntimeUpdateRequest:
|
4271
|
+
description: Request for editing a downtime.
|
4272
|
+
properties:
|
4273
|
+
data:
|
4274
|
+
$ref: '#/components/schemas/DowntimeUpdateRequestData'
|
4275
|
+
required:
|
4276
|
+
- data
|
4277
|
+
type: object
|
4278
|
+
DowntimeUpdateRequestAttributes:
|
4279
|
+
description: Attributes of the downtime to update.
|
4280
|
+
properties:
|
4281
|
+
display_timezone:
|
4282
|
+
$ref: '#/components/schemas/DowntimeDisplayTimezone'
|
4283
|
+
message:
|
4284
|
+
$ref: '#/components/schemas/DowntimeMessage'
|
4285
|
+
monitor_identifier:
|
4286
|
+
$ref: '#/components/schemas/DowntimeMonitorIdentifier'
|
4287
|
+
mute_first_recovery_notification:
|
4288
|
+
$ref: '#/components/schemas/DowntimeMuteFirstRecoveryNotification'
|
4289
|
+
notify_end_states:
|
4290
|
+
$ref: '#/components/schemas/DowntimeNotifyEndStates'
|
4291
|
+
notify_end_types:
|
4292
|
+
$ref: '#/components/schemas/DowntimeNotifyEndTypes'
|
4293
|
+
schedule:
|
4294
|
+
$ref: '#/components/schemas/DowntimeScheduleUpdateRequest'
|
4295
|
+
scope:
|
4296
|
+
$ref: '#/components/schemas/DowntimeScope'
|
4297
|
+
type: object
|
4298
|
+
DowntimeUpdateRequestData:
|
4299
|
+
description: Object to update a downtime.
|
4300
|
+
properties:
|
4301
|
+
attributes:
|
4302
|
+
$ref: '#/components/schemas/DowntimeUpdateRequestAttributes'
|
4303
|
+
id:
|
4304
|
+
description: ID of this downtime.
|
4305
|
+
example: 00000000-0000-1234-0000-000000000000
|
4306
|
+
type: string
|
4307
|
+
type:
|
4308
|
+
$ref: '#/components/schemas/DowntimeResourceType'
|
4309
|
+
required:
|
4310
|
+
- id
|
4311
|
+
- type
|
4312
|
+
- attributes
|
4313
|
+
type: object
|
4314
|
+
Event:
|
4315
|
+
description: The metadata associated with a request.
|
4316
|
+
properties:
|
4317
|
+
id:
|
4318
|
+
description: Event ID.
|
4319
|
+
example: '6509751066204996294'
|
4320
|
+
type: string
|
4321
|
+
name:
|
4322
|
+
description: The event name.
|
4323
|
+
type: string
|
4324
|
+
source_id:
|
4325
|
+
description: Event source ID.
|
4326
|
+
example: 36
|
4327
|
+
format: int64
|
4328
|
+
type: integer
|
4329
|
+
type:
|
4330
|
+
description: Event type.
|
4331
|
+
example: error_tracking_alert
|
4332
|
+
type: string
|
4333
|
+
type: object
|
4334
|
+
EventAttributes:
|
4335
|
+
description: Object description of attributes from your event.
|
4336
|
+
properties:
|
4337
|
+
aggregation_key:
|
4338
|
+
description: Aggregation key of the event.
|
4339
|
+
type: string
|
4340
|
+
date_happened:
|
4341
|
+
description: 'POSIX timestamp of the event. Must be sent as an integer (no
|
4342
|
+
quotation marks).
|
4343
|
+
|
4344
|
+
Limited to events no older than 18 hours.'
|
4345
|
+
format: int64
|
4346
|
+
type: integer
|
4347
|
+
device_name:
|
4348
|
+
description: A device name.
|
4349
|
+
type: string
|
4350
|
+
duration:
|
4351
|
+
description: The duration between the triggering of the event and its recovery
|
4352
|
+
in nanoseconds.
|
4353
|
+
format: int64
|
4354
|
+
type: integer
|
4355
|
+
event_object:
|
4356
|
+
description: The event title.
|
4357
|
+
example: Did you hear the news today?
|
4358
|
+
type: string
|
4359
|
+
evt:
|
4360
|
+
$ref: '#/components/schemas/Event'
|
4361
|
+
hostname:
|
4362
|
+
description: 'Host name to associate with the event.
|
4363
|
+
|
4364
|
+
Any tags associated with the host are also applied to this event.'
|
4365
|
+
type: string
|
4366
|
+
monitor:
|
4367
|
+
$ref: '#/components/schemas/MonitorType'
|
4368
|
+
monitor_groups:
|
4369
|
+
description: List of groups referred to in the event.
|
4370
|
+
items:
|
4371
|
+
description: Group referred to in the event.
|
4372
|
+
type: string
|
4373
|
+
nullable: true
|
4374
|
+
type: array
|
4375
|
+
monitor_id:
|
4376
|
+
description: ID of the monitor that triggered the event. When an event isn't
|
4377
|
+
related to a monitor, this field is empty.
|
4378
|
+
format: int64
|
4379
|
+
nullable: true
|
4380
|
+
type: integer
|
4381
|
+
priority:
|
4382
|
+
$ref: '#/components/schemas/EventPriority'
|
4383
|
+
related_event_id:
|
4384
|
+
description: Related event ID.
|
4385
|
+
format: int64
|
4386
|
+
type: integer
|
4387
|
+
service:
|
4388
|
+
description: Service that triggered the event.
|
4389
|
+
example: datadog-api
|
4390
|
+
type: string
|
4391
|
+
source_type_name:
|
4392
|
+
description: 'The type of event being posted.
|
4393
|
+
|
4394
|
+
For example, `nagios`, `hudson`, `jenkins`, `my_apps`, `chef`, `puppet`,
|
4395
|
+
`git` or `bitbucket`.
|
4396
|
+
|
4397
|
+
The list of standard source attribute values is [available here](https://docs.datadoghq.com/integrations/faq/list-of-api-source-attribute-value).'
|
4398
|
+
type: string
|
4399
|
+
sourcecategory:
|
4400
|
+
description: Identifier for the source of the event, such as a monitor alert,
|
4401
|
+
an externally-submitted event, or an integration.
|
4402
|
+
type: string
|
4403
|
+
status:
|
4404
|
+
$ref: '#/components/schemas/EventStatusType'
|
4405
|
+
tags:
|
4406
|
+
description: A list of tags to apply to the event.
|
4407
|
+
example:
|
4408
|
+
- environment:test
|
4409
|
+
items:
|
4410
|
+
description: A tag.
|
4411
|
+
type: string
|
4412
|
+
type: array
|
4413
|
+
timestamp:
|
4414
|
+
description: POSIX timestamp of your event in milliseconds.
|
4415
|
+
example: 1652274265000
|
4416
|
+
format: int64
|
4417
|
+
type: integer
|
4418
|
+
title:
|
4419
|
+
description: The event title.
|
4420
|
+
example: Oh boy!
|
4421
|
+
type: string
|
4422
|
+
type: object
|
4423
|
+
EventPriority:
|
4424
|
+
description: The priority of the event's monitor. For example, `normal` or `low`.
|
4425
|
+
enum:
|
4426
|
+
- normal
|
4427
|
+
- low
|
4428
|
+
example: normal
|
4429
|
+
nullable: true
|
4430
|
+
type: string
|
4431
|
+
x-enum-varnames:
|
4432
|
+
- NORMAL
|
4433
|
+
- LOW
|
4434
|
+
EventResponse:
|
4435
|
+
description: The object description of an event after being processed and stored
|
4436
|
+
by Datadog.
|
4437
|
+
properties:
|
4438
|
+
attributes:
|
4439
|
+
$ref: '#/components/schemas/EventResponseAttributes'
|
4440
|
+
id:
|
4441
|
+
description: the unique ID of the event.
|
4442
|
+
example: AAAAAWgN8Xwgr1vKDQAAAABBV2dOOFh3ZzZobm1mWXJFYTR0OA
|
4443
|
+
type: string
|
4444
|
+
type:
|
4445
|
+
$ref: '#/components/schemas/EventType'
|
4446
|
+
type: object
|
4447
|
+
EventResponseAttributes:
|
4448
|
+
description: The object description of an event response attribute.
|
4449
|
+
properties:
|
4450
|
+
attributes:
|
4451
|
+
$ref: '#/components/schemas/EventAttributes'
|
4452
|
+
message:
|
4453
|
+
description: The message of the event.
|
4454
|
+
type: string
|
4455
|
+
tags:
|
4456
|
+
description: An array of tags associated with the event.
|
4457
|
+
example:
|
4458
|
+
- team:A
|
4459
|
+
items:
|
4460
|
+
description: The tag associated with the event.
|
4461
|
+
type: string
|
4462
|
+
type: array
|
4463
|
+
timestamp:
|
4464
|
+
description: The timestamp of the event.
|
4465
|
+
example: '2019-01-02T09:42:36.320Z'
|
3812
4466
|
format: date-time
|
3813
4467
|
type: string
|
3814
4468
|
type: object
|
@@ -3927,8 +4581,8 @@ components:
|
|
3927
4581
|
aggregation:
|
3928
4582
|
$ref: '#/components/schemas/EventsAggregation'
|
3929
4583
|
metric:
|
3930
|
-
description:
|
3931
|
-
sort order of a query's results.
|
4584
|
+
description: The metric's calculated value which should be used to define
|
4585
|
+
the sort order of a query's results.
|
3932
4586
|
example: '@duration'
|
3933
4587
|
type: string
|
3934
4588
|
order:
|
@@ -4048,6 +4702,10 @@ components:
|
|
4048
4702
|
description: The identifier of the request.
|
4049
4703
|
example: MWlFUjVaWGZTTTZPYzM0VXp1OXU2d3xLSVpEMjZKQ0VKUTI0dEYtM3RSOFVR
|
4050
4704
|
type: string
|
4705
|
+
status:
|
4706
|
+
description: The request status.
|
4707
|
+
example: done
|
4708
|
+
type: string
|
4051
4709
|
warnings:
|
4052
4710
|
description: 'A list of warnings (non-fatal errors) encountered. Partial
|
4053
4711
|
results might be returned if
|
@@ -6896,6 +7554,22 @@ components:
|
|
6896
7554
|
$ref: '#/components/schemas/ApplicationKeyResponseIncludedItem'
|
6897
7555
|
type: array
|
6898
7556
|
type: object
|
7557
|
+
ListDowntimesResponse:
|
7558
|
+
description: Response for retrieving all downtimes.
|
7559
|
+
properties:
|
7560
|
+
data:
|
7561
|
+
description: An array of downtimes.
|
7562
|
+
items:
|
7563
|
+
$ref: '#/components/schemas/DowntimeResponseData'
|
7564
|
+
type: array
|
7565
|
+
included:
|
7566
|
+
description: Array of objects related to the downtimes.
|
7567
|
+
items:
|
7568
|
+
$ref: '#/components/schemas/DowntimeResponseIncludedItem'
|
7569
|
+
type: array
|
7570
|
+
meta:
|
7571
|
+
$ref: '#/components/schemas/DowntimeMeta'
|
7572
|
+
type: object
|
6899
7573
|
ListFindingsData:
|
6900
7574
|
description: Array of findings.
|
6901
7575
|
items:
|
@@ -8903,7 +9577,8 @@ components:
|
|
8903
9577
|
type: object
|
8904
9578
|
MetricsAggregator:
|
8905
9579
|
default: avg
|
8906
|
-
description: The type of aggregation that can be performed on metrics
|
9580
|
+
description: The type of aggregation that can be performed on metrics-based
|
9581
|
+
queries.
|
8907
9582
|
enum:
|
8908
9583
|
- avg
|
8909
9584
|
- min
|
@@ -9164,6 +9839,66 @@ components:
|
|
9164
9839
|
type: string
|
9165
9840
|
x-enum-varnames:
|
9166
9841
|
- TAG
|
9842
|
+
MonitorDowntimeMatchResourceType:
|
9843
|
+
default: downtime_match
|
9844
|
+
description: Monitor Downtime Match resource type.
|
9845
|
+
enum:
|
9846
|
+
- downtime_match
|
9847
|
+
example: downtime_match
|
9848
|
+
type: string
|
9849
|
+
x-enum-varnames:
|
9850
|
+
- DOWNTIME_MATCH
|
9851
|
+
MonitorDowntimeMatchResponse:
|
9852
|
+
description: Response for retrieving all downtime matches for a monitor.
|
9853
|
+
properties:
|
9854
|
+
data:
|
9855
|
+
description: An array of downtime matches.
|
9856
|
+
items:
|
9857
|
+
$ref: '#/components/schemas/MonitorDowntimeMatchResponseData'
|
9858
|
+
type: array
|
9859
|
+
meta:
|
9860
|
+
$ref: '#/components/schemas/DowntimeMeta'
|
9861
|
+
type: object
|
9862
|
+
MonitorDowntimeMatchResponseAttributes:
|
9863
|
+
description: Downtime match details.
|
9864
|
+
properties:
|
9865
|
+
end:
|
9866
|
+
description: The end of the downtime.
|
9867
|
+
example: 2020-01-02 03:04:00+00:00
|
9868
|
+
format: date-time
|
9869
|
+
nullable: true
|
9870
|
+
type: string
|
9871
|
+
groups:
|
9872
|
+
description: An array of groups associated with the downtime.
|
9873
|
+
example:
|
9874
|
+
- service:postgres
|
9875
|
+
- team:frontend
|
9876
|
+
items:
|
9877
|
+
description: An array of groups.
|
9878
|
+
example: service:postgres
|
9879
|
+
type: string
|
9880
|
+
type: array
|
9881
|
+
scope:
|
9882
|
+
$ref: '#/components/schemas/DowntimeScope'
|
9883
|
+
start:
|
9884
|
+
description: The start of the downtime.
|
9885
|
+
example: 2020-01-02 03:04:00+00:00
|
9886
|
+
format: date-time
|
9887
|
+
type: string
|
9888
|
+
type: object
|
9889
|
+
MonitorDowntimeMatchResponseData:
|
9890
|
+
description: A downtime match.
|
9891
|
+
properties:
|
9892
|
+
attributes:
|
9893
|
+
$ref: '#/components/schemas/MonitorDowntimeMatchResponseAttributes'
|
9894
|
+
id:
|
9895
|
+
description: The downtime ID.
|
9896
|
+
example: 00000000-0000-1234-0000-000000000000
|
9897
|
+
nullable: true
|
9898
|
+
type: string
|
9899
|
+
type:
|
9900
|
+
$ref: '#/components/schemas/MonitorDowntimeMatchResourceType'
|
9901
|
+
type: object
|
9167
9902
|
MonitorType:
|
9168
9903
|
description: Attributes from the monitor that triggered the event.
|
9169
9904
|
nullable: true
|
@@ -10143,6 +10878,10 @@ components:
|
|
10143
10878
|
properties:
|
10144
10879
|
attributes:
|
10145
10880
|
$ref: '#/components/schemas/RUMApplicationListAttributes'
|
10881
|
+
id:
|
10882
|
+
description: RUM application ID.
|
10883
|
+
example: abcd1234-0000-0000-abcd-1234abcd5678
|
10884
|
+
type: string
|
10146
10885
|
type:
|
10147
10886
|
$ref: '#/components/schemas/RUMApplicationListType'
|
10148
10887
|
required:
|
@@ -10978,19 +11717,23 @@ components:
|
|
10978
11717
|
description: 'An array of principals. A principal is a subject or group
|
10979
11718
|
of subjects.
|
10980
11719
|
|
10981
|
-
Each principal is formatted as `type:id`. Supported types: `role`
|
10982
|
-
`org`.
|
11720
|
+
Each principal is formatted as `type:id`. Supported types: `role`, `team`
|
11721
|
+
(beta), `user` (beta), and `org`.
|
10983
11722
|
|
10984
|
-
The org ID can be obtained through the api/v2/current_user API.
|
11723
|
+
The org ID can be obtained through the api/v2/current_user API.
|
11724
|
+
|
11725
|
+
The user principal type accepts service account IDs.'
|
10985
11726
|
example:
|
10986
11727
|
- role:00000000-0000-1111-0000-000000000000
|
10987
11728
|
items:
|
10988
11729
|
description: 'Subject or group of subjects. Each principal is formatted
|
10989
11730
|
as `type:id`.
|
10990
11731
|
|
10991
|
-
Supported types: `role` and `org`.
|
11732
|
+
Supported types: `role`, `team` (beta), `user` (beta), and `org`.
|
11733
|
+
|
11734
|
+
The org ID can be obtained through the api/v2/current_user API.
|
10992
11735
|
|
10993
|
-
The
|
11736
|
+
The user principal type accepts service account IDs.'
|
10994
11737
|
type: string
|
10995
11738
|
type: array
|
10996
11739
|
relation:
|
@@ -13480,6 +14223,9 @@ components:
|
|
13480
14223
|
properties:
|
13481
14224
|
attributes:
|
13482
14225
|
$ref: '#/components/schemas/ServiceDefinitionDataAttributes'
|
14226
|
+
id:
|
14227
|
+
description: Service definition id.
|
14228
|
+
type: string
|
13483
14229
|
type:
|
13484
14230
|
description: Service definition type.
|
13485
14231
|
type: string
|
@@ -13513,6 +14259,30 @@ components:
|
|
13513
14259
|
last-modified-time:
|
13514
14260
|
description: Last modified time of the service definition.
|
13515
14261
|
type: string
|
14262
|
+
origin:
|
14263
|
+
description: User defined origin of the service definition.
|
14264
|
+
type: string
|
14265
|
+
origin-detail:
|
14266
|
+
description: User defined origin's detail of the service definition.
|
14267
|
+
type: string
|
14268
|
+
warnings:
|
14269
|
+
description: A list of schema validation warnings.
|
14270
|
+
items:
|
14271
|
+
$ref: '#/components/schemas/ServiceDefinitionMetaWarnings'
|
14272
|
+
type: array
|
14273
|
+
type: object
|
14274
|
+
ServiceDefinitionMetaWarnings:
|
14275
|
+
description: Schema validation warnings.
|
14276
|
+
properties:
|
14277
|
+
instance-location:
|
14278
|
+
description: The warning instance location.
|
14279
|
+
type: string
|
14280
|
+
keyword-location:
|
14281
|
+
description: The warning keyword location.
|
14282
|
+
type: string
|
14283
|
+
message:
|
14284
|
+
description: The warning message.
|
14285
|
+
type: string
|
13516
14286
|
type: object
|
13517
14287
|
ServiceDefinitionRaw:
|
13518
14288
|
description: Service Definition in raw JSON/YAML representation.
|
@@ -13853,12 +14623,173 @@ components:
|
|
13853
14623
|
example: Team Email
|
13854
14624
|
type: string
|
13855
14625
|
type:
|
13856
|
-
$ref: '#/components/schemas/ServiceDefinitionV2Dot1EmailType'
|
14626
|
+
$ref: '#/components/schemas/ServiceDefinitionV2Dot1EmailType'
|
14627
|
+
required:
|
14628
|
+
- type
|
14629
|
+
- contact
|
14630
|
+
type: object
|
14631
|
+
ServiceDefinitionV2Dot1EmailType:
|
14632
|
+
description: Contact type.
|
14633
|
+
enum:
|
14634
|
+
- email
|
14635
|
+
example: email
|
14636
|
+
type: string
|
14637
|
+
x-enum-varnames:
|
14638
|
+
- EMAIL
|
14639
|
+
ServiceDefinitionV2Dot1Integrations:
|
14640
|
+
description: Third party integrations that Datadog supports.
|
14641
|
+
properties:
|
14642
|
+
opsgenie:
|
14643
|
+
$ref: '#/components/schemas/ServiceDefinitionV2Dot1Opsgenie'
|
14644
|
+
pagerduty:
|
14645
|
+
$ref: '#/components/schemas/ServiceDefinitionV2Dot1Pagerduty'
|
14646
|
+
type: object
|
14647
|
+
ServiceDefinitionV2Dot1Link:
|
14648
|
+
description: Service's external links.
|
14649
|
+
properties:
|
14650
|
+
name:
|
14651
|
+
description: Link name.
|
14652
|
+
example: Runbook
|
14653
|
+
type: string
|
14654
|
+
provider:
|
14655
|
+
description: Link provider.
|
14656
|
+
example: Github
|
14657
|
+
type: string
|
14658
|
+
type:
|
14659
|
+
$ref: '#/components/schemas/ServiceDefinitionV2Dot1LinkType'
|
14660
|
+
url:
|
14661
|
+
description: Link URL.
|
14662
|
+
example: https://my-runbook
|
14663
|
+
type: string
|
14664
|
+
required:
|
14665
|
+
- name
|
14666
|
+
- type
|
14667
|
+
- url
|
14668
|
+
type: object
|
14669
|
+
ServiceDefinitionV2Dot1LinkType:
|
14670
|
+
description: Link type.
|
14671
|
+
enum:
|
14672
|
+
- doc
|
14673
|
+
- repo
|
14674
|
+
- runbook
|
14675
|
+
- dashboard
|
14676
|
+
- other
|
14677
|
+
example: runbook
|
14678
|
+
type: string
|
14679
|
+
x-enum-varnames:
|
14680
|
+
- DOC
|
14681
|
+
- REPO
|
14682
|
+
- RUNBOOK
|
14683
|
+
- DASHBOARD
|
14684
|
+
- OTHER
|
14685
|
+
ServiceDefinitionV2Dot1MSTeams:
|
14686
|
+
description: Service owner's Microsoft Teams.
|
14687
|
+
properties:
|
14688
|
+
contact:
|
14689
|
+
description: Contact value.
|
14690
|
+
example: https://teams.microsoft.com/myteam
|
14691
|
+
type: string
|
14692
|
+
name:
|
14693
|
+
description: Contact Microsoft Teams.
|
14694
|
+
example: My team channel
|
14695
|
+
type: string
|
14696
|
+
type:
|
14697
|
+
$ref: '#/components/schemas/ServiceDefinitionV2Dot1MSTeamsType'
|
14698
|
+
required:
|
14699
|
+
- type
|
14700
|
+
- contact
|
14701
|
+
type: object
|
14702
|
+
ServiceDefinitionV2Dot1MSTeamsType:
|
14703
|
+
description: Contact type.
|
14704
|
+
enum:
|
14705
|
+
- microsoft-teams
|
14706
|
+
example: microsoft-teams
|
14707
|
+
type: string
|
14708
|
+
x-enum-varnames:
|
14709
|
+
- MICROSOFT_TEAMS
|
14710
|
+
ServiceDefinitionV2Dot1Opsgenie:
|
14711
|
+
description: Opsgenie integration for the service.
|
14712
|
+
properties:
|
14713
|
+
region:
|
14714
|
+
$ref: '#/components/schemas/ServiceDefinitionV2Dot1OpsgenieRegion'
|
14715
|
+
service-url:
|
14716
|
+
description: Opsgenie service url.
|
14717
|
+
example: https://my-org.opsgenie.com/service/123e4567-e89b-12d3-a456-426614174000
|
14718
|
+
type: string
|
14719
|
+
required:
|
14720
|
+
- service-url
|
14721
|
+
type: object
|
14722
|
+
ServiceDefinitionV2Dot1OpsgenieRegion:
|
14723
|
+
description: Opsgenie instance region.
|
14724
|
+
enum:
|
14725
|
+
- US
|
14726
|
+
- EU
|
14727
|
+
example: US
|
14728
|
+
type: string
|
14729
|
+
x-enum-varnames:
|
14730
|
+
- US
|
14731
|
+
- EU
|
14732
|
+
ServiceDefinitionV2Dot1Pagerduty:
|
14733
|
+
description: PagerDuty integration for the service.
|
14734
|
+
properties:
|
14735
|
+
service-url:
|
14736
|
+
description: PagerDuty service url.
|
14737
|
+
example: https://my-org.pagerduty.com/service-directory/PMyService
|
14738
|
+
type: string
|
14739
|
+
type: object
|
14740
|
+
ServiceDefinitionV2Dot1Slack:
|
14741
|
+
description: Service owner's Slack channel.
|
14742
|
+
properties:
|
14743
|
+
contact:
|
14744
|
+
description: Slack Channel.
|
14745
|
+
example: https://yourcompany.slack.com/archives/channel123
|
14746
|
+
type: string
|
14747
|
+
name:
|
14748
|
+
description: Contact Slack.
|
14749
|
+
example: Team Slack
|
14750
|
+
type: string
|
14751
|
+
type:
|
14752
|
+
$ref: '#/components/schemas/ServiceDefinitionV2Dot1SlackType'
|
14753
|
+
required:
|
14754
|
+
- type
|
14755
|
+
- contact
|
14756
|
+
type: object
|
14757
|
+
ServiceDefinitionV2Dot1SlackType:
|
14758
|
+
description: Contact type.
|
14759
|
+
enum:
|
14760
|
+
- slack
|
14761
|
+
example: slack
|
14762
|
+
type: string
|
14763
|
+
x-enum-varnames:
|
14764
|
+
- SLACK
|
14765
|
+
ServiceDefinitionV2Dot1Version:
|
14766
|
+
default: v2.1
|
14767
|
+
description: Schema version being used.
|
14768
|
+
enum:
|
14769
|
+
- v2.1
|
14770
|
+
example: v2.1
|
14771
|
+
type: string
|
14772
|
+
x-enum-varnames:
|
14773
|
+
- V2_1
|
14774
|
+
ServiceDefinitionV2Email:
|
14775
|
+
description: Service owner's email.
|
14776
|
+
properties:
|
14777
|
+
contact:
|
14778
|
+
description: Contact value.
|
14779
|
+
example: contact@datadoghq.com
|
14780
|
+
format: email
|
14781
|
+
type: string
|
14782
|
+
name:
|
14783
|
+
description: Contact email.
|
14784
|
+
example: Team Email
|
14785
|
+
type: string
|
14786
|
+
type:
|
14787
|
+
$ref: '#/components/schemas/ServiceDefinitionV2EmailType'
|
13857
14788
|
required:
|
13858
14789
|
- type
|
13859
14790
|
- contact
|
13860
14791
|
type: object
|
13861
|
-
|
14792
|
+
ServiceDefinitionV2EmailType:
|
13862
14793
|
description: Contact type.
|
13863
14794
|
enum:
|
13864
14795
|
- email
|
@@ -13866,27 +14797,23 @@ components:
|
|
13866
14797
|
type: string
|
13867
14798
|
x-enum-varnames:
|
13868
14799
|
- EMAIL
|
13869
|
-
|
14800
|
+
ServiceDefinitionV2Integrations:
|
13870
14801
|
description: Third party integrations that Datadog supports.
|
13871
14802
|
properties:
|
13872
14803
|
opsgenie:
|
13873
|
-
$ref: '#/components/schemas/
|
14804
|
+
$ref: '#/components/schemas/ServiceDefinitionV2Opsgenie'
|
13874
14805
|
pagerduty:
|
13875
|
-
$ref: '#/components/schemas/
|
14806
|
+
$ref: '#/components/schemas/ServiceDefinitionV2Pagerduty'
|
13876
14807
|
type: object
|
13877
|
-
|
14808
|
+
ServiceDefinitionV2Link:
|
13878
14809
|
description: Service's external links.
|
13879
14810
|
properties:
|
13880
14811
|
name:
|
13881
14812
|
description: Link name.
|
13882
14813
|
example: Runbook
|
13883
14814
|
type: string
|
13884
|
-
provider:
|
13885
|
-
description: Link provider.
|
13886
|
-
example: Github
|
13887
|
-
type: string
|
13888
14815
|
type:
|
13889
|
-
$ref: '#/components/schemas/
|
14816
|
+
$ref: '#/components/schemas/ServiceDefinitionV2LinkType'
|
13890
14817
|
url:
|
13891
14818
|
description: Link URL.
|
13892
14819
|
example: https://my-runbook
|
@@ -13896,23 +14823,31 @@ components:
|
|
13896
14823
|
- type
|
13897
14824
|
- url
|
13898
14825
|
type: object
|
13899
|
-
|
14826
|
+
ServiceDefinitionV2LinkType:
|
13900
14827
|
description: Link type.
|
13901
14828
|
enum:
|
13902
14829
|
- doc
|
13903
|
-
-
|
14830
|
+
- wiki
|
13904
14831
|
- runbook
|
14832
|
+
- url
|
14833
|
+
- repo
|
13905
14834
|
- dashboard
|
13906
|
-
-
|
14835
|
+
- oncall
|
14836
|
+
- code
|
14837
|
+
- link
|
13907
14838
|
example: runbook
|
13908
14839
|
type: string
|
13909
14840
|
x-enum-varnames:
|
13910
14841
|
- DOC
|
13911
|
-
-
|
14842
|
+
- WIKI
|
13912
14843
|
- RUNBOOK
|
14844
|
+
- URL
|
14845
|
+
- REPO
|
13913
14846
|
- DASHBOARD
|
13914
|
-
-
|
13915
|
-
|
14847
|
+
- ONCALL
|
14848
|
+
- CODE
|
14849
|
+
- LINK
|
14850
|
+
ServiceDefinitionV2MSTeams:
|
13916
14851
|
description: Service owner's Microsoft Teams.
|
13917
14852
|
properties:
|
13918
14853
|
contact:
|
@@ -13924,12 +14859,12 @@ components:
|
|
13924
14859
|
example: My team channel
|
13925
14860
|
type: string
|
13926
14861
|
type:
|
13927
|
-
$ref: '#/components/schemas/
|
14862
|
+
$ref: '#/components/schemas/ServiceDefinitionV2MSTeamsType'
|
13928
14863
|
required:
|
13929
14864
|
- type
|
13930
14865
|
- contact
|
13931
14866
|
type: object
|
13932
|
-
|
14867
|
+
ServiceDefinitionV2MSTeamsType:
|
13933
14868
|
description: Contact type.
|
13934
14869
|
enum:
|
13935
14870
|
- microsoft-teams
|
@@ -13937,11 +14872,11 @@ components:
|
|
13937
14872
|
type: string
|
13938
14873
|
x-enum-varnames:
|
13939
14874
|
- MICROSOFT_TEAMS
|
13940
|
-
|
14875
|
+
ServiceDefinitionV2Opsgenie:
|
13941
14876
|
description: Opsgenie integration for the service.
|
13942
14877
|
properties:
|
13943
14878
|
region:
|
13944
|
-
$ref: '#/components/schemas/
|
14879
|
+
$ref: '#/components/schemas/ServiceDefinitionV2OpsgenieRegion'
|
13945
14880
|
service-url:
|
13946
14881
|
description: Opsgenie service url.
|
13947
14882
|
example: https://my-org.opsgenie.com/service/123e4567-e89b-12d3-a456-426614174000
|
@@ -13949,288 +14884,654 @@ components:
|
|
13949
14884
|
required:
|
13950
14885
|
- service-url
|
13951
14886
|
type: object
|
13952
|
-
|
13953
|
-
description: Opsgenie instance region.
|
14887
|
+
ServiceDefinitionV2OpsgenieRegion:
|
14888
|
+
description: Opsgenie instance region.
|
14889
|
+
enum:
|
14890
|
+
- US
|
14891
|
+
- EU
|
14892
|
+
example: US
|
14893
|
+
type: string
|
14894
|
+
x-enum-varnames:
|
14895
|
+
- US
|
14896
|
+
- EU
|
14897
|
+
ServiceDefinitionV2Pagerduty:
|
14898
|
+
description: PagerDuty service URL for the service.
|
14899
|
+
example: https://my-org.pagerduty.com/service-directory/PMyService
|
14900
|
+
type: string
|
14901
|
+
ServiceDefinitionV2Repo:
|
14902
|
+
description: Service code repositories.
|
14903
|
+
properties:
|
14904
|
+
name:
|
14905
|
+
description: Repository name.
|
14906
|
+
example: Source Code
|
14907
|
+
type: string
|
14908
|
+
provider:
|
14909
|
+
description: Repository provider.
|
14910
|
+
example: GitHub
|
14911
|
+
type: string
|
14912
|
+
url:
|
14913
|
+
description: Repository URL.
|
14914
|
+
example: https://github.com/DataDog/schema
|
14915
|
+
type: string
|
14916
|
+
required:
|
14917
|
+
- name
|
14918
|
+
- url
|
14919
|
+
type: object
|
14920
|
+
ServiceDefinitionV2Slack:
|
14921
|
+
description: Service owner's Slack channel.
|
14922
|
+
properties:
|
14923
|
+
contact:
|
14924
|
+
description: Slack Channel.
|
14925
|
+
example: https://yourcompany.slack.com/archives/channel123
|
14926
|
+
type: string
|
14927
|
+
name:
|
14928
|
+
description: Contact Slack.
|
14929
|
+
example: Team Slack
|
14930
|
+
type: string
|
14931
|
+
type:
|
14932
|
+
$ref: '#/components/schemas/ServiceDefinitionV2SlackType'
|
14933
|
+
required:
|
14934
|
+
- type
|
14935
|
+
- contact
|
14936
|
+
type: object
|
14937
|
+
ServiceDefinitionV2SlackType:
|
14938
|
+
description: Contact type.
|
14939
|
+
enum:
|
14940
|
+
- slack
|
14941
|
+
example: slack
|
14942
|
+
type: string
|
14943
|
+
x-enum-varnames:
|
14944
|
+
- SLACK
|
14945
|
+
ServiceDefinitionV2Version:
|
14946
|
+
default: v2
|
14947
|
+
description: Schema version being used.
|
14948
|
+
enum:
|
14949
|
+
- v2
|
14950
|
+
example: v2
|
14951
|
+
type: string
|
14952
|
+
x-enum-varnames:
|
14953
|
+
- V2
|
14954
|
+
ServiceDefinitionsCreateRequest:
|
14955
|
+
description: Create service definitions request.
|
14956
|
+
oneOf:
|
14957
|
+
- $ref: '#/components/schemas/ServiceDefinitionV2Dot1'
|
14958
|
+
- $ref: '#/components/schemas/ServiceDefinitionV2'
|
14959
|
+
- $ref: '#/components/schemas/ServiceDefinitionRaw'
|
14960
|
+
ServiceDefinitionsListResponse:
|
14961
|
+
description: Create service definitions response.
|
14962
|
+
properties:
|
14963
|
+
data:
|
14964
|
+
description: Data representing service definitions.
|
14965
|
+
items:
|
14966
|
+
$ref: '#/components/schemas/ServiceDefinitionData'
|
14967
|
+
type: array
|
14968
|
+
type: object
|
14969
|
+
SlackIntegrationMetadata:
|
14970
|
+
description: Incident integration metadata for the Slack integration.
|
14971
|
+
properties:
|
14972
|
+
channels:
|
14973
|
+
description: Array of Slack channels in this integration metadata.
|
14974
|
+
example: []
|
14975
|
+
items:
|
14976
|
+
$ref: '#/components/schemas/SlackIntegrationMetadataChannelItem'
|
14977
|
+
type: array
|
14978
|
+
required:
|
14979
|
+
- channels
|
14980
|
+
type: object
|
14981
|
+
SlackIntegrationMetadataChannelItem:
|
14982
|
+
description: Item in the Slack integration metadata channel array.
|
14983
|
+
properties:
|
14984
|
+
channel_id:
|
14985
|
+
description: Slack channel ID.
|
14986
|
+
example: C0123456789
|
14987
|
+
type: string
|
14988
|
+
channel_name:
|
14989
|
+
description: Name of the Slack channel.
|
14990
|
+
example: '#example-channel-name'
|
14991
|
+
type: string
|
14992
|
+
redirect_url:
|
14993
|
+
description: URL redirecting to the Slack channel.
|
14994
|
+
example: https://slack.com/app_redirect?channel=C0123456789&team=T01234567
|
14995
|
+
type: string
|
14996
|
+
team_id:
|
14997
|
+
description: Slack team ID.
|
14998
|
+
example: T01234567
|
14999
|
+
type: string
|
15000
|
+
required:
|
15001
|
+
- channel_id
|
15002
|
+
- channel_name
|
15003
|
+
- redirect_url
|
15004
|
+
type: object
|
15005
|
+
Span:
|
15006
|
+
description: Object description of a spans after being processed and stored
|
15007
|
+
by Datadog.
|
15008
|
+
properties:
|
15009
|
+
attributes:
|
15010
|
+
$ref: '#/components/schemas/SpansAttributes'
|
15011
|
+
id:
|
15012
|
+
description: Unique ID of the Span.
|
15013
|
+
example: AAAAAWgN8Xwgr1vKDQAAAABBV2dOOFh3ZzZobm1mWXJFYTR0OA
|
15014
|
+
type: string
|
15015
|
+
type:
|
15016
|
+
$ref: '#/components/schemas/SpansType'
|
15017
|
+
type: object
|
15018
|
+
SpansAggregateBucket:
|
15019
|
+
description: Spans aggregate.
|
15020
|
+
properties:
|
15021
|
+
attributes:
|
15022
|
+
$ref: '#/components/schemas/SpansAggregateBucketAttributes'
|
15023
|
+
id:
|
15024
|
+
description: ID of the spans aggregate.
|
15025
|
+
type: string
|
15026
|
+
type:
|
15027
|
+
$ref: '#/components/schemas/SpansAggregateBucketType'
|
15028
|
+
type: object
|
15029
|
+
SpansAggregateBucketAttributes:
|
15030
|
+
description: A bucket values.
|
15031
|
+
properties:
|
15032
|
+
by:
|
15033
|
+
additionalProperties:
|
15034
|
+
description: The values for each group by.
|
15035
|
+
description: The key, value pairs for each group by.
|
15036
|
+
example:
|
15037
|
+
'@state': success
|
15038
|
+
'@version': abc
|
15039
|
+
type: object
|
15040
|
+
compute:
|
15041
|
+
description: The compute data.
|
15042
|
+
type: object
|
15043
|
+
computes:
|
15044
|
+
additionalProperties:
|
15045
|
+
$ref: '#/components/schemas/SpansAggregateBucketValue'
|
15046
|
+
description: A map of the metric name -> value for regular compute or list
|
15047
|
+
of values for a timeseries.
|
15048
|
+
type: object
|
15049
|
+
type: object
|
15050
|
+
SpansAggregateBucketType:
|
15051
|
+
description: The spans aggregate bucket type.
|
15052
|
+
enum:
|
15053
|
+
- bucket
|
15054
|
+
example: bucket
|
15055
|
+
type: string
|
15056
|
+
x-enum-varnames:
|
15057
|
+
- BUCKET
|
15058
|
+
SpansAggregateBucketValue:
|
15059
|
+
description: A bucket value, can be either a timeseries or a single value.
|
15060
|
+
oneOf:
|
15061
|
+
- $ref: '#/components/schemas/SpansAggregateBucketValueSingleString'
|
15062
|
+
- $ref: '#/components/schemas/SpansAggregateBucketValueSingleNumber'
|
15063
|
+
- $ref: '#/components/schemas/SpansAggregateBucketValueTimeseries'
|
15064
|
+
SpansAggregateBucketValueSingleNumber:
|
15065
|
+
description: A single number value.
|
15066
|
+
format: double
|
15067
|
+
type: number
|
15068
|
+
SpansAggregateBucketValueSingleString:
|
15069
|
+
description: A single string value.
|
15070
|
+
type: string
|
15071
|
+
SpansAggregateBucketValueTimeseries:
|
15072
|
+
description: A timeseries array.
|
15073
|
+
items:
|
15074
|
+
$ref: '#/components/schemas/SpansAggregateBucketValueTimeseriesPoint'
|
15075
|
+
type: array
|
15076
|
+
x-generate-alias-as-model: true
|
15077
|
+
SpansAggregateBucketValueTimeseriesPoint:
|
15078
|
+
description: A timeseries point.
|
15079
|
+
properties:
|
15080
|
+
time:
|
15081
|
+
description: The time value for this point.
|
15082
|
+
example: '2023-06-08T11:55:00Z'
|
15083
|
+
type: string
|
15084
|
+
value:
|
15085
|
+
description: The value for this point.
|
15086
|
+
example: 19
|
15087
|
+
format: double
|
15088
|
+
type: number
|
15089
|
+
type: object
|
15090
|
+
SpansAggregateData:
|
15091
|
+
description: The object containing the query content.
|
15092
|
+
properties:
|
15093
|
+
attributes:
|
15094
|
+
$ref: '#/components/schemas/SpansAggregateRequestAttributes'
|
15095
|
+
type:
|
15096
|
+
$ref: '#/components/schemas/SpansAggregateRequestType'
|
15097
|
+
type: object
|
15098
|
+
SpansAggregateRequest:
|
15099
|
+
description: The object sent with the request to retrieve a list of aggregated
|
15100
|
+
spans from your organization.
|
15101
|
+
properties:
|
15102
|
+
data:
|
15103
|
+
$ref: '#/components/schemas/SpansAggregateData'
|
15104
|
+
type: object
|
15105
|
+
SpansAggregateRequestAttributes:
|
15106
|
+
description: The object containing all the query parameters.
|
15107
|
+
properties:
|
15108
|
+
compute:
|
15109
|
+
description: The list of metrics or timeseries to compute for the retrieved
|
15110
|
+
buckets.
|
15111
|
+
items:
|
15112
|
+
$ref: '#/components/schemas/SpansCompute'
|
15113
|
+
type: array
|
15114
|
+
filter:
|
15115
|
+
$ref: '#/components/schemas/SpansQueryFilter'
|
15116
|
+
group_by:
|
15117
|
+
description: The rules for the group by.
|
15118
|
+
items:
|
15119
|
+
$ref: '#/components/schemas/SpansGroupBy'
|
15120
|
+
type: array
|
15121
|
+
options:
|
15122
|
+
$ref: '#/components/schemas/SpansQueryOptions'
|
15123
|
+
type: object
|
15124
|
+
SpansAggregateRequestType:
|
15125
|
+
default: aggregate_request
|
15126
|
+
description: The type of resource. The value should always be aggregate_request.
|
13954
15127
|
enum:
|
13955
|
-
-
|
13956
|
-
|
13957
|
-
example: US
|
15128
|
+
- aggregate_request
|
15129
|
+
example: aggregate_request
|
13958
15130
|
type: string
|
13959
15131
|
x-enum-varnames:
|
13960
|
-
-
|
13961
|
-
|
13962
|
-
|
13963
|
-
description: PagerDuty integration for the service.
|
15132
|
+
- AGGREGATE_REQUEST
|
15133
|
+
SpansAggregateResponse:
|
15134
|
+
description: The response object for the spans aggregate API endpoint.
|
13964
15135
|
properties:
|
13965
|
-
|
13966
|
-
description:
|
13967
|
-
|
13968
|
-
|
15136
|
+
data:
|
15137
|
+
description: The list of matching buckets, one item per bucket.
|
15138
|
+
items:
|
15139
|
+
$ref: '#/components/schemas/SpansAggregateBucket'
|
15140
|
+
type: array
|
15141
|
+
meta:
|
15142
|
+
$ref: '#/components/schemas/SpansAggregateResponseMetadata'
|
13969
15143
|
type: object
|
13970
|
-
|
13971
|
-
description:
|
15144
|
+
SpansAggregateResponseMetadata:
|
15145
|
+
description: The metadata associated with a request.
|
13972
15146
|
properties:
|
13973
|
-
|
13974
|
-
description:
|
13975
|
-
example:
|
13976
|
-
|
13977
|
-
|
13978
|
-
|
13979
|
-
|
15147
|
+
elapsed:
|
15148
|
+
description: The time elapsed in milliseconds.
|
15149
|
+
example: 132
|
15150
|
+
format: int64
|
15151
|
+
type: integer
|
15152
|
+
request_id:
|
15153
|
+
description: The identifier of the request.
|
15154
|
+
example: MWlFUjVaWGZTTTZPYzM0VXp1OXU2d3xLSVpEMjZKQ0VKUTI0dEYtM3RSOFVR
|
13980
15155
|
type: string
|
13981
|
-
|
13982
|
-
$ref: '#/components/schemas/
|
13983
|
-
|
13984
|
-
|
13985
|
-
|
15156
|
+
status:
|
15157
|
+
$ref: '#/components/schemas/SpansAggregateResponseStatus'
|
15158
|
+
warnings:
|
15159
|
+
description: 'A list of warnings (non fatal errors) encountered, partial
|
15160
|
+
results might be returned if
|
15161
|
+
|
15162
|
+
warnings are present in the response.'
|
15163
|
+
items:
|
15164
|
+
$ref: '#/components/schemas/SpansWarning'
|
15165
|
+
type: array
|
13986
15166
|
type: object
|
13987
|
-
|
13988
|
-
description:
|
13989
|
-
enum:
|
13990
|
-
- slack
|
13991
|
-
example: slack
|
13992
|
-
type: string
|
13993
|
-
x-enum-varnames:
|
13994
|
-
- SLACK
|
13995
|
-
ServiceDefinitionV2Dot1Version:
|
13996
|
-
default: v2.1
|
13997
|
-
description: Schema version being used.
|
15167
|
+
SpansAggregateResponseStatus:
|
15168
|
+
description: The status of the response.
|
13998
15169
|
enum:
|
13999
|
-
-
|
14000
|
-
|
15170
|
+
- done
|
15171
|
+
- timeout
|
15172
|
+
example: done
|
14001
15173
|
type: string
|
14002
15174
|
x-enum-varnames:
|
14003
|
-
-
|
14004
|
-
|
14005
|
-
|
15175
|
+
- DONE
|
15176
|
+
- TIMEOUT
|
15177
|
+
SpansAggregateSort:
|
15178
|
+
description: A sort rule.
|
15179
|
+
example:
|
15180
|
+
aggregation: count
|
15181
|
+
order: asc
|
14006
15182
|
properties:
|
14007
|
-
|
14008
|
-
|
14009
|
-
|
14010
|
-
|
14011
|
-
|
14012
|
-
name:
|
14013
|
-
description: Contact email.
|
14014
|
-
example: Team Email
|
15183
|
+
aggregation:
|
15184
|
+
$ref: '#/components/schemas/SpansAggregationFunction'
|
15185
|
+
metric:
|
15186
|
+
description: The metric to sort by (only used for `type=measure`).
|
15187
|
+
example: '@duration'
|
14015
15188
|
type: string
|
15189
|
+
order:
|
15190
|
+
$ref: '#/components/schemas/SpansSortOrder'
|
14016
15191
|
type:
|
14017
|
-
$ref: '#/components/schemas/
|
14018
|
-
required:
|
14019
|
-
- type
|
14020
|
-
- contact
|
15192
|
+
$ref: '#/components/schemas/SpansAggregateSortType'
|
14021
15193
|
type: object
|
14022
|
-
|
14023
|
-
|
15194
|
+
SpansAggregateSortType:
|
15195
|
+
default: alphabetical
|
15196
|
+
description: The type of sorting algorithm.
|
14024
15197
|
enum:
|
14025
|
-
-
|
14026
|
-
|
15198
|
+
- alphabetical
|
15199
|
+
- measure
|
14027
15200
|
type: string
|
14028
15201
|
x-enum-varnames:
|
14029
|
-
-
|
14030
|
-
|
14031
|
-
|
14032
|
-
|
14033
|
-
opsgenie:
|
14034
|
-
$ref: '#/components/schemas/ServiceDefinitionV2Opsgenie'
|
14035
|
-
pagerduty:
|
14036
|
-
$ref: '#/components/schemas/ServiceDefinitionV2Pagerduty'
|
14037
|
-
type: object
|
14038
|
-
ServiceDefinitionV2Link:
|
14039
|
-
description: Service's external links.
|
14040
|
-
properties:
|
14041
|
-
name:
|
14042
|
-
description: Link name.
|
14043
|
-
example: Runbook
|
14044
|
-
type: string
|
14045
|
-
type:
|
14046
|
-
$ref: '#/components/schemas/ServiceDefinitionV2LinkType'
|
14047
|
-
url:
|
14048
|
-
description: Link URL.
|
14049
|
-
example: https://my-runbook
|
14050
|
-
type: string
|
14051
|
-
required:
|
14052
|
-
- name
|
14053
|
-
- type
|
14054
|
-
- url
|
14055
|
-
type: object
|
14056
|
-
ServiceDefinitionV2LinkType:
|
14057
|
-
description: Link type.
|
15202
|
+
- ALPHABETICAL
|
15203
|
+
- MEASURE
|
15204
|
+
SpansAggregationFunction:
|
15205
|
+
description: An aggregation function.
|
14058
15206
|
enum:
|
14059
|
-
-
|
14060
|
-
-
|
14061
|
-
-
|
14062
|
-
-
|
14063
|
-
-
|
14064
|
-
-
|
14065
|
-
-
|
14066
|
-
-
|
14067
|
-
-
|
14068
|
-
|
15207
|
+
- count
|
15208
|
+
- cardinality
|
15209
|
+
- pc75
|
15210
|
+
- pc90
|
15211
|
+
- pc95
|
15212
|
+
- pc98
|
15213
|
+
- pc99
|
15214
|
+
- sum
|
15215
|
+
- min
|
15216
|
+
- max
|
15217
|
+
- avg
|
15218
|
+
- median
|
15219
|
+
example: pc90
|
14069
15220
|
type: string
|
14070
15221
|
x-enum-varnames:
|
14071
|
-
-
|
14072
|
-
-
|
14073
|
-
-
|
14074
|
-
-
|
14075
|
-
-
|
14076
|
-
-
|
14077
|
-
-
|
14078
|
-
-
|
14079
|
-
-
|
14080
|
-
|
14081
|
-
|
15222
|
+
- COUNT
|
15223
|
+
- CARDINALITY
|
15224
|
+
- PERCENTILE_75
|
15225
|
+
- PERCENTILE_90
|
15226
|
+
- PERCENTILE_95
|
15227
|
+
- PERCENTILE_98
|
15228
|
+
- PERCENTILE_99
|
15229
|
+
- SUM
|
15230
|
+
- MIN
|
15231
|
+
- MAX
|
15232
|
+
- AVG
|
15233
|
+
- MEDIAN
|
15234
|
+
SpansAttributes:
|
15235
|
+
description: JSON object containing all span attributes and their associated
|
15236
|
+
values.
|
14082
15237
|
properties:
|
14083
|
-
|
14084
|
-
|
14085
|
-
|
15238
|
+
attributes:
|
15239
|
+
additionalProperties: {}
|
15240
|
+
description: JSON object of attributes from your span.
|
15241
|
+
example:
|
15242
|
+
customAttribute: 123
|
15243
|
+
duration: 2345
|
15244
|
+
type: object
|
15245
|
+
custom:
|
15246
|
+
additionalProperties: {}
|
15247
|
+
description: JSON object of custom spans data.
|
15248
|
+
type: object
|
15249
|
+
end_timestamp:
|
15250
|
+
description: End timestamp of your span.
|
15251
|
+
example: '2023-01-02T09:42:36.420Z'
|
15252
|
+
format: date-time
|
14086
15253
|
type: string
|
14087
|
-
|
14088
|
-
description:
|
14089
|
-
example:
|
15254
|
+
env:
|
15255
|
+
description: Name of the environment from where the spans are being sent.
|
15256
|
+
example: prod
|
15257
|
+
type: string
|
15258
|
+
host:
|
15259
|
+
description: Name of the machine from where the spans are being sent.
|
15260
|
+
example: i-0123
|
15261
|
+
type: string
|
15262
|
+
ingestion_reason:
|
15263
|
+
description: The reason why the span was ingested.
|
15264
|
+
example: rule
|
15265
|
+
type: string
|
15266
|
+
parent_id:
|
15267
|
+
description: Id of the span that's parent of this span.
|
15268
|
+
example: '0'
|
15269
|
+
type: string
|
15270
|
+
resource_hash:
|
15271
|
+
description: Unique identifier of the resource.
|
15272
|
+
example: a12345678b91c23d
|
15273
|
+
type: string
|
15274
|
+
resource_name:
|
15275
|
+
description: The name of the resource.
|
15276
|
+
example: agent
|
15277
|
+
type: string
|
15278
|
+
retained_by:
|
15279
|
+
description: The reason why the span was indexed.
|
15280
|
+
example: retention_filter
|
15281
|
+
type: string
|
15282
|
+
service:
|
15283
|
+
description: 'The name of the application or service generating the span
|
15284
|
+
events.
|
15285
|
+
|
15286
|
+
It is used to switch from APM to Logs, so make sure you define the same
|
15287
|
+
|
15288
|
+
value when you use both products.'
|
15289
|
+
example: agent
|
15290
|
+
type: string
|
15291
|
+
single_span:
|
15292
|
+
description: Whether or not the span was collected as a stand-alone span.
|
15293
|
+
Always associated to "single_span" ingestion_reason if true.
|
15294
|
+
example: true
|
15295
|
+
type: boolean
|
15296
|
+
span_id:
|
15297
|
+
description: Id of the span.
|
15298
|
+
example: '1234567890987654321'
|
15299
|
+
type: string
|
15300
|
+
start_timestamp:
|
15301
|
+
description: Start timestamp of your span.
|
15302
|
+
example: '2023-01-02T09:42:36.320Z'
|
15303
|
+
format: date-time
|
15304
|
+
type: string
|
15305
|
+
tags:
|
15306
|
+
description: Array of tags associated with your span.
|
15307
|
+
example:
|
15308
|
+
- team:A
|
15309
|
+
items:
|
15310
|
+
description: Tag associated with your span.
|
15311
|
+
type: string
|
15312
|
+
type: array
|
15313
|
+
trace_id:
|
15314
|
+
description: Id of the trace to which the span belongs.
|
15315
|
+
example: '1234567890987654321'
|
14090
15316
|
type: string
|
14091
15317
|
type:
|
14092
|
-
|
14093
|
-
|
14094
|
-
|
14095
|
-
- contact
|
15318
|
+
description: The type of the span.
|
15319
|
+
example: web
|
15320
|
+
type: string
|
14096
15321
|
type: object
|
14097
|
-
|
14098
|
-
description:
|
14099
|
-
enum:
|
14100
|
-
- microsoft-teams
|
14101
|
-
example: microsoft-teams
|
14102
|
-
type: string
|
14103
|
-
x-enum-varnames:
|
14104
|
-
- MICROSOFT_TEAMS
|
14105
|
-
ServiceDefinitionV2Opsgenie:
|
14106
|
-
description: Opsgenie integration for the service.
|
15322
|
+
SpansCompute:
|
15323
|
+
description: A compute rule to compute metrics or timeseries.
|
14107
15324
|
properties:
|
14108
|
-
|
14109
|
-
$ref: '#/components/schemas/
|
14110
|
-
|
14111
|
-
description:
|
14112
|
-
|
15325
|
+
aggregation:
|
15326
|
+
$ref: '#/components/schemas/SpansAggregationFunction'
|
15327
|
+
interval:
|
15328
|
+
description: 'The time buckets'' size (only used for type=timeseries)
|
15329
|
+
|
15330
|
+
Defaults to a resolution of 150 points.'
|
15331
|
+
example: 5m
|
15332
|
+
type: string
|
15333
|
+
metric:
|
15334
|
+
description: The metric to use.
|
15335
|
+
example: '@duration'
|
14113
15336
|
type: string
|
15337
|
+
type:
|
15338
|
+
$ref: '#/components/schemas/SpansComputeType'
|
14114
15339
|
required:
|
14115
|
-
-
|
15340
|
+
- aggregation
|
14116
15341
|
type: object
|
14117
|
-
|
14118
|
-
|
15342
|
+
SpansComputeType:
|
15343
|
+
default: total
|
15344
|
+
description: The type of compute.
|
14119
15345
|
enum:
|
14120
|
-
-
|
14121
|
-
-
|
14122
|
-
example: US
|
15346
|
+
- timeseries
|
15347
|
+
- total
|
14123
15348
|
type: string
|
14124
15349
|
x-enum-varnames:
|
14125
|
-
-
|
14126
|
-
-
|
14127
|
-
|
14128
|
-
description:
|
14129
|
-
example: https://my-org.pagerduty.com/service-directory/PMyService
|
14130
|
-
type: string
|
14131
|
-
ServiceDefinitionV2Repo:
|
14132
|
-
description: Service code repositories.
|
15350
|
+
- TIMESERIES
|
15351
|
+
- TOTAL
|
15352
|
+
SpansGroupBy:
|
15353
|
+
description: A group by rule.
|
14133
15354
|
properties:
|
14134
|
-
|
14135
|
-
description:
|
14136
|
-
example:
|
14137
|
-
type: string
|
14138
|
-
provider:
|
14139
|
-
description: Repository provider.
|
14140
|
-
example: GitHub
|
14141
|
-
type: string
|
14142
|
-
url:
|
14143
|
-
description: Repository URL.
|
14144
|
-
example: https://github.com/DataDog/schema
|
15355
|
+
facet:
|
15356
|
+
description: The name of the facet to use (required).
|
15357
|
+
example: host
|
14145
15358
|
type: string
|
15359
|
+
histogram:
|
15360
|
+
$ref: '#/components/schemas/SpansGroupByHistogram'
|
15361
|
+
limit:
|
15362
|
+
default: 10
|
15363
|
+
description: The maximum buckets to return for this group by.
|
15364
|
+
format: int64
|
15365
|
+
type: integer
|
15366
|
+
missing:
|
15367
|
+
$ref: '#/components/schemas/SpansGroupByMissing'
|
15368
|
+
sort:
|
15369
|
+
$ref: '#/components/schemas/SpansAggregateSort'
|
15370
|
+
total:
|
15371
|
+
$ref: '#/components/schemas/SpansGroupByTotal'
|
14146
15372
|
required:
|
14147
|
-
-
|
14148
|
-
- url
|
15373
|
+
- facet
|
14149
15374
|
type: object
|
14150
|
-
|
14151
|
-
description:
|
15375
|
+
SpansGroupByHistogram:
|
15376
|
+
description: 'Used to perform a histogram computation (only for measure facets).
|
15377
|
+
|
15378
|
+
Note: At most 100 buckets are allowed, the number of buckets is (max - min)/interval.'
|
14152
15379
|
properties:
|
14153
|
-
|
14154
|
-
description:
|
14155
|
-
example:
|
14156
|
-
|
14157
|
-
|
14158
|
-
|
14159
|
-
|
14160
|
-
|
14161
|
-
|
14162
|
-
|
15380
|
+
interval:
|
15381
|
+
description: The bin size of the histogram buckets.
|
15382
|
+
example: 10
|
15383
|
+
format: double
|
15384
|
+
type: number
|
15385
|
+
max:
|
15386
|
+
description: 'The maximum value for the measure used in the histogram
|
15387
|
+
|
15388
|
+
(values greater than this one are filtered out).'
|
15389
|
+
example: 100
|
15390
|
+
format: double
|
15391
|
+
type: number
|
15392
|
+
min:
|
15393
|
+
description: 'The minimum value for the measure used in the histogram
|
15394
|
+
|
15395
|
+
(values smaller than this one are filtered out).'
|
15396
|
+
example: 50
|
15397
|
+
format: double
|
15398
|
+
type: number
|
14163
15399
|
required:
|
14164
|
-
-
|
14165
|
-
-
|
15400
|
+
- interval
|
15401
|
+
- min
|
15402
|
+
- max
|
14166
15403
|
type: object
|
14167
|
-
|
14168
|
-
description:
|
14169
|
-
|
14170
|
-
|
14171
|
-
|
15404
|
+
SpansGroupByMissing:
|
15405
|
+
description: The value to use for spans that don't have the facet used to group
|
15406
|
+
by.
|
15407
|
+
oneOf:
|
15408
|
+
- $ref: '#/components/schemas/SpansGroupByMissingString'
|
15409
|
+
- $ref: '#/components/schemas/SpansGroupByMissingNumber'
|
15410
|
+
SpansGroupByMissingNumber:
|
15411
|
+
description: The missing value to use if there is a number valued facet.
|
15412
|
+
format: double
|
15413
|
+
type: number
|
15414
|
+
SpansGroupByMissingString:
|
15415
|
+
description: The missing value to use if there is string valued facet.
|
14172
15416
|
type: string
|
14173
|
-
|
14174
|
-
|
14175
|
-
|
14176
|
-
|
14177
|
-
|
15417
|
+
SpansGroupByTotal:
|
15418
|
+
default: false
|
15419
|
+
description: A resulting object to put the given computes in over all the matching
|
15420
|
+
records.
|
15421
|
+
oneOf:
|
15422
|
+
- $ref: '#/components/schemas/SpansGroupByTotalBoolean'
|
15423
|
+
- $ref: '#/components/schemas/SpansGroupByTotalString'
|
15424
|
+
- $ref: '#/components/schemas/SpansGroupByTotalNumber'
|
15425
|
+
SpansGroupByTotalBoolean:
|
15426
|
+
description: If set to true, creates an additional bucket labeled "$facet_total".
|
15427
|
+
type: boolean
|
15428
|
+
SpansGroupByTotalNumber:
|
15429
|
+
description: A number to use as the key value for the total bucket.
|
15430
|
+
format: double
|
15431
|
+
type: number
|
15432
|
+
SpansGroupByTotalString:
|
15433
|
+
description: A string to use as the key value for the total bucket.
|
15434
|
+
type: string
|
15435
|
+
SpansListRequest:
|
15436
|
+
description: The request for a spans list.
|
15437
|
+
properties:
|
15438
|
+
data:
|
15439
|
+
$ref: '#/components/schemas/SpansListRequestData'
|
15440
|
+
type: object
|
15441
|
+
SpansListRequestAttributes:
|
15442
|
+
description: The object containing all the query parameters.
|
15443
|
+
properties:
|
15444
|
+
filter:
|
15445
|
+
$ref: '#/components/schemas/SpansQueryFilter'
|
15446
|
+
options:
|
15447
|
+
$ref: '#/components/schemas/SpansQueryOptions'
|
15448
|
+
page:
|
15449
|
+
$ref: '#/components/schemas/SpansListRequestPage'
|
15450
|
+
sort:
|
15451
|
+
$ref: '#/components/schemas/SpansSort'
|
15452
|
+
type: object
|
15453
|
+
SpansListRequestData:
|
15454
|
+
description: The object containing the query content.
|
15455
|
+
properties:
|
15456
|
+
attributes:
|
15457
|
+
$ref: '#/components/schemas/SpansListRequestAttributes'
|
15458
|
+
type:
|
15459
|
+
$ref: '#/components/schemas/SpansListRequestType'
|
15460
|
+
type: object
|
15461
|
+
SpansListRequestPage:
|
15462
|
+
description: Paging attributes for listing spans.
|
15463
|
+
properties:
|
15464
|
+
cursor:
|
15465
|
+
description: List following results with a cursor provided in the previous
|
15466
|
+
query.
|
15467
|
+
example: eyJzdGFydEF0IjoiQVFBQUFYS2tMS3pPbm40NGV3QUFBQUJCV0V0clRFdDZVbG8zY3pCRmNsbHJiVmxDWlEifQ==
|
15468
|
+
type: string
|
15469
|
+
limit:
|
15470
|
+
default: 10
|
15471
|
+
description: Maximum number of spans in the response.
|
15472
|
+
example: 25
|
15473
|
+
format: int32
|
15474
|
+
maximum: 1000
|
15475
|
+
type: integer
|
15476
|
+
type: object
|
15477
|
+
SpansListRequestType:
|
15478
|
+
default: search_request
|
15479
|
+
description: The type of resource. The value should always be search_request.
|
14178
15480
|
enum:
|
14179
|
-
-
|
14180
|
-
example:
|
15481
|
+
- search_request
|
15482
|
+
example: search_request
|
14181
15483
|
type: string
|
14182
15484
|
x-enum-varnames:
|
14183
|
-
-
|
14184
|
-
|
14185
|
-
description:
|
14186
|
-
|
14187
|
-
- $ref: '#/components/schemas/ServiceDefinitionV2Dot1'
|
14188
|
-
- $ref: '#/components/schemas/ServiceDefinitionV2'
|
14189
|
-
- $ref: '#/components/schemas/ServiceDefinitionRaw'
|
14190
|
-
ServiceDefinitionsListResponse:
|
14191
|
-
description: Create service definitions response.
|
15485
|
+
- SEARCH_REQUEST
|
15486
|
+
SpansListResponse:
|
15487
|
+
description: Response object with all spans matching the request and pagination
|
15488
|
+
information.
|
14192
15489
|
properties:
|
14193
15490
|
data:
|
14194
|
-
description:
|
15491
|
+
description: Array of spans matching the request.
|
14195
15492
|
items:
|
14196
|
-
$ref: '#/components/schemas/
|
15493
|
+
$ref: '#/components/schemas/Span'
|
14197
15494
|
type: array
|
15495
|
+
links:
|
15496
|
+
$ref: '#/components/schemas/SpansListResponseLinks'
|
15497
|
+
meta:
|
15498
|
+
$ref: '#/components/schemas/SpansListResponseMetadata'
|
14198
15499
|
type: object
|
14199
|
-
|
14200
|
-
description:
|
15500
|
+
SpansListResponseLinks:
|
15501
|
+
description: Links attributes.
|
14201
15502
|
properties:
|
14202
|
-
|
14203
|
-
description:
|
14204
|
-
|
14205
|
-
|
14206
|
-
|
14207
|
-
|
14208
|
-
|
14209
|
-
- channels
|
15503
|
+
next:
|
15504
|
+
description: 'Link for the next set of results. Note that the request can
|
15505
|
+
also be made using the
|
15506
|
+
|
15507
|
+
POST endpoint.'
|
15508
|
+
example: https://app.datadoghq.com/api/v2/spans/event?filter[query]=foo&page[cursor]=eyJzdGFydEF0IjoiQVFBQUFYS2tMS3pPbm40NGV3QUFBQUJCV0V0clRFdDZVbG8zY3pCRmNsbHJiVmxDWlEifQ==
|
15509
|
+
type: string
|
14210
15510
|
type: object
|
14211
|
-
|
14212
|
-
description:
|
15511
|
+
SpansListResponseMetadata:
|
15512
|
+
description: The metadata associated with a request.
|
14213
15513
|
properties:
|
14214
|
-
|
14215
|
-
description:
|
14216
|
-
example:
|
14217
|
-
|
14218
|
-
|
14219
|
-
|
14220
|
-
|
14221
|
-
|
14222
|
-
|
14223
|
-
|
14224
|
-
example: https://slack.com/app_redirect?channel=C0123456789&team=T01234567
|
14225
|
-
type: string
|
14226
|
-
team_id:
|
14227
|
-
description: Slack team ID.
|
14228
|
-
example: T01234567
|
15514
|
+
elapsed:
|
15515
|
+
description: The time elapsed in milliseconds.
|
15516
|
+
example: 132
|
15517
|
+
format: int64
|
15518
|
+
type: integer
|
15519
|
+
page:
|
15520
|
+
$ref: '#/components/schemas/SpansResponseMetadataPage'
|
15521
|
+
request_id:
|
15522
|
+
description: The identifier of the request.
|
15523
|
+
example: MWlFUjVaWGZTTTZPYzM0VXp1OXU2d3xLSVpEMjZKQ0VKUTI0dEYtM3RSOFVR
|
14229
15524
|
type: string
|
14230
|
-
|
14231
|
-
|
14232
|
-
|
14233
|
-
|
15525
|
+
status:
|
15526
|
+
$ref: '#/components/schemas/SpansAggregateResponseStatus'
|
15527
|
+
warnings:
|
15528
|
+
description: 'A list of warnings (non fatal errors) encountered, partial
|
15529
|
+
results might be returned if
|
15530
|
+
|
15531
|
+
warnings are present in the response.'
|
15532
|
+
items:
|
15533
|
+
$ref: '#/components/schemas/SpansWarning'
|
15534
|
+
type: array
|
14234
15535
|
type: object
|
14235
15536
|
SpansMetricCompute:
|
14236
15537
|
description: The compute rule to compute the span-based metric.
|
@@ -14443,14 +15744,109 @@ components:
|
|
14443
15744
|
required:
|
14444
15745
|
- data
|
14445
15746
|
type: object
|
14446
|
-
SpansMetricsResponse:
|
14447
|
-
description: All the available span-based metric objects.
|
15747
|
+
SpansMetricsResponse:
|
15748
|
+
description: All the available span-based metric objects.
|
15749
|
+
properties:
|
15750
|
+
data:
|
15751
|
+
description: A list of span-based metric objects.
|
15752
|
+
items:
|
15753
|
+
$ref: '#/components/schemas/SpansMetricResponseData'
|
15754
|
+
type: array
|
15755
|
+
type: object
|
15756
|
+
SpansQueryFilter:
|
15757
|
+
description: The search and filter query settings.
|
15758
|
+
properties:
|
15759
|
+
from:
|
15760
|
+
default: now-15m
|
15761
|
+
description: The minimum time for the requested spans, supports date-time
|
15762
|
+
ISO8601, date math, and regular timestamps (milliseconds).
|
15763
|
+
example: now-15m
|
15764
|
+
type: string
|
15765
|
+
query:
|
15766
|
+
default: '*'
|
15767
|
+
description: The search query - following the span search syntax.
|
15768
|
+
example: service:web* AND @http.status_code:[200 TO 299]
|
15769
|
+
type: string
|
15770
|
+
to:
|
15771
|
+
default: now
|
15772
|
+
description: The maximum time for the requested spans, supports date-time
|
15773
|
+
ISO8601, date math, and regular timestamps (milliseconds).
|
15774
|
+
example: now
|
15775
|
+
type: string
|
15776
|
+
type: object
|
15777
|
+
SpansQueryOptions:
|
15778
|
+
description: 'Global query options that are used during the query.
|
15779
|
+
|
15780
|
+
Note: You should only supply timezone or time offset but not both otherwise
|
15781
|
+
the query will fail.'
|
15782
|
+
properties:
|
15783
|
+
timeOffset:
|
15784
|
+
description: The time offset (in seconds) to apply to the query.
|
15785
|
+
format: int64
|
15786
|
+
type: integer
|
15787
|
+
timezone:
|
15788
|
+
default: UTC
|
15789
|
+
description: The timezone can be specified as GMT, UTC, an offset from UTC
|
15790
|
+
(like UTC+1), or as a Timezone Database identifier (like America/New_York).
|
15791
|
+
example: GMT
|
15792
|
+
type: string
|
15793
|
+
type: object
|
15794
|
+
SpansResponseMetadataPage:
|
15795
|
+
description: Paging attributes.
|
14448
15796
|
properties:
|
14449
|
-
|
14450
|
-
description:
|
14451
|
-
|
14452
|
-
|
14453
|
-
|
15797
|
+
after:
|
15798
|
+
description: 'The cursor to use to get the next results, if any. To make
|
15799
|
+
the next request, use the same
|
15800
|
+
|
15801
|
+
parameters with the addition of the `page[cursor]`.'
|
15802
|
+
example: eyJzdGFydEF0IjoiQVFBQUFYS2tMS3pPbm40NGV3QUFBQUJCV0V0clRFdDZVbG8zY3pCRmNsbHJiVmxDWlEifQ==
|
15803
|
+
type: string
|
15804
|
+
type: object
|
15805
|
+
SpansSort:
|
15806
|
+
description: Sort parameters when querying spans.
|
15807
|
+
enum:
|
15808
|
+
- timestamp
|
15809
|
+
- -timestamp
|
15810
|
+
type: string
|
15811
|
+
x-enum-varnames:
|
15812
|
+
- TIMESTAMP_ASCENDING
|
15813
|
+
- TIMESTAMP_DESCENDING
|
15814
|
+
SpansSortOrder:
|
15815
|
+
description: The order to use, ascending or descending.
|
15816
|
+
enum:
|
15817
|
+
- asc
|
15818
|
+
- desc
|
15819
|
+
example: asc
|
15820
|
+
type: string
|
15821
|
+
x-enum-varnames:
|
15822
|
+
- ASCENDING
|
15823
|
+
- DESCENDING
|
15824
|
+
SpansType:
|
15825
|
+
default: spans
|
15826
|
+
description: Type of the span.
|
15827
|
+
enum:
|
15828
|
+
- spans
|
15829
|
+
example: spans
|
15830
|
+
type: string
|
15831
|
+
x-enum-varnames:
|
15832
|
+
- SPANS
|
15833
|
+
SpansWarning:
|
15834
|
+
description: A warning message indicating something that went wrong with the
|
15835
|
+
query.
|
15836
|
+
properties:
|
15837
|
+
code:
|
15838
|
+
description: A unique code for this type of warning.
|
15839
|
+
example: unknown_index
|
15840
|
+
type: string
|
15841
|
+
detail:
|
15842
|
+
description: A detailed explanation of this specific warning.
|
15843
|
+
example: 'indexes: foo, bar'
|
15844
|
+
type: string
|
15845
|
+
title:
|
15846
|
+
description: A short human-readable summary of the warning.
|
15847
|
+
example: One or several indexes are missing or invalid, results hold data
|
15848
|
+
from the other indexes
|
15849
|
+
type: string
|
14454
15850
|
type: object
|
14455
15851
|
TagsEventAttribute:
|
14456
15852
|
description: Array of tags associated with your event.
|
@@ -15311,6 +16707,8 @@ components:
|
|
15311
16707
|
id:
|
15312
16708
|
description: ID of the user invitation.
|
15313
16709
|
type: string
|
16710
|
+
relationships:
|
16711
|
+
$ref: '#/components/schemas/UserInvitationRelationships'
|
15314
16712
|
type:
|
15315
16713
|
$ref: '#/components/schemas/UserInvitationsType'
|
15316
16714
|
type: object
|
@@ -16444,6 +17842,10 @@ paths:
|
|
16444
17842
|
we support, see the [guide](https://docs.datadoghq.com/continuous_integration/guides/pipeline_data_model/).
|
16445
17843
|
|
16446
17844
|
|
17845
|
+
Pipeline events can be submitted with a timestamp that is up to 18 hours in
|
17846
|
+
the past.
|
17847
|
+
|
17848
|
+
|
16447
17849
|
This API endpoint is in private beta.'
|
16448
17850
|
operationId: CreateCIAppPipelineEvent
|
16449
17851
|
requestBody:
|
@@ -16989,15 +18391,241 @@ paths:
|
|
16989
18391
|
content:
|
16990
18392
|
application/json:
|
16991
18393
|
schema:
|
16992
|
-
$ref: '#/components/schemas/DashboardListDeleteItemsRequest'
|
16993
|
-
description: Dashboards to delete from the dashboard list.
|
18394
|
+
$ref: '#/components/schemas/DashboardListDeleteItemsRequest'
|
18395
|
+
description: Dashboards to delete from the dashboard list.
|
18396
|
+
required: true
|
18397
|
+
responses:
|
18398
|
+
'200':
|
18399
|
+
content:
|
18400
|
+
application/json:
|
18401
|
+
schema:
|
18402
|
+
$ref: '#/components/schemas/DashboardListDeleteItemsResponse'
|
18403
|
+
description: OK
|
18404
|
+
'400':
|
18405
|
+
content:
|
18406
|
+
application/json:
|
18407
|
+
schema:
|
18408
|
+
$ref: '#/components/schemas/APIErrorResponse'
|
18409
|
+
description: Bad Request
|
18410
|
+
'403':
|
18411
|
+
content:
|
18412
|
+
application/json:
|
18413
|
+
schema:
|
18414
|
+
$ref: '#/components/schemas/APIErrorResponse'
|
18415
|
+
description: Forbidden
|
18416
|
+
'404':
|
18417
|
+
content:
|
18418
|
+
application/json:
|
18419
|
+
schema:
|
18420
|
+
$ref: '#/components/schemas/APIErrorResponse'
|
18421
|
+
description: Not Found
|
18422
|
+
'429':
|
18423
|
+
$ref: '#/components/responses/TooManyRequestsResponse'
|
18424
|
+
summary: Delete items from a dashboard list
|
18425
|
+
tags:
|
18426
|
+
- Dashboard Lists
|
18427
|
+
x-codegen-request-body-name: body
|
18428
|
+
get:
|
18429
|
+
description: "Fetch the dashboard list\u2019s dashboard definitions."
|
18430
|
+
operationId: GetDashboardListItems
|
18431
|
+
parameters:
|
18432
|
+
- description: ID of the dashboard list to get items from.
|
18433
|
+
in: path
|
18434
|
+
name: dashboard_list_id
|
18435
|
+
required: true
|
18436
|
+
schema:
|
18437
|
+
format: int64
|
18438
|
+
type: integer
|
18439
|
+
responses:
|
18440
|
+
'200':
|
18441
|
+
content:
|
18442
|
+
application/json:
|
18443
|
+
schema:
|
18444
|
+
$ref: '#/components/schemas/DashboardListItems'
|
18445
|
+
description: OK
|
18446
|
+
'403':
|
18447
|
+
content:
|
18448
|
+
application/json:
|
18449
|
+
schema:
|
18450
|
+
$ref: '#/components/schemas/APIErrorResponse'
|
18451
|
+
description: Forbidden
|
18452
|
+
'404':
|
18453
|
+
content:
|
18454
|
+
application/json:
|
18455
|
+
schema:
|
18456
|
+
$ref: '#/components/schemas/APIErrorResponse'
|
18457
|
+
description: Not Found
|
18458
|
+
'429':
|
18459
|
+
$ref: '#/components/responses/TooManyRequestsResponse'
|
18460
|
+
security:
|
18461
|
+
- apiKeyAuth: []
|
18462
|
+
appKeyAuth: []
|
18463
|
+
- AuthZ:
|
18464
|
+
- dashboards_read
|
18465
|
+
summary: Get items of a Dashboard List
|
18466
|
+
tags:
|
18467
|
+
- Dashboard Lists
|
18468
|
+
post:
|
18469
|
+
description: Add dashboards to an existing dashboard list.
|
18470
|
+
operationId: CreateDashboardListItems
|
18471
|
+
parameters:
|
18472
|
+
- description: ID of the dashboard list to add items to.
|
18473
|
+
in: path
|
18474
|
+
name: dashboard_list_id
|
18475
|
+
required: true
|
18476
|
+
schema:
|
18477
|
+
format: int64
|
18478
|
+
type: integer
|
18479
|
+
requestBody:
|
18480
|
+
content:
|
18481
|
+
application/json:
|
18482
|
+
schema:
|
18483
|
+
$ref: '#/components/schemas/DashboardListAddItemsRequest'
|
18484
|
+
description: Dashboards to add to the dashboard list.
|
18485
|
+
required: true
|
18486
|
+
responses:
|
18487
|
+
'200':
|
18488
|
+
content:
|
18489
|
+
application/json:
|
18490
|
+
schema:
|
18491
|
+
$ref: '#/components/schemas/DashboardListAddItemsResponse'
|
18492
|
+
description: OK
|
18493
|
+
'400':
|
18494
|
+
content:
|
18495
|
+
application/json:
|
18496
|
+
schema:
|
18497
|
+
$ref: '#/components/schemas/APIErrorResponse'
|
18498
|
+
description: Bad Request
|
18499
|
+
'403':
|
18500
|
+
content:
|
18501
|
+
application/json:
|
18502
|
+
schema:
|
18503
|
+
$ref: '#/components/schemas/APIErrorResponse'
|
18504
|
+
description: Forbidden
|
18505
|
+
'404':
|
18506
|
+
content:
|
18507
|
+
application/json:
|
18508
|
+
schema:
|
18509
|
+
$ref: '#/components/schemas/APIErrorResponse'
|
18510
|
+
description: Not Found
|
18511
|
+
'429':
|
18512
|
+
$ref: '#/components/responses/TooManyRequestsResponse'
|
18513
|
+
summary: Add Items to a Dashboard List
|
18514
|
+
tags:
|
18515
|
+
- Dashboard Lists
|
18516
|
+
x-codegen-request-body-name: body
|
18517
|
+
put:
|
18518
|
+
description: Update dashboards of an existing dashboard list.
|
18519
|
+
operationId: UpdateDashboardListItems
|
18520
|
+
parameters:
|
18521
|
+
- description: ID of the dashboard list to update items from.
|
18522
|
+
in: path
|
18523
|
+
name: dashboard_list_id
|
18524
|
+
required: true
|
18525
|
+
schema:
|
18526
|
+
format: int64
|
18527
|
+
type: integer
|
18528
|
+
requestBody:
|
18529
|
+
content:
|
18530
|
+
application/json:
|
18531
|
+
schema:
|
18532
|
+
$ref: '#/components/schemas/DashboardListUpdateItemsRequest'
|
18533
|
+
description: New dashboards of the dashboard list.
|
18534
|
+
required: true
|
18535
|
+
responses:
|
18536
|
+
'200':
|
18537
|
+
content:
|
18538
|
+
application/json:
|
18539
|
+
schema:
|
18540
|
+
$ref: '#/components/schemas/DashboardListUpdateItemsResponse'
|
18541
|
+
description: OK
|
18542
|
+
'400':
|
18543
|
+
content:
|
18544
|
+
application/json:
|
18545
|
+
schema:
|
18546
|
+
$ref: '#/components/schemas/APIErrorResponse'
|
18547
|
+
description: Bad Request
|
18548
|
+
'403':
|
18549
|
+
content:
|
18550
|
+
application/json:
|
18551
|
+
schema:
|
18552
|
+
$ref: '#/components/schemas/APIErrorResponse'
|
18553
|
+
description: Forbidden
|
18554
|
+
'404':
|
18555
|
+
content:
|
18556
|
+
application/json:
|
18557
|
+
schema:
|
18558
|
+
$ref: '#/components/schemas/APIErrorResponse'
|
18559
|
+
description: Not Found
|
18560
|
+
'429':
|
18561
|
+
$ref: '#/components/responses/TooManyRequestsResponse'
|
18562
|
+
summary: Update items of a dashboard list
|
18563
|
+
tags:
|
18564
|
+
- Dashboard Lists
|
18565
|
+
x-codegen-request-body-name: body
|
18566
|
+
/api/v2/downtime:
|
18567
|
+
get:
|
18568
|
+
description: Get all scheduled downtimes.
|
18569
|
+
operationId: ListDowntimes
|
18570
|
+
parameters:
|
18571
|
+
- description: Only return downtimes that are active when the request is made.
|
18572
|
+
in: query
|
18573
|
+
name: current_only
|
18574
|
+
required: false
|
18575
|
+
schema:
|
18576
|
+
type: boolean
|
18577
|
+
- description: 'Comma-separated list of resource paths for related resources
|
18578
|
+
to include in the response. Supported resource
|
18579
|
+
|
18580
|
+
paths are `created_by` and `monitor`.'
|
18581
|
+
in: query
|
18582
|
+
name: include
|
18583
|
+
required: false
|
18584
|
+
schema:
|
18585
|
+
example: created_by,monitor
|
18586
|
+
type: string
|
18587
|
+
responses:
|
18588
|
+
'200':
|
18589
|
+
content:
|
18590
|
+
application/json:
|
18591
|
+
schema:
|
18592
|
+
$ref: '#/components/schemas/ListDowntimesResponse'
|
18593
|
+
description: OK
|
18594
|
+
'403':
|
18595
|
+
content:
|
18596
|
+
application/json:
|
18597
|
+
schema:
|
18598
|
+
$ref: '#/components/schemas/APIErrorResponse'
|
18599
|
+
description: Forbidden
|
18600
|
+
'429':
|
18601
|
+
$ref: '#/components/responses/TooManyRequestsResponse'
|
18602
|
+
security:
|
18603
|
+
- apiKeyAuth: []
|
18604
|
+
appKeyAuth: []
|
18605
|
+
- AuthZ:
|
18606
|
+
- monitors_read
|
18607
|
+
summary: Get all downtimes
|
18608
|
+
tags:
|
18609
|
+
- Downtimes
|
18610
|
+
x-unstable: '**Note**: This endpoint is in private beta.
|
18611
|
+
|
18612
|
+
If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).'
|
18613
|
+
post:
|
18614
|
+
description: Schedule a downtime.
|
18615
|
+
operationId: CreateDowntime
|
18616
|
+
requestBody:
|
18617
|
+
content:
|
18618
|
+
application/json:
|
18619
|
+
schema:
|
18620
|
+
$ref: '#/components/schemas/DowntimeCreateRequest'
|
18621
|
+
description: Schedule a downtime request body.
|
16994
18622
|
required: true
|
16995
18623
|
responses:
|
16996
18624
|
'200':
|
16997
18625
|
content:
|
16998
18626
|
application/json:
|
16999
18627
|
schema:
|
17000
|
-
$ref: '#/components/schemas/
|
18628
|
+
$ref: '#/components/schemas/DowntimeResponse'
|
17001
18629
|
description: OK
|
17002
18630
|
'400':
|
17003
18631
|
content:
|
@@ -17011,35 +18639,34 @@ paths:
|
|
17011
18639
|
schema:
|
17012
18640
|
$ref: '#/components/schemas/APIErrorResponse'
|
17013
18641
|
description: Forbidden
|
17014
|
-
'404':
|
17015
|
-
content:
|
17016
|
-
application/json:
|
17017
|
-
schema:
|
17018
|
-
$ref: '#/components/schemas/APIErrorResponse'
|
17019
|
-
description: Not Found
|
17020
18642
|
'429':
|
17021
18643
|
$ref: '#/components/responses/TooManyRequestsResponse'
|
17022
|
-
|
18644
|
+
security:
|
18645
|
+
- apiKeyAuth: []
|
18646
|
+
appKeyAuth: []
|
18647
|
+
- AuthZ:
|
18648
|
+
- monitors_downtime
|
18649
|
+
summary: Schedule a downtime
|
17023
18650
|
tags:
|
17024
|
-
-
|
18651
|
+
- Downtimes
|
17025
18652
|
x-codegen-request-body-name: body
|
17026
|
-
|
17027
|
-
|
17028
|
-
|
18653
|
+
x-unstable: '**Note**: This endpoint is in private beta.
|
18654
|
+
|
18655
|
+
If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).'
|
18656
|
+
/api/v2/downtime/{downtime_id}:
|
18657
|
+
delete:
|
18658
|
+
description: Cancel a downtime.
|
18659
|
+
operationId: CancelDowntime
|
17029
18660
|
parameters:
|
17030
|
-
- description: ID of the
|
18661
|
+
- description: ID of the downtime to cancel.
|
17031
18662
|
in: path
|
17032
|
-
name:
|
18663
|
+
name: downtime_id
|
17033
18664
|
required: true
|
17034
18665
|
schema:
|
17035
|
-
|
17036
|
-
type:
|
18666
|
+
example: 00000000-0000-1234-0000-000000000000
|
18667
|
+
type: string
|
17037
18668
|
responses:
|
17038
|
-
'
|
17039
|
-
content:
|
17040
|
-
application/json:
|
17041
|
-
schema:
|
17042
|
-
$ref: '#/components/schemas/DashboardListItems'
|
18669
|
+
'204':
|
17043
18670
|
description: OK
|
17044
18671
|
'403':
|
17045
18672
|
content:
|
@@ -17052,41 +18679,47 @@ paths:
|
|
17052
18679
|
application/json:
|
17053
18680
|
schema:
|
17054
18681
|
$ref: '#/components/schemas/APIErrorResponse'
|
17055
|
-
description:
|
18682
|
+
description: Downtime not found
|
17056
18683
|
'429':
|
17057
18684
|
$ref: '#/components/responses/TooManyRequestsResponse'
|
17058
18685
|
security:
|
17059
18686
|
- apiKeyAuth: []
|
17060
18687
|
appKeyAuth: []
|
17061
18688
|
- AuthZ:
|
17062
|
-
-
|
17063
|
-
summary:
|
18689
|
+
- monitors_downtime
|
18690
|
+
summary: Cancel a downtime
|
17064
18691
|
tags:
|
17065
|
-
-
|
17066
|
-
|
17067
|
-
|
17068
|
-
|
18692
|
+
- Downtimes
|
18693
|
+
x-unstable: '**Note**: This endpoint is in private beta.
|
18694
|
+
|
18695
|
+
If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).'
|
18696
|
+
get:
|
18697
|
+
description: Get downtime detail by `downtime_id`.
|
18698
|
+
operationId: GetDowntime
|
17069
18699
|
parameters:
|
17070
|
-
- description: ID of the
|
18700
|
+
- description: ID of the downtime to fetch.
|
17071
18701
|
in: path
|
17072
|
-
name:
|
18702
|
+
name: downtime_id
|
17073
18703
|
required: true
|
17074
18704
|
schema:
|
17075
|
-
|
17076
|
-
type:
|
17077
|
-
|
17078
|
-
|
17079
|
-
|
17080
|
-
|
17081
|
-
|
17082
|
-
|
17083
|
-
required:
|
18705
|
+
example: 00000000-0000-1234-0000-000000000000
|
18706
|
+
type: string
|
18707
|
+
- description: 'Comma-separated list of resource paths for related resources
|
18708
|
+
to include in the response. Supported resource
|
18709
|
+
|
18710
|
+
paths are `created_by` and `monitor`.'
|
18711
|
+
in: query
|
18712
|
+
name: include
|
18713
|
+
required: false
|
18714
|
+
schema:
|
18715
|
+
example: created_by,monitor
|
18716
|
+
type: string
|
17084
18717
|
responses:
|
17085
18718
|
'200':
|
17086
18719
|
content:
|
17087
18720
|
application/json:
|
17088
18721
|
schema:
|
17089
|
-
$ref: '#/components/schemas/
|
18722
|
+
$ref: '#/components/schemas/DowntimeResponse'
|
17090
18723
|
description: OK
|
17091
18724
|
'400':
|
17092
18725
|
content:
|
@@ -17108,34 +18741,41 @@ paths:
|
|
17108
18741
|
description: Not Found
|
17109
18742
|
'429':
|
17110
18743
|
$ref: '#/components/responses/TooManyRequestsResponse'
|
17111
|
-
|
18744
|
+
security:
|
18745
|
+
- apiKeyAuth: []
|
18746
|
+
appKeyAuth: []
|
18747
|
+
- AuthZ:
|
18748
|
+
- monitors_read
|
18749
|
+
summary: Get a downtime
|
17112
18750
|
tags:
|
17113
|
-
-
|
17114
|
-
x-
|
17115
|
-
|
17116
|
-
|
17117
|
-
|
18751
|
+
- Downtimes
|
18752
|
+
x-unstable: '**Note**: This endpoint is in private beta.
|
18753
|
+
|
18754
|
+
If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).'
|
18755
|
+
patch:
|
18756
|
+
description: Update a downtime by `downtime_id`.
|
18757
|
+
operationId: UpdateDowntime
|
17118
18758
|
parameters:
|
17119
|
-
- description: ID of the
|
18759
|
+
- description: ID of the downtime to update.
|
17120
18760
|
in: path
|
17121
|
-
name:
|
18761
|
+
name: downtime_id
|
17122
18762
|
required: true
|
17123
18763
|
schema:
|
17124
|
-
|
17125
|
-
type:
|
18764
|
+
example: 00e000000-0000-1234-0000-000000000000
|
18765
|
+
type: string
|
17126
18766
|
requestBody:
|
17127
18767
|
content:
|
17128
18768
|
application/json:
|
17129
18769
|
schema:
|
17130
|
-
$ref: '#/components/schemas/
|
17131
|
-
description:
|
18770
|
+
$ref: '#/components/schemas/DowntimeUpdateRequest'
|
18771
|
+
description: Update a downtime request body.
|
17132
18772
|
required: true
|
17133
18773
|
responses:
|
17134
18774
|
'200':
|
17135
18775
|
content:
|
17136
18776
|
application/json:
|
17137
18777
|
schema:
|
17138
|
-
$ref: '#/components/schemas/
|
18778
|
+
$ref: '#/components/schemas/DowntimeResponse'
|
17139
18779
|
description: OK
|
17140
18780
|
'400':
|
17141
18781
|
content:
|
@@ -17154,13 +18794,21 @@ paths:
|
|
17154
18794
|
application/json:
|
17155
18795
|
schema:
|
17156
18796
|
$ref: '#/components/schemas/APIErrorResponse'
|
17157
|
-
description:
|
18797
|
+
description: Downtime not found
|
17158
18798
|
'429':
|
17159
18799
|
$ref: '#/components/responses/TooManyRequestsResponse'
|
17160
|
-
|
18800
|
+
security:
|
18801
|
+
- apiKeyAuth: []
|
18802
|
+
appKeyAuth: []
|
18803
|
+
- AuthZ:
|
18804
|
+
- monitors_downtime
|
18805
|
+
summary: Update a downtime
|
17161
18806
|
tags:
|
17162
|
-
-
|
18807
|
+
- Downtimes
|
17163
18808
|
x-codegen-request-body-name: body
|
18809
|
+
x-unstable: '**Note**: This endpoint is in private beta.
|
18810
|
+
|
18811
|
+
If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).'
|
17164
18812
|
/api/v2/events:
|
17165
18813
|
get:
|
17166
18814
|
description: 'List endpoint returns events that match an events search query.
|
@@ -19732,15 +21380,21 @@ paths:
|
|
19732
21380
|
required: false
|
19733
21381
|
schema:
|
19734
21382
|
type: string
|
19735
|
-
- description: 'For customers with multiple indexes, the indexes to search
|
21383
|
+
- description: 'For customers with multiple indexes, the indexes to search.
|
19736
21384
|
|
19737
21385
|
Defaults to ''*'' which means all indexes'
|
19738
|
-
example:
|
21386
|
+
example:
|
21387
|
+
- main
|
21388
|
+
- web
|
21389
|
+
explode: false
|
19739
21390
|
in: query
|
19740
|
-
name: filter[
|
21391
|
+
name: filter[indexes]
|
19741
21392
|
required: false
|
19742
21393
|
schema:
|
19743
|
-
|
21394
|
+
items:
|
21395
|
+
description: The name of a log index.
|
21396
|
+
type: string
|
21397
|
+
type: array
|
19744
21398
|
- description: Minimum timestamp for requested logs.
|
19745
21399
|
example: '2019-01-02T09:42:36.320Z'
|
19746
21400
|
in: query
|
@@ -20692,6 +22346,45 @@ paths:
|
|
20692
22346
|
tags:
|
20693
22347
|
- Monitors
|
20694
22348
|
x-codegen-request-body-name: body
|
22349
|
+
/api/v2/monitor/{monitor_id}/downtime_matches:
|
22350
|
+
get:
|
22351
|
+
description: Get all active downtimes for the specified monitor.
|
22352
|
+
operationId: ListMonitorDowntimes
|
22353
|
+
parameters:
|
22354
|
+
- description: The id of the monitor.
|
22355
|
+
in: path
|
22356
|
+
name: monitor_id
|
22357
|
+
required: true
|
22358
|
+
schema:
|
22359
|
+
format: int64
|
22360
|
+
type: integer
|
22361
|
+
responses:
|
22362
|
+
'200':
|
22363
|
+
content:
|
22364
|
+
application/json:
|
22365
|
+
schema:
|
22366
|
+
$ref: '#/components/schemas/MonitorDowntimeMatchResponse'
|
22367
|
+
description: OK
|
22368
|
+
'404':
|
22369
|
+
content:
|
22370
|
+
application/json:
|
22371
|
+
schema:
|
22372
|
+
$ref: '#/components/schemas/APIErrorResponse'
|
22373
|
+
description: Monitor Not Found error
|
22374
|
+
'429':
|
22375
|
+
$ref: '#/components/responses/TooManyRequestsResponse'
|
22376
|
+
security:
|
22377
|
+
- apiKeyAuth: []
|
22378
|
+
appKeyAuth: []
|
22379
|
+
- AuthZ:
|
22380
|
+
- monitors_read
|
22381
|
+
summary: Get active downtimes for a monitor
|
22382
|
+
tags:
|
22383
|
+
- Downtimes
|
22384
|
+
x-codegen-request-body-name: body
|
22385
|
+
x-unstable: '**Note**: This endpoint is in private beta.
|
22386
|
+
|
22387
|
+
If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).'
|
20695
22388
|
/api/v2/permissions:
|
20696
22389
|
get:
|
20697
22390
|
description: Returns a list of all permissions, including name, description,
|
@@ -21082,7 +22775,7 @@ paths:
|
|
21082
22775
|
resultsPath: data
|
21083
22776
|
/api/v2/query/scalar:
|
21084
22777
|
post:
|
21085
|
-
description: 'Query scalar values (as seen on Query Value, Table and Toplist
|
22778
|
+
description: 'Query scalar values (as seen on Query Value, Table, and Toplist
|
21086
22779
|
widgets).
|
21087
22780
|
|
21088
22781
|
Multiple data sources are supported with the ability to
|
@@ -21119,13 +22812,13 @@ paths:
|
|
21119
22812
|
tags:
|
21120
22813
|
- Metrics
|
21121
22814
|
x-codegen-request-body-name: body
|
21122
|
-
x-unstable: '**Note**: This endpoint is GA for
|
21123
|
-
(RUM) and
|
22815
|
+
x-unstable: '**Note**: This endpoint is GA for Metrics, Real User Monitoring
|
22816
|
+
(RUM), and Cloud Cost Management data sources.
|
21124
22817
|
|
21125
22818
|
Support for logs is in beta. We are gradually onboarding support for more
|
21126
22819
|
sources. If you have any
|
21127
22820
|
|
21128
|
-
feedback, contact [Datadog
|
22821
|
+
feedback, contact [Datadog Support](https://docs.datadoghq.com/help/).'
|
21129
22822
|
/api/v2/query/timeseries:
|
21130
22823
|
post:
|
21131
22824
|
description: 'Query timeseries data across various data sources and
|
@@ -21158,17 +22851,19 @@ paths:
|
|
21158
22851
|
appKeyAuth: []
|
21159
22852
|
- AuthZ:
|
21160
22853
|
- timeseries_query
|
22854
|
+
- metrics_read
|
22855
|
+
- metric_tags_write
|
21161
22856
|
summary: Query timeseries data across multiple products
|
21162
22857
|
tags:
|
21163
22858
|
- Metrics
|
21164
22859
|
x-codegen-request-body-name: body
|
21165
|
-
x-unstable: '**Note**: This endpoint is GA for
|
21166
|
-
(RUM) and
|
22860
|
+
x-unstable: '**Note**: This endpoint is GA for Metrics, Real User Monitoring
|
22861
|
+
(RUM), and Cloud Cost Management data sources.
|
21167
22862
|
|
21168
22863
|
Support for logs is in beta. We are gradually onboarding support for more
|
21169
22864
|
sources. If you have any
|
21170
22865
|
|
21171
|
-
feedback, contact [Datadog
|
22866
|
+
feedback, contact [Datadog Support](https://docs.datadoghq.com/help/).'
|
21172
22867
|
/api/v2/restriction_policy/{resource_id}:
|
21173
22868
|
delete:
|
21174
22869
|
description: Deletes the restriction policy associated with a specified resource.
|
@@ -23808,6 +25503,165 @@ paths:
|
|
23808
25503
|
x-unstable: '**Note**: This endpoint is in public beta.
|
23809
25504
|
|
23810
25505
|
If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).'
|
25506
|
+
/api/v2/spans/analytics/aggregate:
|
25507
|
+
post:
|
25508
|
+
description: 'The API endpoint to aggregate spans into buckets and compute metrics
|
25509
|
+
and timeseries.
|
25510
|
+
|
25511
|
+
This endpoint is rate limited to `300` requests per hour.'
|
25512
|
+
operationId: AggregateSpans
|
25513
|
+
requestBody:
|
25514
|
+
content:
|
25515
|
+
application/json:
|
25516
|
+
schema:
|
25517
|
+
$ref: '#/components/schemas/SpansAggregateRequest'
|
25518
|
+
required: true
|
25519
|
+
responses:
|
25520
|
+
'200':
|
25521
|
+
content:
|
25522
|
+
application/json:
|
25523
|
+
schema:
|
25524
|
+
$ref: '#/components/schemas/SpansAggregateResponse'
|
25525
|
+
description: OK
|
25526
|
+
'400':
|
25527
|
+
$ref: '#/components/responses/BadRequestResponse'
|
25528
|
+
'403':
|
25529
|
+
$ref: '#/components/responses/ForbiddenResponse'
|
25530
|
+
'429':
|
25531
|
+
$ref: '#/components/responses/TooManyRequestsResponse'
|
25532
|
+
summary: Aggregate spans
|
25533
|
+
tags:
|
25534
|
+
- Spans
|
25535
|
+
x-codegen-request-body-name: body
|
25536
|
+
/api/v2/spans/events:
|
25537
|
+
get:
|
25538
|
+
description: 'List endpoint returns spans that match a span search query.
|
25539
|
+
|
25540
|
+
[Results are paginated][1].
|
25541
|
+
|
25542
|
+
|
25543
|
+
Use this endpoint to see your latest spans.
|
25544
|
+
|
25545
|
+
This endpoint is rate limited to `300` requests per hour.
|
25546
|
+
|
25547
|
+
|
25548
|
+
[1]: /logs/guide/collect-multiple-logs-with-pagination?tab=v2api'
|
25549
|
+
operationId: ListSpansGet
|
25550
|
+
parameters:
|
25551
|
+
- description: Search query following spans syntax.
|
25552
|
+
example: '@datacenter:us @role:db'
|
25553
|
+
in: query
|
25554
|
+
name: filter[query]
|
25555
|
+
required: false
|
25556
|
+
schema:
|
25557
|
+
type: string
|
25558
|
+
- description: Minimum timestamp for requested spans. Supports date-time ISO8601,
|
25559
|
+
date math, and regular timestamps (milliseconds).
|
25560
|
+
example: '2023-01-02T09:42:36.320Z'
|
25561
|
+
in: query
|
25562
|
+
name: filter[from]
|
25563
|
+
required: false
|
25564
|
+
schema:
|
25565
|
+
type: string
|
25566
|
+
- description: Maximum timestamp for requested spans. Supports date-time ISO8601,
|
25567
|
+
date math, and regular timestamps (milliseconds).
|
25568
|
+
example: '2023-01-03T09:42:36.320Z'
|
25569
|
+
in: query
|
25570
|
+
name: filter[to]
|
25571
|
+
required: false
|
25572
|
+
schema:
|
25573
|
+
type: string
|
25574
|
+
- description: Order of spans in results.
|
25575
|
+
in: query
|
25576
|
+
name: sort
|
25577
|
+
required: false
|
25578
|
+
schema:
|
25579
|
+
$ref: '#/components/schemas/SpansSort'
|
25580
|
+
- description: List following results with a cursor provided in the previous
|
25581
|
+
query.
|
25582
|
+
example: eyJzdGFydEF0IjoiQVFBQUFYS2tMS3pPbm40NGV3QUFBQUJCV0V0clRFdDZVbG8zY3pCRmNsbHJiVmxDWlEifQ==
|
25583
|
+
in: query
|
25584
|
+
name: page[cursor]
|
25585
|
+
required: false
|
25586
|
+
schema:
|
25587
|
+
type: string
|
25588
|
+
- description: Maximum number of spans in the response.
|
25589
|
+
example: 25
|
25590
|
+
in: query
|
25591
|
+
name: page[limit]
|
25592
|
+
required: false
|
25593
|
+
schema:
|
25594
|
+
default: 10
|
25595
|
+
format: int32
|
25596
|
+
maximum: 1000
|
25597
|
+
type: integer
|
25598
|
+
responses:
|
25599
|
+
'200':
|
25600
|
+
content:
|
25601
|
+
application/json:
|
25602
|
+
schema:
|
25603
|
+
$ref: '#/components/schemas/SpansListResponse'
|
25604
|
+
description: OK
|
25605
|
+
'400':
|
25606
|
+
$ref: '#/components/responses/SpansBadRequestResponse'
|
25607
|
+
'403':
|
25608
|
+
$ref: '#/components/responses/SpansForbiddenResponse'
|
25609
|
+
'422':
|
25610
|
+
$ref: '#/components/responses/SpansUnprocessableEntityResponse'
|
25611
|
+
'429':
|
25612
|
+
$ref: '#/components/responses/SpansTooManyRequestsResponse'
|
25613
|
+
summary: Get a list of spans
|
25614
|
+
tags:
|
25615
|
+
- Spans
|
25616
|
+
x-pagination:
|
25617
|
+
cursorParam: page[cursor]
|
25618
|
+
cursorPath: meta.page.after
|
25619
|
+
limitParam: page[limit]
|
25620
|
+
resultsPath: data
|
25621
|
+
/api/v2/spans/events/search:
|
25622
|
+
post:
|
25623
|
+
description: 'List endpoint returns spans that match a span search query.
|
25624
|
+
|
25625
|
+
[Results are paginated][1].
|
25626
|
+
|
25627
|
+
|
25628
|
+
Use this endpoint to build complex spans filtering and search.
|
25629
|
+
|
25630
|
+
This endpoint is rate limited to `300` requests per hour.
|
25631
|
+
|
25632
|
+
|
25633
|
+
[1]: /logs/guide/collect-multiple-logs-with-pagination?tab=v2api'
|
25634
|
+
operationId: ListSpans
|
25635
|
+
requestBody:
|
25636
|
+
content:
|
25637
|
+
application/json:
|
25638
|
+
schema:
|
25639
|
+
$ref: '#/components/schemas/SpansListRequest'
|
25640
|
+
required: true
|
25641
|
+
responses:
|
25642
|
+
'200':
|
25643
|
+
content:
|
25644
|
+
application/json:
|
25645
|
+
schema:
|
25646
|
+
$ref: '#/components/schemas/SpansListResponse'
|
25647
|
+
description: OK
|
25648
|
+
'400':
|
25649
|
+
$ref: '#/components/responses/SpansBadRequestResponse'
|
25650
|
+
'403':
|
25651
|
+
$ref: '#/components/responses/SpansForbiddenResponse'
|
25652
|
+
'422':
|
25653
|
+
$ref: '#/components/responses/SpansUnprocessableEntityResponse'
|
25654
|
+
'429':
|
25655
|
+
$ref: '#/components/responses/SpansTooManyRequestsResponse'
|
25656
|
+
summary: Search spans
|
25657
|
+
tags:
|
25658
|
+
- Spans
|
25659
|
+
x-codegen-request-body-name: body
|
25660
|
+
x-pagination:
|
25661
|
+
cursorParam: body.data.attributes.page.cursor
|
25662
|
+
cursorPath: meta.page.after
|
25663
|
+
limitParam: body.data.attributes.page.limit
|
25664
|
+
resultsPath: data
|
23811
25665
|
/api/v2/synthetics/settings/on_demand_concurrency_cap:
|
23812
25666
|
get:
|
23813
25667
|
description: Get the on-demand concurrency cap.
|
@@ -25670,6 +27524,18 @@ tags:
|
|
25670
27524
|
|
25671
27525
|
organization.'
|
25672
27526
|
name: Dashboard Lists
|
27527
|
+
- description: '**Note**: Downtime V2 is currently in private beta. To request access,
|
27528
|
+
contact [Datadog support](https://docs.datadoghq.com/help/).
|
27529
|
+
|
27530
|
+
|
27531
|
+
[Downtiming](https://docs.datadoghq.com/monitors/notify/downtimes) gives
|
27532
|
+
|
27533
|
+
you greater control over monitor notifications by allowing you to globally exclude
|
27534
|
+
|
27535
|
+
scopes from alerting. Downtime settings, which can be scheduled with start and
|
27536
|
+
|
27537
|
+
end times, prevent all alerting related to specified Datadog tags.'
|
27538
|
+
name: Downtimes
|
25673
27539
|
- description: 'The events service allows you to programmatically post events to the
|
25674
27540
|
event stream
|
25675
27541
|
|
@@ -25780,10 +27646,11 @@ tags:
|
|
25780
27646
|
- description: 'A restriction policy defines the access control rules for a resource,
|
25781
27647
|
mapping a set of relations
|
25782
27648
|
|
25783
|
-
(such as editor and viewer) to a set of allowed principals (such as roles
|
25784
|
-
|
27649
|
+
(such as editor and viewer) to a set of allowed principals (such as roles, teams
|
27650
|
+
(beta), or users (beta)).
|
25785
27651
|
|
25786
|
-
determines who is authorized to perform what actions on
|
27652
|
+
The restriction policy determines who is authorized to perform what actions on
|
27653
|
+
the resource.'
|
25787
27654
|
name: Restriction Policies
|
25788
27655
|
- description: 'The Roles API is used to create and manage Datadog roles, what
|
25789
27656
|
|
@@ -25813,6 +27680,8 @@ tags:
|
|
25813
27680
|
externalDocs:
|
25814
27681
|
url: https://docs.datadoghq.com/tracing/service_catalog/
|
25815
27682
|
name: Service Definition
|
27683
|
+
- description: Search and aggregate your spans from your Datadog platform over HTTP.
|
27684
|
+
name: Spans
|
25816
27685
|
- description: Manage configuration of [span-based metrics](https://app.datadoghq.com/apm/traces/generate-metrics)
|
25817
27686
|
for your organization.
|
25818
27687
|
externalDocs:
|