datadog_api_client 2.47.0 → 2.48.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/.generator/schemas/v1/openapi.yaml +96 -5
- data/.generator/schemas/v2/openapi.yaml +2453 -707
- data/CHANGELOG.md +20 -0
- data/examples/v2/incidents/CreateIncidentAttachment.rb +22 -0
- data/examples/v2/incidents/DeleteIncidentAttachment.rb +8 -0
- data/examples/v2/incidents/ListIncidentAttachments.rb +1 -1
- data/examples/v2/incidents/UpdateIncidentAttachment.rb +20 -0
- data/examples/v2/on-call/CreateUserNotificationRule.rb +29 -0
- data/examples/v2/on-call/DeleteUserNotificationRule.rb +11 -0
- data/examples/v2/on-call/GetUserNotificationRule.rb +14 -0
- data/examples/v2/on-call/ListUserNotificationRules.rb +11 -0
- data/examples/v2/on-call/UpdateUserNotificationRule.rb +36 -0
- data/examples/v2/product-analytics/SubmitProductAnalyticsEvent.rb +24 -0
- data/examples/v2/security-monitoring/CreateSecurityMonitoringRule_2323193894.rb +48 -0
- data/examples/v2/synthetics/PatchGlobalVariable.rb +19 -0
- data/examples/v2/teams/CreateTeamNotificationRule.rb +23 -0
- data/examples/v2/teams/DeleteTeamConnections.rb +0 -3
- data/examples/v2/teams/DeleteTeamNotificationRule.rb +11 -0
- data/examples/v2/teams/GetTeamNotificationRule.rb +11 -0
- data/examples/v2/teams/GetTeamNotificationRules.rb +8 -0
- data/examples/v2/teams/GetTeamSync.rb +0 -3
- data/examples/v2/teams/ListTeamConnections.rb +0 -3
- data/examples/v2/teams/ListTeamConnections_2418873869.rb +0 -3
- data/examples/v2/teams/SyncTeams.rb +0 -3
- data/examples/v2/teams/SyncTeams_3215592344.rb +0 -3
- data/examples/v2/teams/UpdateTeamNotificationRule.rb +27 -0
- data/lib/datadog_api_client/configuration.rb +55 -6
- data/lib/datadog_api_client/inflector.rb +92 -20
- data/lib/datadog_api_client/v1/api/synthetics_api.rb +3 -3
- data/lib/datadog_api_client/v1/api/usage_metering_api.rb +6 -4
- data/lib/datadog_api_client/v1/models/hourly_usage_attribution_usage_type.rb +3 -0
- data/lib/datadog_api_client/v1/models/monthly_usage_attribution_supported_metrics.rb +6 -0
- data/lib/datadog_api_client/v1/models/monthly_usage_attribution_values.rb +61 -1
- data/lib/datadog_api_client/v1/models/synthetics_list_tests_response.rb +1 -1
- data/lib/datadog_api_client/v1/models/synthetics_test_details.rb +1 -1
- data/lib/datadog_api_client/v1/models/synthetics_test_details_without_steps.rb +221 -0
- data/lib/datadog_api_client/v2/api/dora_metrics_api.rb +8 -8
- data/lib/datadog_api_client/v2/api/incidents_api.rb +188 -36
- data/lib/datadog_api_client/v2/api/on_call_api.rb +360 -0
- data/lib/datadog_api_client/v2/api/product_analytics_api.rb +121 -0
- data/lib/datadog_api_client/v2/api/software_catalog_api.rb +4 -0
- data/lib/datadog_api_client/v2/api/synthetics_api.rb +79 -0
- data/lib/datadog_api_client/v2/api/teams_api.rb +339 -30
- data/lib/datadog_api_client/v2/models/attachment.rb +117 -0
- data/lib/datadog_api_client/v2/models/{incident_attachments_response.rb → attachment_array.rb} +7 -7
- data/lib/datadog_api_client/v2/models/{incident_attachment_data.rb → attachment_data.rb} +8 -8
- data/lib/datadog_api_client/v2/models/attachment_data_attributes.rb +125 -0
- data/lib/datadog_api_client/v2/models/attachment_data_attributes_attachment.rb +115 -0
- data/lib/datadog_api_client/v2/models/{incident_attachment_attachment_type.rb → attachment_data_attributes_attachment_type.rb} +3 -3
- data/lib/datadog_api_client/v2/models/{incident_attachment_relationships.rb → attachment_data_relationships.rb} +5 -5
- data/lib/datadog_api_client/v2/models/{incident_attachment_update_request.rb → attachment_data_relationships_last_modified_by_user.rb} +6 -11
- data/lib/datadog_api_client/v2/models/attachment_data_relationships_last_modified_by_user_data.rb +144 -0
- data/lib/datadog_api_client/v2/models/{incident_attachments_response_included_item.rb → attachment_included.rb} +3 -3
- data/lib/datadog_api_client/v2/models/case_create_attributes.rb +11 -1
- data/lib/datadog_api_client/v2/models/{dora_fetch_response.rb → create_attachment_request.rb} +5 -5
- data/lib/datadog_api_client/v2/models/{incident_attachment_update_data.rb → create_attachment_request_data.rb} +6 -6
- data/lib/datadog_api_client/v2/models/create_attachment_request_data_attributes.rb +115 -0
- data/lib/datadog_api_client/v2/models/create_attachment_request_data_attributes_attachment.rb +115 -0
- data/lib/datadog_api_client/v2/models/create_on_call_notification_rule_request.rb +123 -0
- data/lib/datadog_api_client/v2/models/create_on_call_notification_rule_request_data.rb +143 -0
- data/lib/datadog_api_client/v2/models/custom_attribute_type.rb +1 -0
- data/lib/datadog_api_client/v2/models/dora_deployment_fetch_response.rb +105 -0
- data/lib/datadog_api_client/v2/models/dora_deployment_object.rb +125 -0
- data/lib/datadog_api_client/v2/models/dora_deployment_object_attributes.rb +225 -0
- data/lib/datadog_api_client/v2/models/dora_deployment_request_attributes.rb +1 -1
- data/lib/datadog_api_client/v2/models/dora_deployments_list_response.rb +107 -0
- data/lib/datadog_api_client/v2/models/dora_failure_fetch_response.rb +105 -0
- data/lib/datadog_api_client/v2/models/dora_failure_request_attributes.rb +1 -1
- data/lib/datadog_api_client/v2/models/{dora_list_response.rb → dora_failures_list_response.rb} +5 -5
- data/lib/datadog_api_client/v2/models/{dora_event.rb → dora_incident_object.rb} +8 -8
- data/lib/datadog_api_client/v2/models/dora_incident_object_attributes.rb +225 -0
- data/lib/datadog_api_client/v2/models/global_variable_data.rb +125 -0
- data/lib/datadog_api_client/v2/models/global_variable_json_patch_request.rb +123 -0
- data/lib/datadog_api_client/v2/models/global_variable_json_patch_request_data.rb +115 -0
- data/lib/datadog_api_client/v2/models/global_variable_json_patch_request_data_attributes.rb +107 -0
- data/lib/datadog_api_client/v2/models/global_variable_json_patch_type.rb +26 -0
- data/lib/datadog_api_client/v2/models/global_variable_response.rb +105 -0
- data/lib/datadog_api_client/v2/models/{incident_attachment_link_attachment_type.rb → global_variable_type.rb} +3 -3
- data/lib/datadog_api_client/v2/models/incident_response_included_item.rb +1 -1
- data/lib/datadog_api_client/v2/models/{incident_attachments_postmortem_attributes_attachment_object.rb → json_patch_operation.rb} +40 -30
- data/lib/datadog_api_client/v2/models/json_patch_operation_op.rb +31 -0
- data/lib/datadog_api_client/v2/models/list_on_call_notification_rules_response.rb +119 -0
- data/lib/datadog_api_client/v2/models/observability_pipeline_add_env_vars_processor.rb +11 -1
- data/lib/datadog_api_client/v2/models/observability_pipeline_add_fields_processor.rb +11 -1
- data/lib/datadog_api_client/v2/models/observability_pipeline_config_processor_group.rb +11 -1
- data/lib/datadog_api_client/v2/models/observability_pipeline_custom_processor.rb +11 -1
- data/lib/datadog_api_client/v2/models/observability_pipeline_datadog_tags_processor.rb +11 -1
- data/lib/datadog_api_client/v2/models/observability_pipeline_dedupe_processor.rb +11 -1
- data/lib/datadog_api_client/v2/models/observability_pipeline_enrichment_table_processor.rb +11 -1
- data/lib/datadog_api_client/v2/models/observability_pipeline_filter_processor.rb +11 -1
- data/lib/datadog_api_client/v2/models/observability_pipeline_generate_metrics_processor.rb +11 -1
- data/lib/datadog_api_client/v2/models/observability_pipeline_ocsf_mapper_processor.rb +11 -1
- data/lib/datadog_api_client/v2/models/observability_pipeline_parse_grok_processor.rb +11 -1
- data/lib/datadog_api_client/v2/models/observability_pipeline_parse_json_processor.rb +11 -1
- data/lib/datadog_api_client/v2/models/observability_pipeline_quota_processor.rb +11 -1
- data/lib/datadog_api_client/v2/models/observability_pipeline_reduce_processor.rb +11 -1
- data/lib/datadog_api_client/v2/models/observability_pipeline_remove_fields_processor.rb +11 -1
- data/lib/datadog_api_client/v2/models/observability_pipeline_rename_fields_processor.rb +11 -1
- data/lib/datadog_api_client/v2/models/observability_pipeline_sample_processor.rb +11 -1
- data/lib/datadog_api_client/v2/models/observability_pipeline_sensitive_data_scanner_processor.rb +11 -1
- data/lib/datadog_api_client/v2/models/observability_pipeline_throttle_processor.rb +11 -1
- data/lib/datadog_api_client/v2/models/{incident_attachment_update_response.rb → on_call_notification_rule.rb} +8 -11
- data/lib/datadog_api_client/v2/models/on_call_notification_rule_attributes.rb +125 -0
- data/lib/datadog_api_client/v2/models/on_call_notification_rule_category.rb +27 -0
- data/lib/datadog_api_client/v2/models/on_call_notification_rule_channel_relationship.rb +123 -0
- data/lib/datadog_api_client/v2/models/on_call_notification_rule_channel_relationship_data.rb +115 -0
- data/lib/datadog_api_client/v2/models/{incident_attachment_update_attributes.rb → on_call_notification_rule_channel_settings.rb} +3 -4
- data/lib/datadog_api_client/v2/models/on_call_notification_rule_data.rb +153 -0
- data/lib/datadog_api_client/v2/models/on_call_notification_rule_relationships.rb +105 -0
- data/lib/datadog_api_client/v2/models/on_call_notification_rule_request_attributes.rb +125 -0
- data/lib/datadog_api_client/v2/models/on_call_notification_rule_type.rb +26 -0
- data/lib/datadog_api_client/v2/models/{incident_attachment_attributes.rb → on_call_notification_rules_included.rb} +3 -4
- data/lib/datadog_api_client/v2/models/on_call_phone_notification_rule_method.rb +27 -0
- data/lib/datadog_api_client/v2/models/{incident_attachment_link_attributes_attachment_object.rb → on_call_phone_notification_rule_settings.rb} +30 -30
- data/lib/datadog_api_client/v2/models/patch_attachment_request.rb +105 -0
- data/lib/datadog_api_client/v2/models/patch_attachment_request_data.rb +143 -0
- data/lib/datadog_api_client/v2/models/patch_attachment_request_data_attributes.rb +105 -0
- data/lib/datadog_api_client/v2/models/patch_attachment_request_data_attributes_attachment.rb +115 -0
- data/lib/datadog_api_client/v2/models/product_analytics_server_side_event_error.rb +125 -0
- data/lib/datadog_api_client/v2/models/product_analytics_server_side_event_errors.rb +107 -0
- data/lib/datadog_api_client/v2/models/product_analytics_server_side_event_item.rb +195 -0
- data/lib/datadog_api_client/v2/models/product_analytics_server_side_event_item_account.rb +123 -0
- data/lib/datadog_api_client/v2/models/product_analytics_server_side_event_item_application.rb +124 -0
- data/lib/datadog_api_client/v2/models/product_analytics_server_side_event_item_event.rb +123 -0
- data/lib/datadog_api_client/v2/models/product_analytics_server_side_event_item_session.rb +123 -0
- data/lib/datadog_api_client/v2/models/product_analytics_server_side_event_item_type.rb +26 -0
- data/lib/datadog_api_client/v2/models/product_analytics_server_side_event_item_usr.rb +123 -0
- data/lib/datadog_api_client/v2/models/security_monitoring_rule_anomaly_detection_options.rb +155 -0
- data/lib/datadog_api_client/v2/models/security_monitoring_rule_anomaly_detection_options_bucket_duration.rb +32 -0
- data/lib/datadog_api_client/v2/models/security_monitoring_rule_anomaly_detection_options_detection_tolerance.rb +31 -0
- data/lib/datadog_api_client/v2/models/security_monitoring_rule_anomaly_detection_options_learning_duration.rb +32 -0
- data/lib/datadog_api_client/v2/models/security_monitoring_rule_options.rb +11 -1
- data/lib/datadog_api_client/v2/models/synthetics_global_variable.rb +248 -0
- data/lib/datadog_api_client/v2/models/synthetics_global_variable_attributes.rb +107 -0
- data/lib/datadog_api_client/v2/models/synthetics_global_variable_options.rb +105 -0
- data/lib/datadog_api_client/v2/models/{incident_attachment_postmortem_attributes.rb → synthetics_global_variable_parse_test_options.rb} +44 -35
- data/lib/datadog_api_client/v2/models/synthetics_global_variable_parse_test_options_type.rb +29 -0
- data/lib/datadog_api_client/v2/models/synthetics_global_variable_parser_type.rb +29 -0
- data/lib/datadog_api_client/v2/models/{incident_attachment_link_attributes.rb → synthetics_global_variable_totp_parameters.rb} +38 -40
- data/lib/datadog_api_client/v2/models/synthetics_global_variable_value.rb +126 -0
- data/lib/datadog_api_client/v2/models/synthetics_variable_parser.rb +133 -0
- data/lib/datadog_api_client/v2/models/team_notification_rule.rb +154 -0
- data/lib/datadog_api_client/v2/models/team_notification_rule_attributes.rb +135 -0
- data/lib/datadog_api_client/v2/models/team_notification_rule_attributes_email.rb +105 -0
- data/lib/datadog_api_client/v2/models/team_notification_rule_attributes_ms_teams.rb +105 -0
- data/lib/datadog_api_client/v2/models/team_notification_rule_attributes_pagerduty.rb +105 -0
- data/lib/datadog_api_client/v2/models/team_notification_rule_attributes_slack.rb +115 -0
- data/lib/datadog_api_client/v2/models/team_notification_rule_request.rb +123 -0
- data/lib/datadog_api_client/v2/models/team_notification_rule_response.rb +105 -0
- data/lib/datadog_api_client/v2/models/{incident_attachment_postmortem_attachment_type.rb → team_notification_rule_type.rb} +3 -3
- data/lib/datadog_api_client/v2/models/team_notification_rules_response.rb +117 -0
- data/lib/datadog_api_client/v2/models/team_notification_rules_response_meta.rb +105 -0
- data/lib/datadog_api_client/v2/models/team_notification_rules_response_meta_page.rb +184 -0
- data/lib/datadog_api_client/v2/models/threat_hunting_job_options.rb +11 -1
- data/lib/datadog_api_client/v2/models/update_on_call_notification_rule_request.rb +123 -0
- data/lib/datadog_api_client/v2/models/update_on_call_notification_rule_request_attributes.rb +125 -0
- data/lib/datadog_api_client/v2/models/update_on_call_notification_rule_request_data.rb +153 -0
- data/lib/datadog_api_client/v2/models/user140420082644000.rb +143 -0
- data/lib/datadog_api_client/v2/models/{incident_attachment_related_object.rb → user_type.rb} +2 -2
- data/lib/datadog_api_client/version.rb +1 -1
- metadata +109 -24
- data/examples/v2/incidents/ListIncidentAttachments_2457735435.rb +0 -11
- data/examples/v2/incidents/UpdateIncidentAttachments.rb +0 -38
- data/examples/v2/incidents/UpdateIncidentAttachments_3881702075.rb +0 -26
|
@@ -178,6 +178,15 @@ components:
|
|
|
178
178
|
required: true
|
|
179
179
|
schema:
|
|
180
180
|
type: string
|
|
181
|
+
AttachmentIncludeQueryParameter:
|
|
182
|
+
description: 'Resource to include in the response. Supported value: `last_modified_by_user`.'
|
|
183
|
+
explode: false
|
|
184
|
+
in: query
|
|
185
|
+
name: include
|
|
186
|
+
required: false
|
|
187
|
+
schema:
|
|
188
|
+
example: last_modified_by_user
|
|
189
|
+
type: string
|
|
181
190
|
AuthNMappingID:
|
|
182
191
|
description: The UUID of the AuthN Mapping.
|
|
183
192
|
in: path
|
|
@@ -458,26 +467,6 @@ components:
|
|
|
458
467
|
items:
|
|
459
468
|
$ref: '#/components/schemas/GetIssueIncludeQueryParameterItem'
|
|
460
469
|
type: array
|
|
461
|
-
IncidentAttachmentFilterQueryParameter:
|
|
462
|
-
description: Specifies which types of attachments are included in the response.
|
|
463
|
-
explode: false
|
|
464
|
-
in: query
|
|
465
|
-
name: filter[attachment_type]
|
|
466
|
-
required: false
|
|
467
|
-
schema:
|
|
468
|
-
items:
|
|
469
|
-
$ref: '#/components/schemas/IncidentAttachmentAttachmentType'
|
|
470
|
-
type: array
|
|
471
|
-
IncidentAttachmentIncludeQueryParameter:
|
|
472
|
-
description: Specifies which types of related objects are included in the response.
|
|
473
|
-
explode: false
|
|
474
|
-
in: query
|
|
475
|
-
name: include
|
|
476
|
-
required: false
|
|
477
|
-
schema:
|
|
478
|
-
items:
|
|
479
|
-
$ref: '#/components/schemas/IncidentAttachmentRelatedObject'
|
|
480
|
-
type: array
|
|
481
470
|
IncidentIDPathParameter:
|
|
482
471
|
description: The UUID of the incident.
|
|
483
472
|
in: path
|
|
@@ -5358,6 +5347,124 @@ components:
|
|
|
5358
5347
|
- findings
|
|
5359
5348
|
- project
|
|
5360
5349
|
type: object
|
|
5350
|
+
Attachment:
|
|
5351
|
+
properties:
|
|
5352
|
+
data:
|
|
5353
|
+
$ref: '#/components/schemas/AttachmentData'
|
|
5354
|
+
included:
|
|
5355
|
+
items:
|
|
5356
|
+
$ref: '#/components/schemas/AttachmentIncluded'
|
|
5357
|
+
type: array
|
|
5358
|
+
type: object
|
|
5359
|
+
AttachmentArray:
|
|
5360
|
+
properties:
|
|
5361
|
+
data:
|
|
5362
|
+
example:
|
|
5363
|
+
- attributes:
|
|
5364
|
+
attachment:
|
|
5365
|
+
documentUrl: https://app.datadoghq.com/notebook/123/Postmortem-IR-123
|
|
5366
|
+
title: Postmortem IR-123
|
|
5367
|
+
attachment_type: postmortem
|
|
5368
|
+
modified: '2025-01-01T01:01:01.000000001Z'
|
|
5369
|
+
id: 00000000-abcd-0002-0000-000000000000
|
|
5370
|
+
relationships:
|
|
5371
|
+
last_modified_by_user:
|
|
5372
|
+
data:
|
|
5373
|
+
id: 00000000-0000-0000-cccc-000000000000
|
|
5374
|
+
type: users
|
|
5375
|
+
type: incident_attachments
|
|
5376
|
+
items:
|
|
5377
|
+
$ref: '#/components/schemas/AttachmentData'
|
|
5378
|
+
type: array
|
|
5379
|
+
included:
|
|
5380
|
+
items:
|
|
5381
|
+
$ref: '#/components/schemas/AttachmentIncluded'
|
|
5382
|
+
type: array
|
|
5383
|
+
required:
|
|
5384
|
+
- data
|
|
5385
|
+
type: object
|
|
5386
|
+
AttachmentData:
|
|
5387
|
+
example:
|
|
5388
|
+
attributes:
|
|
5389
|
+
attachment:
|
|
5390
|
+
documentUrl: https://app.datadoghq.com/notebook/123/Postmortem-IR-123
|
|
5391
|
+
title: Postmortem IR-123
|
|
5392
|
+
attachment_type: postmortem
|
|
5393
|
+
modified: '2025-01-01T01:01:01.000000001Z'
|
|
5394
|
+
id: 00000000-abcd-0002-0000-000000000000
|
|
5395
|
+
relationships:
|
|
5396
|
+
last_modified_by_user:
|
|
5397
|
+
data:
|
|
5398
|
+
id: 00000000-0000-0000-cccc-000000000000
|
|
5399
|
+
type: users
|
|
5400
|
+
type: incident_attachments
|
|
5401
|
+
properties:
|
|
5402
|
+
attributes:
|
|
5403
|
+
$ref: '#/components/schemas/AttachmentDataAttributes'
|
|
5404
|
+
id:
|
|
5405
|
+
example: 00000000-abcd-0002-0000-000000000000
|
|
5406
|
+
type: string
|
|
5407
|
+
relationships:
|
|
5408
|
+
$ref: '#/components/schemas/AttachmentDataRelationships'
|
|
5409
|
+
type:
|
|
5410
|
+
$ref: '#/components/schemas/IncidentAttachmentType'
|
|
5411
|
+
required:
|
|
5412
|
+
- type
|
|
5413
|
+
- attributes
|
|
5414
|
+
- relationships
|
|
5415
|
+
- id
|
|
5416
|
+
type: object
|
|
5417
|
+
AttachmentDataAttributes:
|
|
5418
|
+
properties:
|
|
5419
|
+
attachment:
|
|
5420
|
+
$ref: '#/components/schemas/AttachmentDataAttributesAttachment'
|
|
5421
|
+
attachment_type:
|
|
5422
|
+
$ref: '#/components/schemas/AttachmentDataAttributesAttachmentType'
|
|
5423
|
+
modified:
|
|
5424
|
+
format: date-time
|
|
5425
|
+
type: string
|
|
5426
|
+
type: object
|
|
5427
|
+
AttachmentDataAttributesAttachment:
|
|
5428
|
+
properties:
|
|
5429
|
+
documentUrl:
|
|
5430
|
+
type: string
|
|
5431
|
+
title:
|
|
5432
|
+
type: string
|
|
5433
|
+
type: object
|
|
5434
|
+
AttachmentDataAttributesAttachmentType:
|
|
5435
|
+
enum:
|
|
5436
|
+
- postmortem
|
|
5437
|
+
- link
|
|
5438
|
+
type: string
|
|
5439
|
+
x-enum-varnames:
|
|
5440
|
+
- POSTMORTEM
|
|
5441
|
+
- LINK
|
|
5442
|
+
AttachmentDataRelationships:
|
|
5443
|
+
properties:
|
|
5444
|
+
last_modified_by_user:
|
|
5445
|
+
$ref: '#/components/schemas/AttachmentDataRelationshipsLastModifiedByUser'
|
|
5446
|
+
type: object
|
|
5447
|
+
AttachmentDataRelationshipsLastModifiedByUser:
|
|
5448
|
+
properties:
|
|
5449
|
+
data:
|
|
5450
|
+
$ref: '#/components/schemas/AttachmentDataRelationshipsLastModifiedByUserData'
|
|
5451
|
+
required:
|
|
5452
|
+
- data
|
|
5453
|
+
type: object
|
|
5454
|
+
AttachmentDataRelationshipsLastModifiedByUserData:
|
|
5455
|
+
properties:
|
|
5456
|
+
id:
|
|
5457
|
+
example: ''
|
|
5458
|
+
type: string
|
|
5459
|
+
type:
|
|
5460
|
+
$ref: '#/components/schemas/UserType'
|
|
5461
|
+
required:
|
|
5462
|
+
- type
|
|
5463
|
+
- id
|
|
5464
|
+
type: object
|
|
5465
|
+
AttachmentIncluded:
|
|
5466
|
+
oneOf:
|
|
5467
|
+
- $ref: '#/components/schemas/User140420082644000'
|
|
5361
5468
|
AuditLogsEvent:
|
|
5362
5469
|
description: Object description of an Audit Logs event after it is processed
|
|
5363
5470
|
and stored by Datadog.
|
|
@@ -9061,6 +9168,11 @@ components:
|
|
|
9061
9168
|
CaseCreateAttributes:
|
|
9062
9169
|
description: Case creation attributes
|
|
9063
9170
|
properties:
|
|
9171
|
+
custom_attributes:
|
|
9172
|
+
additionalProperties:
|
|
9173
|
+
$ref: '#/components/schemas/CustomAttributeValue'
|
|
9174
|
+
description: Case custom attributes
|
|
9175
|
+
type: object
|
|
9064
9176
|
description:
|
|
9065
9177
|
description: Description
|
|
9066
9178
|
type: string
|
|
@@ -12894,6 +13006,45 @@ components:
|
|
|
12894
13006
|
required:
|
|
12895
13007
|
- type
|
|
12896
13008
|
type: object
|
|
13009
|
+
CreateAttachmentRequest:
|
|
13010
|
+
example:
|
|
13011
|
+
data:
|
|
13012
|
+
attributes:
|
|
13013
|
+
attachment:
|
|
13014
|
+
documentUrl: https://app.datadoghq.com/notebook/123/Postmortem-IR-123
|
|
13015
|
+
title: Postmortem-IR-123
|
|
13016
|
+
attachment_type: postmortem
|
|
13017
|
+
id: 00000000-0000-0000-0000-000000000000
|
|
13018
|
+
type: incident_attachments
|
|
13019
|
+
properties:
|
|
13020
|
+
data:
|
|
13021
|
+
$ref: '#/components/schemas/CreateAttachmentRequestData'
|
|
13022
|
+
type: object
|
|
13023
|
+
CreateAttachmentRequestData:
|
|
13024
|
+
properties:
|
|
13025
|
+
attributes:
|
|
13026
|
+
$ref: '#/components/schemas/CreateAttachmentRequestDataAttributes'
|
|
13027
|
+
id:
|
|
13028
|
+
type: string
|
|
13029
|
+
type:
|
|
13030
|
+
$ref: '#/components/schemas/IncidentAttachmentType'
|
|
13031
|
+
required:
|
|
13032
|
+
- type
|
|
13033
|
+
type: object
|
|
13034
|
+
CreateAttachmentRequestDataAttributes:
|
|
13035
|
+
properties:
|
|
13036
|
+
attachment:
|
|
13037
|
+
$ref: '#/components/schemas/CreateAttachmentRequestDataAttributesAttachment'
|
|
13038
|
+
attachment_type:
|
|
13039
|
+
$ref: '#/components/schemas/AttachmentDataAttributesAttachmentType'
|
|
13040
|
+
type: object
|
|
13041
|
+
CreateAttachmentRequestDataAttributesAttachment:
|
|
13042
|
+
properties:
|
|
13043
|
+
documentUrl:
|
|
13044
|
+
type: string
|
|
13045
|
+
title:
|
|
13046
|
+
type: string
|
|
13047
|
+
type: object
|
|
12897
13048
|
CreateCaseRequestArray:
|
|
12898
13049
|
description: List of requests to create cases for security findings.
|
|
12899
13050
|
properties:
|
|
@@ -13374,6 +13525,40 @@ components:
|
|
|
13374
13525
|
- name
|
|
13375
13526
|
- targets
|
|
13376
13527
|
type: object
|
|
13528
|
+
CreateOnCallNotificationRuleRequest:
|
|
13529
|
+
description: A top-level wrapper for creating a notification rule for a user
|
|
13530
|
+
example:
|
|
13531
|
+
data:
|
|
13532
|
+
attributes:
|
|
13533
|
+
category: high_urgency
|
|
13534
|
+
channel_settings:
|
|
13535
|
+
method: sms
|
|
13536
|
+
type: phone
|
|
13537
|
+
delay_minutes: 1
|
|
13538
|
+
relationships:
|
|
13539
|
+
channel:
|
|
13540
|
+
data:
|
|
13541
|
+
id: 1562fab3-a8c2-49e2-8f3a-28dcda2405e2
|
|
13542
|
+
type: notification_channels
|
|
13543
|
+
type: notification_rules
|
|
13544
|
+
properties:
|
|
13545
|
+
data:
|
|
13546
|
+
$ref: '#/components/schemas/CreateOnCallNotificationRuleRequestData'
|
|
13547
|
+
required:
|
|
13548
|
+
- data
|
|
13549
|
+
type: object
|
|
13550
|
+
CreateOnCallNotificationRuleRequestData:
|
|
13551
|
+
description: Data for creating an on-call notification rule
|
|
13552
|
+
properties:
|
|
13553
|
+
attributes:
|
|
13554
|
+
$ref: '#/components/schemas/OnCallNotificationRuleRequestAttributes'
|
|
13555
|
+
relationships:
|
|
13556
|
+
$ref: '#/components/schemas/OnCallNotificationRuleRelationships'
|
|
13557
|
+
type:
|
|
13558
|
+
$ref: '#/components/schemas/OnCallNotificationRuleType'
|
|
13559
|
+
required:
|
|
13560
|
+
- type
|
|
13561
|
+
type: object
|
|
13377
13562
|
CreateOpenAPIResponse:
|
|
13378
13563
|
description: Response for `CreateOpenAPI` operation.
|
|
13379
13564
|
properties:
|
|
@@ -14532,9 +14717,9 @@ components:
|
|
|
14532
14717
|
type: number
|
|
14533
14718
|
type: array
|
|
14534
14719
|
CustomAttributeMultiStringValue:
|
|
14535
|
-
description: Value of multi TEXT/URL custom attribute
|
|
14720
|
+
description: Value of multi TEXT/URL/NUMBER/SELECT custom attribute
|
|
14536
14721
|
items:
|
|
14537
|
-
description: TEXT/URL Value
|
|
14722
|
+
description: TEXT/URL/NUMBER/SELECT Value
|
|
14538
14723
|
type: string
|
|
14539
14724
|
type: array
|
|
14540
14725
|
CustomAttributeNumberValue:
|
|
@@ -14542,7 +14727,7 @@ components:
|
|
|
14542
14727
|
format: double
|
|
14543
14728
|
type: number
|
|
14544
14729
|
CustomAttributeStringValue:
|
|
14545
|
-
description: Value of TEXT/URL custom attribute
|
|
14730
|
+
description: Value of TEXT/URL/NUMBER/SELECT custom attribute
|
|
14546
14731
|
type: string
|
|
14547
14732
|
CustomAttributeType:
|
|
14548
14733
|
description: Custom attributes type
|
|
@@ -14550,12 +14735,14 @@ components:
|
|
|
14550
14735
|
- URL
|
|
14551
14736
|
- TEXT
|
|
14552
14737
|
- NUMBER
|
|
14738
|
+
- SELECT
|
|
14553
14739
|
example: NUMBER
|
|
14554
14740
|
type: string
|
|
14555
14741
|
x-enum-varnames:
|
|
14556
14742
|
- URL
|
|
14557
14743
|
- TEXT
|
|
14558
14744
|
- NUMBER
|
|
14745
|
+
- SELECT
|
|
14559
14746
|
CustomAttributeValue:
|
|
14560
14747
|
description: Custom attribute values
|
|
14561
14748
|
properties:
|
|
@@ -15698,6 +15885,78 @@ components:
|
|
|
15698
15885
|
type: string
|
|
15699
15886
|
nullable: true
|
|
15700
15887
|
type: array
|
|
15888
|
+
DORADeploymentFetchResponse:
|
|
15889
|
+
description: Response for fetching a single deployment event.
|
|
15890
|
+
properties:
|
|
15891
|
+
data:
|
|
15892
|
+
$ref: '#/components/schemas/DORADeploymentObject'
|
|
15893
|
+
type: object
|
|
15894
|
+
DORADeploymentObject:
|
|
15895
|
+
description: A DORA deployment event.
|
|
15896
|
+
example:
|
|
15897
|
+
attributes:
|
|
15898
|
+
custom_tags:
|
|
15899
|
+
- language:java
|
|
15900
|
+
- department:engineering
|
|
15901
|
+
- region:us-east-1
|
|
15902
|
+
env: production
|
|
15903
|
+
finished_at: 1693491984000000000
|
|
15904
|
+
git:
|
|
15905
|
+
commit_sha: 66adc9350f2cc9b250b69abddab733dd55e1a588
|
|
15906
|
+
repository_url: https://github.com/organization/example-repository
|
|
15907
|
+
service: shopist
|
|
15908
|
+
started_at: 1693491974000000000
|
|
15909
|
+
team: backend
|
|
15910
|
+
version: v1.12.07
|
|
15911
|
+
id: 4242fcdd31586083
|
|
15912
|
+
type: dora_deployment
|
|
15913
|
+
properties:
|
|
15914
|
+
attributes:
|
|
15915
|
+
$ref: '#/components/schemas/DORADeploymentObjectAttributes'
|
|
15916
|
+
id:
|
|
15917
|
+
description: The ID of the deployment event.
|
|
15918
|
+
type: string
|
|
15919
|
+
type:
|
|
15920
|
+
$ref: '#/components/schemas/DORADeploymentType'
|
|
15921
|
+
type: object
|
|
15922
|
+
DORADeploymentObjectAttributes:
|
|
15923
|
+
description: The attributes of the deployment event.
|
|
15924
|
+
properties:
|
|
15925
|
+
custom_tags:
|
|
15926
|
+
$ref: '#/components/schemas/DORACustomTags'
|
|
15927
|
+
env:
|
|
15928
|
+
description: Environment name to where the service was deployed.
|
|
15929
|
+
example: production
|
|
15930
|
+
type: string
|
|
15931
|
+
finished_at:
|
|
15932
|
+
description: Unix timestamp when the deployment finished.
|
|
15933
|
+
example: 1693491984000000000
|
|
15934
|
+
format: int64
|
|
15935
|
+
type: integer
|
|
15936
|
+
git:
|
|
15937
|
+
$ref: '#/components/schemas/DORAGitInfo'
|
|
15938
|
+
service:
|
|
15939
|
+
description: Service name.
|
|
15940
|
+
example: shopist
|
|
15941
|
+
type: string
|
|
15942
|
+
started_at:
|
|
15943
|
+
description: Unix timestamp when the deployment started.
|
|
15944
|
+
example: 1693491974000000000
|
|
15945
|
+
format: int64
|
|
15946
|
+
type: integer
|
|
15947
|
+
team:
|
|
15948
|
+
description: Name of the team owning the deployed service.
|
|
15949
|
+
example: backend
|
|
15950
|
+
type: string
|
|
15951
|
+
version:
|
|
15952
|
+
description: Version to correlate with APM Deployment Tracking.
|
|
15953
|
+
example: v1.12.07
|
|
15954
|
+
type: string
|
|
15955
|
+
required:
|
|
15956
|
+
- service
|
|
15957
|
+
- started_at
|
|
15958
|
+
- finished_at
|
|
15959
|
+
type: object
|
|
15701
15960
|
DORADeploymentRequest:
|
|
15702
15961
|
description: Request to create a DORA deployment event.
|
|
15703
15962
|
properties:
|
|
@@ -15724,7 +15983,9 @@ components:
|
|
|
15724
15983
|
git:
|
|
15725
15984
|
$ref: '#/components/schemas/DORAGitInfo'
|
|
15726
15985
|
id:
|
|
15727
|
-
description: Deployment ID.
|
|
15986
|
+
description: Deployment ID. Must be 16-128 characters and contain only alphanumeric
|
|
15987
|
+
characters, hyphens, underscores, periods, and colons (a-z, A-Z, 0-9,
|
|
15988
|
+
-, _, ., :).
|
|
15728
15989
|
type: string
|
|
15729
15990
|
service:
|
|
15730
15991
|
description: Service name.
|
|
@@ -15788,18 +16049,53 @@ components:
|
|
|
15788
16049
|
type: string
|
|
15789
16050
|
x-enum-varnames:
|
|
15790
16051
|
- DORA_DEPLOYMENT
|
|
15791
|
-
|
|
15792
|
-
description:
|
|
16052
|
+
DORADeploymentsListResponse:
|
|
16053
|
+
description: Response for the list deployments endpoint.
|
|
16054
|
+
example:
|
|
16055
|
+
data:
|
|
16056
|
+
- attributes:
|
|
16057
|
+
custom_tags:
|
|
16058
|
+
- language:java
|
|
16059
|
+
- department:engineering
|
|
16060
|
+
- region:us-east-1
|
|
16061
|
+
env: production
|
|
16062
|
+
finished_at: 1693491984000000000
|
|
16063
|
+
git:
|
|
16064
|
+
commit_sha: 66adc9350f2cc9b250b69abddab733dd55e1a588
|
|
16065
|
+
repository_url: https://github.com/organization/example-repository
|
|
16066
|
+
service: shopist
|
|
16067
|
+
started_at: 1693491974000000000
|
|
16068
|
+
team: backend
|
|
16069
|
+
version: v1.12.07
|
|
16070
|
+
id: 4242fcdd31586083
|
|
16071
|
+
type: dora_deployment
|
|
16072
|
+
- attributes:
|
|
16073
|
+
custom_tags:
|
|
16074
|
+
- language:go
|
|
16075
|
+
- department:platform
|
|
16076
|
+
env: production
|
|
16077
|
+
finished_at: 1693492084000000000
|
|
16078
|
+
git:
|
|
16079
|
+
commit_sha: 77bdc9350f2cc9b250b69abddab733dd55e1a599
|
|
16080
|
+
repository_url: https://github.com/organization/api-service
|
|
16081
|
+
service: api-service
|
|
16082
|
+
started_at: 1693492074000000000
|
|
16083
|
+
team: backend
|
|
16084
|
+
version: v2.1.0
|
|
16085
|
+
id: 4242fcdd31586084
|
|
16086
|
+
type: dora_deployment
|
|
15793
16087
|
properties:
|
|
15794
|
-
|
|
15795
|
-
description: The
|
|
15796
|
-
|
|
15797
|
-
|
|
15798
|
-
|
|
15799
|
-
|
|
15800
|
-
|
|
15801
|
-
|
|
15802
|
-
|
|
16088
|
+
data:
|
|
16089
|
+
description: The list of DORA deployment events.
|
|
16090
|
+
items:
|
|
16091
|
+
$ref: '#/components/schemas/DORADeploymentObject'
|
|
16092
|
+
type: array
|
|
16093
|
+
type: object
|
|
16094
|
+
DORAFailureFetchResponse:
|
|
16095
|
+
description: Response for fetching a single failure event.
|
|
16096
|
+
properties:
|
|
16097
|
+
data:
|
|
16098
|
+
$ref: '#/components/schemas/DORAIncidentObject'
|
|
15803
16099
|
type: object
|
|
15804
16100
|
DORAFailureRequest:
|
|
15805
16101
|
description: Request to create a DORA failure event.
|
|
@@ -15827,8 +16123,9 @@ components:
|
|
|
15827
16123
|
git:
|
|
15828
16124
|
$ref: '#/components/schemas/DORAGitInfo'
|
|
15829
16125
|
id:
|
|
15830
|
-
description: Failure ID. Must
|
|
15831
|
-
a
|
|
16126
|
+
description: Failure ID. Must be 16-128 characters and contain only alphanumeric
|
|
16127
|
+
characters, hyphens, underscores, periods, and colons (a-z, A-Z, 0-9,
|
|
16128
|
+
-, _, ., :).
|
|
15832
16129
|
type: string
|
|
15833
16130
|
name:
|
|
15834
16131
|
description: Failure name.
|
|
@@ -15903,11 +16200,45 @@ components:
|
|
|
15903
16200
|
type: string
|
|
15904
16201
|
x-enum-varnames:
|
|
15905
16202
|
- DORA_FAILURE
|
|
15906
|
-
|
|
15907
|
-
description: Response for the
|
|
16203
|
+
DORAFailuresListResponse:
|
|
16204
|
+
description: Response for the list failures endpoint.
|
|
16205
|
+
example:
|
|
16206
|
+
data:
|
|
16207
|
+
- attributes:
|
|
16208
|
+
custom_tags:
|
|
16209
|
+
- incident_type:database
|
|
16210
|
+
- department:engineering
|
|
16211
|
+
env: production
|
|
16212
|
+
finished_at: 1693492274000000000
|
|
16213
|
+
name: Database outage
|
|
16214
|
+
services:
|
|
16215
|
+
- shopist
|
|
16216
|
+
severity: SEV-1
|
|
16217
|
+
started_at: 1693492174000000000
|
|
16218
|
+
team: backend
|
|
16219
|
+
id: 4242fcdd31586085
|
|
16220
|
+
type: dora_incident
|
|
16221
|
+
- attributes:
|
|
16222
|
+
custom_tags:
|
|
16223
|
+
- incident_type:service_down
|
|
16224
|
+
- department:platform
|
|
16225
|
+
env: production
|
|
16226
|
+
finished_at: 1693492474000000000
|
|
16227
|
+
name: API service outage
|
|
16228
|
+
services:
|
|
16229
|
+
- api-service
|
|
16230
|
+
- payment-service
|
|
16231
|
+
severity: SEV-2
|
|
16232
|
+
started_at: 1693492374000000000
|
|
16233
|
+
team: backend
|
|
16234
|
+
id: 4242fcdd31586086
|
|
16235
|
+
type: dora_incident
|
|
15908
16236
|
properties:
|
|
15909
16237
|
data:
|
|
15910
|
-
|
|
16238
|
+
description: The list of DORA incident events.
|
|
16239
|
+
items:
|
|
16240
|
+
$ref: '#/components/schemas/DORAIncidentObject'
|
|
16241
|
+
type: array
|
|
15911
16242
|
type: object
|
|
15912
16243
|
DORAGitInfo:
|
|
15913
16244
|
description: Git info for DORA Metrics events.
|
|
@@ -15920,6 +16251,82 @@ components:
|
|
|
15920
16251
|
- repository_url
|
|
15921
16252
|
- commit_sha
|
|
15922
16253
|
type: object
|
|
16254
|
+
DORAIncidentObject:
|
|
16255
|
+
description: A DORA incident event.
|
|
16256
|
+
example:
|
|
16257
|
+
attributes:
|
|
16258
|
+
custom_tags:
|
|
16259
|
+
- incident_type:database
|
|
16260
|
+
- department:engineering
|
|
16261
|
+
env: production
|
|
16262
|
+
finished_at: 1693492274000000000
|
|
16263
|
+
git:
|
|
16264
|
+
commit_sha: 66adc9350f2cc9b250b69abddab733dd55e1a588
|
|
16265
|
+
repository_url: https://github.com/organization/example-repository
|
|
16266
|
+
name: Database outage
|
|
16267
|
+
services:
|
|
16268
|
+
- shopist
|
|
16269
|
+
severity: SEV-1
|
|
16270
|
+
started_at: 1693492174000000000
|
|
16271
|
+
team: backend
|
|
16272
|
+
id: 4242fcdd31586085
|
|
16273
|
+
type: dora_incident
|
|
16274
|
+
properties:
|
|
16275
|
+
attributes:
|
|
16276
|
+
$ref: '#/components/schemas/DORAIncidentObjectAttributes'
|
|
16277
|
+
id:
|
|
16278
|
+
description: The ID of the incident event.
|
|
16279
|
+
type: string
|
|
16280
|
+
type:
|
|
16281
|
+
$ref: '#/components/schemas/DORAFailureType'
|
|
16282
|
+
type: object
|
|
16283
|
+
DORAIncidentObjectAttributes:
|
|
16284
|
+
description: The attributes of the incident event.
|
|
16285
|
+
properties:
|
|
16286
|
+
custom_tags:
|
|
16287
|
+
$ref: '#/components/schemas/DORACustomTags'
|
|
16288
|
+
env:
|
|
16289
|
+
description: Environment name that was impacted by the incident.
|
|
16290
|
+
example: production
|
|
16291
|
+
type: string
|
|
16292
|
+
finished_at:
|
|
16293
|
+
description: Unix timestamp when the incident finished.
|
|
16294
|
+
example: 1693491984000000000
|
|
16295
|
+
format: int64
|
|
16296
|
+
type: integer
|
|
16297
|
+
git:
|
|
16298
|
+
$ref: '#/components/schemas/DORAGitInfo'
|
|
16299
|
+
name:
|
|
16300
|
+
description: Incident name.
|
|
16301
|
+
example: Database outage
|
|
16302
|
+
type: string
|
|
16303
|
+
services:
|
|
16304
|
+
description: Service names impacted by the incident.
|
|
16305
|
+
example:
|
|
16306
|
+
- shopist
|
|
16307
|
+
items:
|
|
16308
|
+
type: string
|
|
16309
|
+
type: array
|
|
16310
|
+
severity:
|
|
16311
|
+
description: Incident severity.
|
|
16312
|
+
example: SEV-1
|
|
16313
|
+
type: string
|
|
16314
|
+
started_at:
|
|
16315
|
+
description: Unix timestamp when the incident started.
|
|
16316
|
+
example: 1693491974000000000
|
|
16317
|
+
format: int64
|
|
16318
|
+
type: integer
|
|
16319
|
+
team:
|
|
16320
|
+
description: Name of the team owning the services impacted.
|
|
16321
|
+
example: backend
|
|
16322
|
+
type: string
|
|
16323
|
+
version:
|
|
16324
|
+
description: Version to correlate with APM Deployment Tracking.
|
|
16325
|
+
example: v1.12.07
|
|
16326
|
+
type: string
|
|
16327
|
+
required:
|
|
16328
|
+
- started_at
|
|
16329
|
+
type: object
|
|
15923
16330
|
DORAListDeploymentsRequest:
|
|
15924
16331
|
description: Request to get a list of deployments.
|
|
15925
16332
|
example:
|
|
@@ -15939,32 +16346,31 @@ components:
|
|
|
15939
16346
|
type: object
|
|
15940
16347
|
DORAListDeploymentsRequestAttributes:
|
|
15941
16348
|
description: Attributes to get a list of deployments.
|
|
15942
|
-
example:
|
|
15943
|
-
from: '2025-01-01T00:00:00Z'
|
|
15944
|
-
limit: 500
|
|
15945
|
-
query: service:(shopist OR api-service OR payment-service) env:(production
|
|
15946
|
-
OR staging) team:(backend OR platform)
|
|
15947
|
-
sort: -started_at
|
|
15948
|
-
to: '2025-01-31T23:59:59Z'
|
|
15949
16349
|
properties:
|
|
15950
16350
|
from:
|
|
15951
16351
|
description: Minimum timestamp for requested events.
|
|
16352
|
+
example: '2025-01-01T00:00:00Z'
|
|
15952
16353
|
format: date-time
|
|
15953
16354
|
type: string
|
|
15954
16355
|
limit:
|
|
15955
16356
|
default: 10
|
|
15956
16357
|
description: Maximum number of events in the response.
|
|
16358
|
+
example: 500
|
|
15957
16359
|
format: int32
|
|
15958
16360
|
maximum: 1000
|
|
15959
16361
|
type: integer
|
|
15960
16362
|
query:
|
|
15961
16363
|
description: Search query with event platform syntax.
|
|
16364
|
+
example: service:(shopist OR api-service OR payment-service) env:(production
|
|
16365
|
+
OR staging) team:(backend OR platform)
|
|
15962
16366
|
type: string
|
|
15963
16367
|
sort:
|
|
15964
16368
|
description: Sort order (prefixed with `-` for descending).
|
|
16369
|
+
example: -started_at
|
|
15965
16370
|
type: string
|
|
15966
16371
|
to:
|
|
15967
16372
|
description: Maximum timestamp for requested events.
|
|
16373
|
+
example: '2025-01-31T23:59:59Z'
|
|
15968
16374
|
format: date-time
|
|
15969
16375
|
type: string
|
|
15970
16376
|
type: object
|
|
@@ -15987,9 +16393,11 @@ components:
|
|
|
15987
16393
|
- attributes
|
|
15988
16394
|
type: object
|
|
15989
16395
|
DORAListDeploymentsRequestDataType:
|
|
16396
|
+
default: dora_deployments_list_request
|
|
15990
16397
|
description: The definition of `DORAListDeploymentsRequestDataType` object.
|
|
15991
16398
|
enum:
|
|
15992
16399
|
- dora_deployments_list_request
|
|
16400
|
+
example: dora_deployments_list_request
|
|
15993
16401
|
type: string
|
|
15994
16402
|
x-enum-varnames:
|
|
15995
16403
|
- DORA_DEPLOYMENTS_LIST_REQUEST
|
|
@@ -16012,32 +16420,31 @@ components:
|
|
|
16012
16420
|
type: object
|
|
16013
16421
|
DORAListFailuresRequestAttributes:
|
|
16014
16422
|
description: Attributes to get a list of failures.
|
|
16015
|
-
example:
|
|
16016
|
-
from: '2025-01-01T00:00:00Z'
|
|
16017
|
-
limit: 500
|
|
16018
|
-
query: severity:(SEV-1 OR SEV-2) env:(production OR staging) service:(shopist
|
|
16019
|
-
OR api-service OR payment-service) team:(backend OR platform OR payments)
|
|
16020
|
-
sort: -started_at
|
|
16021
|
-
to: '2025-01-31T23:59:59Z'
|
|
16022
16423
|
properties:
|
|
16023
16424
|
from:
|
|
16024
16425
|
description: Minimum timestamp for requested events.
|
|
16426
|
+
example: '2025-01-01T00:00:00Z'
|
|
16025
16427
|
format: date-time
|
|
16026
16428
|
type: string
|
|
16027
16429
|
limit:
|
|
16028
16430
|
default: 10
|
|
16029
16431
|
description: Maximum number of events in the response.
|
|
16432
|
+
example: 500
|
|
16030
16433
|
format: int32
|
|
16031
16434
|
maximum: 1000
|
|
16032
16435
|
type: integer
|
|
16033
16436
|
query:
|
|
16034
16437
|
description: Search query with event platform syntax.
|
|
16438
|
+
example: severity:(SEV-1 OR SEV-2) env:(production OR staging) service:(shopist
|
|
16439
|
+
OR api-service OR payment-service) team:(backend OR platform OR payments)
|
|
16035
16440
|
type: string
|
|
16036
16441
|
sort:
|
|
16037
16442
|
description: Sort order (prefixed with `-` for descending).
|
|
16443
|
+
example: -started_at
|
|
16038
16444
|
type: string
|
|
16039
16445
|
to:
|
|
16040
16446
|
description: Maximum timestamp for requested events.
|
|
16447
|
+
example: '2025-01-31T23:59:59Z'
|
|
16041
16448
|
format: date-time
|
|
16042
16449
|
type: string
|
|
16043
16450
|
type: object
|
|
@@ -16060,54 +16467,14 @@ components:
|
|
|
16060
16467
|
- attributes
|
|
16061
16468
|
type: object
|
|
16062
16469
|
DORAListFailuresRequestDataType:
|
|
16470
|
+
default: dora_failures_list_request
|
|
16063
16471
|
description: The definition of `DORAListFailuresRequestDataType` object.
|
|
16064
16472
|
enum:
|
|
16065
16473
|
- dora_failures_list_request
|
|
16474
|
+
example: dora_failures_list_request
|
|
16066
16475
|
type: string
|
|
16067
16476
|
x-enum-varnames:
|
|
16068
16477
|
- DORA_FAILURES_LIST_REQUEST
|
|
16069
|
-
DORAListResponse:
|
|
16070
|
-
description: Response for the DORA list endpoints.
|
|
16071
|
-
example:
|
|
16072
|
-
data:
|
|
16073
|
-
- attributes:
|
|
16074
|
-
custom_tags:
|
|
16075
|
-
- language:java
|
|
16076
|
-
- department:engineering
|
|
16077
|
-
- region:us-east-1
|
|
16078
|
-
env: production
|
|
16079
|
-
finished_at: 1693491984000000000
|
|
16080
|
-
git:
|
|
16081
|
-
commit_sha: 66adc9350f2cc9b250b69abddab733dd55e1a588
|
|
16082
|
-
repository_url: https://github.com/organization/example-repository
|
|
16083
|
-
service: shopist
|
|
16084
|
-
started_at: 1693491974000000000
|
|
16085
|
-
team: backend
|
|
16086
|
-
version: v1.12.07
|
|
16087
|
-
id: 4242fcdd31586083
|
|
16088
|
-
type: dora_deployment
|
|
16089
|
-
- attributes:
|
|
16090
|
-
custom_tags:
|
|
16091
|
-
- language:go
|
|
16092
|
-
- department:platform
|
|
16093
|
-
env: production
|
|
16094
|
-
finished_at: 1693492084000000000
|
|
16095
|
-
git:
|
|
16096
|
-
commit_sha: 77bdc9350f2cc9b250b69abddab733dd55e1a599
|
|
16097
|
-
repository_url: https://github.com/organization/api-service
|
|
16098
|
-
service: api-service
|
|
16099
|
-
started_at: 1693492074000000000
|
|
16100
|
-
team: backend
|
|
16101
|
-
version: v2.1.0
|
|
16102
|
-
id: 4242fcdd31586084
|
|
16103
|
-
type: dora_deployment
|
|
16104
|
-
properties:
|
|
16105
|
-
data:
|
|
16106
|
-
description: The list of DORA events.
|
|
16107
|
-
items:
|
|
16108
|
-
$ref: '#/components/schemas/DORAEvent'
|
|
16109
|
-
type: array
|
|
16110
|
-
type: object
|
|
16111
16478
|
DashboardListAddItemsRequest:
|
|
16112
16479
|
description: Request containing a list of dashboards to add.
|
|
16113
16480
|
properties:
|
|
@@ -25014,6 +25381,61 @@ components:
|
|
|
25014
25381
|
required:
|
|
25015
25382
|
- type
|
|
25016
25383
|
type: object
|
|
25384
|
+
GlobalVariableData:
|
|
25385
|
+
description: Synthetics global variable data. Wrapper around the global variable
|
|
25386
|
+
object.
|
|
25387
|
+
properties:
|
|
25388
|
+
attributes:
|
|
25389
|
+
$ref: '#/components/schemas/SyntheticsGlobalVariable'
|
|
25390
|
+
id:
|
|
25391
|
+
description: Global variable identifier.
|
|
25392
|
+
type: string
|
|
25393
|
+
type:
|
|
25394
|
+
$ref: '#/components/schemas/GlobalVariableType'
|
|
25395
|
+
type: object
|
|
25396
|
+
GlobalVariableJsonPatchRequest:
|
|
25397
|
+
description: JSON Patch request for global variable.
|
|
25398
|
+
properties:
|
|
25399
|
+
data:
|
|
25400
|
+
$ref: '#/components/schemas/GlobalVariableJsonPatchRequestData'
|
|
25401
|
+
required:
|
|
25402
|
+
- data
|
|
25403
|
+
type: object
|
|
25404
|
+
GlobalVariableJsonPatchRequestData:
|
|
25405
|
+
properties:
|
|
25406
|
+
attributes:
|
|
25407
|
+
$ref: '#/components/schemas/GlobalVariableJsonPatchRequestDataAttributes'
|
|
25408
|
+
type:
|
|
25409
|
+
$ref: '#/components/schemas/GlobalVariableJsonPatchType'
|
|
25410
|
+
type: object
|
|
25411
|
+
GlobalVariableJsonPatchRequestDataAttributes:
|
|
25412
|
+
properties:
|
|
25413
|
+
json_patch:
|
|
25414
|
+
description: JSON Patch operations following RFC 6902.
|
|
25415
|
+
items:
|
|
25416
|
+
$ref: '#/components/schemas/JsonPatchOperation'
|
|
25417
|
+
type: array
|
|
25418
|
+
type: object
|
|
25419
|
+
GlobalVariableJsonPatchType:
|
|
25420
|
+
description: Global variable JSON Patch type.
|
|
25421
|
+
enum:
|
|
25422
|
+
- global_variables_json_patch
|
|
25423
|
+
type: string
|
|
25424
|
+
x-enum-varnames:
|
|
25425
|
+
- GLOBAL_VARIABLES_JSON_PATCH
|
|
25426
|
+
GlobalVariableResponse:
|
|
25427
|
+
description: Global variable response.
|
|
25428
|
+
properties:
|
|
25429
|
+
data:
|
|
25430
|
+
$ref: '#/components/schemas/GlobalVariableData'
|
|
25431
|
+
type: object
|
|
25432
|
+
GlobalVariableType:
|
|
25433
|
+
description: Global variable type.
|
|
25434
|
+
enum:
|
|
25435
|
+
- global_variables
|
|
25436
|
+
type: string
|
|
25437
|
+
x-enum-varnames:
|
|
25438
|
+
- GLOBAL_VARIABLES
|
|
25017
25439
|
GoogleMeetConfigurationReference:
|
|
25018
25440
|
description: A reference to a Google Meet Configuration resource.
|
|
25019
25441
|
nullable: true
|
|
@@ -25665,126 +26087,6 @@ components:
|
|
|
25665
26087
|
type: string
|
|
25666
26088
|
x-mimetype: application/xml
|
|
25667
26089
|
type: object
|
|
25668
|
-
IncidentAttachmentAttachmentType:
|
|
25669
|
-
description: The type of the incident attachment attributes.
|
|
25670
|
-
enum:
|
|
25671
|
-
- link
|
|
25672
|
-
- postmortem
|
|
25673
|
-
example: link
|
|
25674
|
-
type: string
|
|
25675
|
-
x-enum-varnames:
|
|
25676
|
-
- LINK
|
|
25677
|
-
- POSTMORTEM
|
|
25678
|
-
IncidentAttachmentAttributes:
|
|
25679
|
-
description: The attributes object for an attachment.
|
|
25680
|
-
oneOf:
|
|
25681
|
-
- $ref: '#/components/schemas/IncidentAttachmentPostmortemAttributes'
|
|
25682
|
-
- $ref: '#/components/schemas/IncidentAttachmentLinkAttributes'
|
|
25683
|
-
IncidentAttachmentData:
|
|
25684
|
-
description: A single incident attachment.
|
|
25685
|
-
example:
|
|
25686
|
-
attributes:
|
|
25687
|
-
attachment:
|
|
25688
|
-
documentUrl: ''
|
|
25689
|
-
title: Postmortem IR-123
|
|
25690
|
-
attachment_type: postmortem
|
|
25691
|
-
id: 00000000-abcd-0002-0000-000000000000
|
|
25692
|
-
relationships:
|
|
25693
|
-
last_modified_by_user:
|
|
25694
|
-
data:
|
|
25695
|
-
id: 00000000-0000-0000-cccc-000000000000
|
|
25696
|
-
type: users
|
|
25697
|
-
type: incident_attachments
|
|
25698
|
-
properties:
|
|
25699
|
-
attributes:
|
|
25700
|
-
$ref: '#/components/schemas/IncidentAttachmentAttributes'
|
|
25701
|
-
id:
|
|
25702
|
-
description: A unique identifier that represents the incident attachment.
|
|
25703
|
-
example: 00000000-abcd-0001-0000-000000000000
|
|
25704
|
-
type: string
|
|
25705
|
-
relationships:
|
|
25706
|
-
$ref: '#/components/schemas/IncidentAttachmentRelationships'
|
|
25707
|
-
type:
|
|
25708
|
-
$ref: '#/components/schemas/IncidentAttachmentType'
|
|
25709
|
-
required:
|
|
25710
|
-
- type
|
|
25711
|
-
- attributes
|
|
25712
|
-
- id
|
|
25713
|
-
- relationships
|
|
25714
|
-
type: object
|
|
25715
|
-
IncidentAttachmentLinkAttachmentType:
|
|
25716
|
-
default: link
|
|
25717
|
-
description: The type of link attachment attributes.
|
|
25718
|
-
enum:
|
|
25719
|
-
- link
|
|
25720
|
-
example: link
|
|
25721
|
-
type: string
|
|
25722
|
-
x-enum-varnames:
|
|
25723
|
-
- LINK
|
|
25724
|
-
IncidentAttachmentLinkAttributes:
|
|
25725
|
-
description: The attributes object for a link attachment.
|
|
25726
|
-
properties:
|
|
25727
|
-
attachment:
|
|
25728
|
-
$ref: '#/components/schemas/IncidentAttachmentLinkAttributesAttachmentObject'
|
|
25729
|
-
attachment_type:
|
|
25730
|
-
$ref: '#/components/schemas/IncidentAttachmentLinkAttachmentType'
|
|
25731
|
-
modified:
|
|
25732
|
-
description: Timestamp when the incident attachment link was last modified.
|
|
25733
|
-
format: date-time
|
|
25734
|
-
readOnly: true
|
|
25735
|
-
type: string
|
|
25736
|
-
required:
|
|
25737
|
-
- attachment_type
|
|
25738
|
-
- attachment
|
|
25739
|
-
type: object
|
|
25740
|
-
IncidentAttachmentLinkAttributesAttachmentObject:
|
|
25741
|
-
description: The link attachment.
|
|
25742
|
-
properties:
|
|
25743
|
-
documentUrl:
|
|
25744
|
-
description: The URL of this link attachment.
|
|
25745
|
-
example: https://www.example.com/webstore-failure-runbook
|
|
25746
|
-
type: string
|
|
25747
|
-
title:
|
|
25748
|
-
description: The title of this link attachment.
|
|
25749
|
-
example: Runbook for webstore service failures
|
|
25750
|
-
type: string
|
|
25751
|
-
required:
|
|
25752
|
-
- documentUrl
|
|
25753
|
-
- title
|
|
25754
|
-
type: object
|
|
25755
|
-
IncidentAttachmentPostmortemAttachmentType:
|
|
25756
|
-
default: postmortem
|
|
25757
|
-
description: The type of postmortem attachment attributes.
|
|
25758
|
-
enum:
|
|
25759
|
-
- postmortem
|
|
25760
|
-
example: postmortem
|
|
25761
|
-
type: string
|
|
25762
|
-
x-enum-varnames:
|
|
25763
|
-
- POSTMORTEM
|
|
25764
|
-
IncidentAttachmentPostmortemAttributes:
|
|
25765
|
-
description: The attributes object for a postmortem attachment.
|
|
25766
|
-
properties:
|
|
25767
|
-
attachment:
|
|
25768
|
-
$ref: '#/components/schemas/IncidentAttachmentsPostmortemAttributesAttachmentObject'
|
|
25769
|
-
attachment_type:
|
|
25770
|
-
$ref: '#/components/schemas/IncidentAttachmentPostmortemAttachmentType'
|
|
25771
|
-
required:
|
|
25772
|
-
- attachment_type
|
|
25773
|
-
- attachment
|
|
25774
|
-
type: object
|
|
25775
|
-
IncidentAttachmentRelatedObject:
|
|
25776
|
-
description: The object related to an incident attachment.
|
|
25777
|
-
enum:
|
|
25778
|
-
- users
|
|
25779
|
-
type: string
|
|
25780
|
-
x-enum-varnames:
|
|
25781
|
-
- USERS
|
|
25782
|
-
IncidentAttachmentRelationships:
|
|
25783
|
-
description: The incident attachment's relationships.
|
|
25784
|
-
properties:
|
|
25785
|
-
last_modified_by_user:
|
|
25786
|
-
$ref: '#/components/schemas/RelationshipToUser'
|
|
25787
|
-
type: object
|
|
25788
26090
|
IncidentAttachmentType:
|
|
25789
26091
|
default: incident_attachments
|
|
25790
26092
|
description: The incident attachment resource type.
|
|
@@ -25794,142 +26096,6 @@ components:
|
|
|
25794
26096
|
type: string
|
|
25795
26097
|
x-enum-varnames:
|
|
25796
26098
|
- INCIDENT_ATTACHMENTS
|
|
25797
|
-
IncidentAttachmentUpdateAttributes:
|
|
25798
|
-
description: Incident attachment attributes.
|
|
25799
|
-
oneOf:
|
|
25800
|
-
- $ref: '#/components/schemas/IncidentAttachmentPostmortemAttributes'
|
|
25801
|
-
- $ref: '#/components/schemas/IncidentAttachmentLinkAttributes'
|
|
25802
|
-
IncidentAttachmentUpdateData:
|
|
25803
|
-
description: A single incident attachment.
|
|
25804
|
-
properties:
|
|
25805
|
-
attributes:
|
|
25806
|
-
$ref: '#/components/schemas/IncidentAttachmentUpdateAttributes'
|
|
25807
|
-
id:
|
|
25808
|
-
description: A unique identifier that represents the incident attachment.
|
|
25809
|
-
example: 00000000-abcd-0001-0000-000000000000
|
|
25810
|
-
type: string
|
|
25811
|
-
type:
|
|
25812
|
-
$ref: '#/components/schemas/IncidentAttachmentType'
|
|
25813
|
-
required:
|
|
25814
|
-
- type
|
|
25815
|
-
type: object
|
|
25816
|
-
IncidentAttachmentUpdateRequest:
|
|
25817
|
-
description: The update request for an incident's attachments.
|
|
25818
|
-
properties:
|
|
25819
|
-
data:
|
|
25820
|
-
description: 'An array of incident attachments. An attachment object without
|
|
25821
|
-
an "id" key indicates that you want to
|
|
25822
|
-
|
|
25823
|
-
create that attachment. An attachment object without an "attributes" key
|
|
25824
|
-
indicates that you want to
|
|
25825
|
-
|
|
25826
|
-
delete that attachment. An attachment object with both the "id" key and
|
|
25827
|
-
a populated "attributes" object
|
|
25828
|
-
|
|
25829
|
-
indicates that you want to update that attachment.'
|
|
25830
|
-
example:
|
|
25831
|
-
- attributes:
|
|
25832
|
-
attachment:
|
|
25833
|
-
documentUrl: https://app.datadoghq.com/notebook/123
|
|
25834
|
-
title: Postmortem IR-123
|
|
25835
|
-
attachment_type: postmortem
|
|
25836
|
-
id: 00000000-abcd-0002-0000-000000000000
|
|
25837
|
-
type: incident_attachments
|
|
25838
|
-
- attributes:
|
|
25839
|
-
attachment:
|
|
25840
|
-
documentUrl: https://www.example.com/webstore-failure-runbook
|
|
25841
|
-
title: Runbook for webstore service failures
|
|
25842
|
-
attachment_type: link
|
|
25843
|
-
type: incident_attachments
|
|
25844
|
-
- id: 00000000-abcd-0003-0000-000000000000
|
|
25845
|
-
type: incident_attachments
|
|
25846
|
-
items:
|
|
25847
|
-
$ref: '#/components/schemas/IncidentAttachmentUpdateData'
|
|
25848
|
-
type: array
|
|
25849
|
-
required:
|
|
25850
|
-
- data
|
|
25851
|
-
type: object
|
|
25852
|
-
IncidentAttachmentUpdateResponse:
|
|
25853
|
-
description: The response object containing the created or updated incident
|
|
25854
|
-
attachments.
|
|
25855
|
-
properties:
|
|
25856
|
-
data:
|
|
25857
|
-
description: 'An array of incident attachments. Only the attachments that
|
|
25858
|
-
were created or updated by the request are
|
|
25859
|
-
|
|
25860
|
-
returned.'
|
|
25861
|
-
example:
|
|
25862
|
-
- attributes:
|
|
25863
|
-
attachment:
|
|
25864
|
-
documentUrl: ''
|
|
25865
|
-
title: Postmortem IR-123
|
|
25866
|
-
attachment_type: postmortem
|
|
25867
|
-
id: 00000000-abcd-0002-0000-000000000000
|
|
25868
|
-
relationships:
|
|
25869
|
-
last_modified_by_user:
|
|
25870
|
-
data:
|
|
25871
|
-
id: 00000000-0000-0000-cccc-000000000000
|
|
25872
|
-
type: users
|
|
25873
|
-
type: incident_attachments
|
|
25874
|
-
items:
|
|
25875
|
-
$ref: '#/components/schemas/IncidentAttachmentData'
|
|
25876
|
-
type: array
|
|
25877
|
-
included:
|
|
25878
|
-
description: Included related resources that the user requested.
|
|
25879
|
-
items:
|
|
25880
|
-
$ref: '#/components/schemas/IncidentAttachmentsResponseIncludedItem'
|
|
25881
|
-
type: array
|
|
25882
|
-
required:
|
|
25883
|
-
- data
|
|
25884
|
-
type: object
|
|
25885
|
-
IncidentAttachmentsPostmortemAttributesAttachmentObject:
|
|
25886
|
-
description: The postmortem attachment.
|
|
25887
|
-
properties:
|
|
25888
|
-
documentUrl:
|
|
25889
|
-
description: The URL of this notebook attachment.
|
|
25890
|
-
example: https://app.datadoghq.com/notebook/123
|
|
25891
|
-
type: string
|
|
25892
|
-
title:
|
|
25893
|
-
description: The title of this postmortem attachment.
|
|
25894
|
-
example: Postmortem IR-123
|
|
25895
|
-
type: string
|
|
25896
|
-
required:
|
|
25897
|
-
- documentUrl
|
|
25898
|
-
- title
|
|
25899
|
-
type: object
|
|
25900
|
-
IncidentAttachmentsResponse:
|
|
25901
|
-
description: The response object containing an incident's attachments.
|
|
25902
|
-
properties:
|
|
25903
|
-
data:
|
|
25904
|
-
description: An array of incident attachments.
|
|
25905
|
-
example:
|
|
25906
|
-
- attributes:
|
|
25907
|
-
attachment:
|
|
25908
|
-
documentUrl: ''
|
|
25909
|
-
title: Postmortem IR-123
|
|
25910
|
-
attachment_type: postmortem
|
|
25911
|
-
id: 00000000-abcd-0002-0000-000000000000
|
|
25912
|
-
relationships:
|
|
25913
|
-
last_modified_by_user:
|
|
25914
|
-
data:
|
|
25915
|
-
id: 00000000-0000-0000-cccc-000000000000
|
|
25916
|
-
type: users
|
|
25917
|
-
type: incident_attachments
|
|
25918
|
-
items:
|
|
25919
|
-
$ref: '#/components/schemas/IncidentAttachmentData'
|
|
25920
|
-
type: array
|
|
25921
|
-
included:
|
|
25922
|
-
description: Included related resources that the user requested.
|
|
25923
|
-
items:
|
|
25924
|
-
$ref: '#/components/schemas/IncidentAttachmentsResponseIncludedItem'
|
|
25925
|
-
type: array
|
|
25926
|
-
required:
|
|
25927
|
-
- data
|
|
25928
|
-
type: object
|
|
25929
|
-
IncidentAttachmentsResponseIncludedItem:
|
|
25930
|
-
description: An object related to an attachment that is included in the response.
|
|
25931
|
-
oneOf:
|
|
25932
|
-
- $ref: '#/components/schemas/User'
|
|
25933
26099
|
IncidentCreateAttributes:
|
|
25934
26100
|
description: The incident's attributes for a create request.
|
|
25935
26101
|
properties:
|
|
@@ -27200,7 +27366,7 @@ components:
|
|
|
27200
27366
|
description: An object related to an incident that is included in the response.
|
|
27201
27367
|
oneOf:
|
|
27202
27368
|
- $ref: '#/components/schemas/IncidentUserData'
|
|
27203
|
-
- $ref: '#/components/schemas/
|
|
27369
|
+
- $ref: '#/components/schemas/AttachmentData'
|
|
27204
27370
|
IncidentResponseMeta:
|
|
27205
27371
|
description: The metadata object containing pagination metadata.
|
|
27206
27372
|
properties:
|
|
@@ -29776,6 +29942,40 @@ components:
|
|
|
29776
29942
|
- to
|
|
29777
29943
|
- index
|
|
29778
29944
|
type: object
|
|
29945
|
+
JsonPatchOperation:
|
|
29946
|
+
description: A JSON Patch operation as per RFC 6902.
|
|
29947
|
+
properties:
|
|
29948
|
+
op:
|
|
29949
|
+
$ref: '#/components/schemas/JsonPatchOperationOp'
|
|
29950
|
+
path:
|
|
29951
|
+
description: A JSON Pointer path (e.g., "/name", "/value/secure").
|
|
29952
|
+
example: /name
|
|
29953
|
+
type: string
|
|
29954
|
+
value:
|
|
29955
|
+
description: The value to use for the operation (not applicable for "remove"
|
|
29956
|
+
and "test" operations).
|
|
29957
|
+
required:
|
|
29958
|
+
- op
|
|
29959
|
+
- path
|
|
29960
|
+
type: object
|
|
29961
|
+
JsonPatchOperationOp:
|
|
29962
|
+
description: The operation to perform.
|
|
29963
|
+
enum:
|
|
29964
|
+
- add
|
|
29965
|
+
- remove
|
|
29966
|
+
- replace
|
|
29967
|
+
- move
|
|
29968
|
+
- copy
|
|
29969
|
+
- test
|
|
29970
|
+
example: add
|
|
29971
|
+
type: string
|
|
29972
|
+
x-enum-varnames:
|
|
29973
|
+
- ADD
|
|
29974
|
+
- REMOVE
|
|
29975
|
+
- REPLACE
|
|
29976
|
+
- MOVE
|
|
29977
|
+
- COPY
|
|
29978
|
+
- TEST
|
|
29779
29979
|
KindAttributes:
|
|
29780
29980
|
description: Kind attributes.
|
|
29781
29981
|
properties:
|
|
@@ -30599,6 +30799,18 @@ components:
|
|
|
30599
30799
|
$ref: '#/components/schemas/NotificationChannelData'
|
|
30600
30800
|
type: array
|
|
30601
30801
|
type: object
|
|
30802
|
+
ListOnCallNotificationRulesResponse:
|
|
30803
|
+
description: Response type for listing notification rules for a user
|
|
30804
|
+
properties:
|
|
30805
|
+
data:
|
|
30806
|
+
items:
|
|
30807
|
+
$ref: '#/components/schemas/OnCallNotificationRuleData'
|
|
30808
|
+
type: array
|
|
30809
|
+
included:
|
|
30810
|
+
items:
|
|
30811
|
+
$ref: '#/components/schemas/OnCallNotificationRulesIncluded'
|
|
30812
|
+
type: array
|
|
30813
|
+
type: object
|
|
30602
30814
|
ListPipelinesResponse:
|
|
30603
30815
|
description: Represents the response payload containing a list of pipelines
|
|
30604
30816
|
and associated metadata.
|
|
@@ -35144,6 +35356,8 @@ components:
|
|
|
35144
35356
|
description: The `add_env_vars` processor adds environment variable values to
|
|
35145
35357
|
log events.
|
|
35146
35358
|
properties:
|
|
35359
|
+
display_name:
|
|
35360
|
+
$ref: '#/components/schemas/ObservabilityPipelineComponentDisplayName'
|
|
35147
35361
|
enabled:
|
|
35148
35362
|
description: Whether this processor is enabled.
|
|
35149
35363
|
example: true
|
|
@@ -35199,6 +35413,8 @@ components:
|
|
|
35199
35413
|
ObservabilityPipelineAddFieldsProcessor:
|
|
35200
35414
|
description: The `add_fields` processor adds static key-value fields to logs.
|
|
35201
35415
|
properties:
|
|
35416
|
+
display_name:
|
|
35417
|
+
$ref: '#/components/schemas/ObservabilityPipelineComponentDisplayName'
|
|
35202
35418
|
enabled:
|
|
35203
35419
|
description: Whether this processor is enabled.
|
|
35204
35420
|
example: true
|
|
@@ -35515,6 +35731,10 @@ components:
|
|
|
35515
35731
|
role session.
|
|
35516
35732
|
type: string
|
|
35517
35733
|
type: object
|
|
35734
|
+
ObservabilityPipelineComponentDisplayName:
|
|
35735
|
+
description: The display name for a component.
|
|
35736
|
+
example: my component
|
|
35737
|
+
type: string
|
|
35518
35738
|
ObservabilityPipelineConfig:
|
|
35519
35739
|
description: Specifies the pipeline's configuration, including its sources,
|
|
35520
35740
|
processors, and destinations.
|
|
@@ -35605,6 +35825,8 @@ components:
|
|
|
35605
35825
|
include: status:error
|
|
35606
35826
|
type: filter
|
|
35607
35827
|
properties:
|
|
35828
|
+
display_name:
|
|
35829
|
+
$ref: '#/components/schemas/ObservabilityPipelineComponentDisplayName'
|
|
35608
35830
|
enabled:
|
|
35609
35831
|
description: Whether this processor group is enabled.
|
|
35610
35832
|
example: true
|
|
@@ -35768,6 +35990,8 @@ components:
|
|
|
35768
35990
|
Remap Language (VRL)](https://vector.dev/docs/reference/vrl/) scripts with
|
|
35769
35991
|
advanced filtering capabilities.
|
|
35770
35992
|
properties:
|
|
35993
|
+
display_name:
|
|
35994
|
+
$ref: '#/components/schemas/ObservabilityPipelineComponentDisplayName'
|
|
35771
35995
|
enabled:
|
|
35772
35996
|
description: Whether this processor is enabled.
|
|
35773
35997
|
example: true
|
|
@@ -35935,6 +36159,8 @@ components:
|
|
|
35935
36159
|
properties:
|
|
35936
36160
|
action:
|
|
35937
36161
|
$ref: '#/components/schemas/ObservabilityPipelineDatadogTagsProcessorAction'
|
|
36162
|
+
display_name:
|
|
36163
|
+
$ref: '#/components/schemas/ObservabilityPipelineComponentDisplayName'
|
|
35938
36164
|
enabled:
|
|
35939
36165
|
description: Whether this processor is enabled.
|
|
35940
36166
|
example: true
|
|
@@ -36016,6 +36242,8 @@ components:
|
|
|
36016
36242
|
ObservabilityPipelineDedupeProcessor:
|
|
36017
36243
|
description: The `dedupe` processor removes duplicate fields in log events.
|
|
36018
36244
|
properties:
|
|
36245
|
+
display_name:
|
|
36246
|
+
$ref: '#/components/schemas/ObservabilityPipelineComponentDisplayName'
|
|
36019
36247
|
enabled:
|
|
36020
36248
|
description: Whether this processor is enabled.
|
|
36021
36249
|
example: true
|
|
@@ -36253,6 +36481,8 @@ components:
|
|
|
36253
36481
|
description: The `enrichment_table` processor enriches logs using a static CSV
|
|
36254
36482
|
file or GeoIP database.
|
|
36255
36483
|
properties:
|
|
36484
|
+
display_name:
|
|
36485
|
+
$ref: '#/components/schemas/ObservabilityPipelineComponentDisplayName'
|
|
36256
36486
|
enabled:
|
|
36257
36487
|
description: Whether this processor is enabled.
|
|
36258
36488
|
example: true
|
|
@@ -36312,6 +36542,8 @@ components:
|
|
|
36312
36542
|
on a Datadog search query. Logs that match the `include` query are passed
|
|
36313
36543
|
through; others are discarded.
|
|
36314
36544
|
properties:
|
|
36545
|
+
display_name:
|
|
36546
|
+
$ref: '#/components/schemas/ObservabilityPipelineComponentDisplayName'
|
|
36315
36547
|
enabled:
|
|
36316
36548
|
description: Whether this processor is enabled.
|
|
36317
36549
|
example: true
|
|
@@ -36414,6 +36646,8 @@ components:
|
|
|
36414
36646
|
Metrics can be counters, gauges, or distributions and optionally grouped by
|
|
36415
36647
|
log fields.'
|
|
36416
36648
|
properties:
|
|
36649
|
+
display_name:
|
|
36650
|
+
$ref: '#/components/schemas/ObservabilityPipelineComponentDisplayName'
|
|
36417
36651
|
enabled:
|
|
36418
36652
|
description: Whether this processor is enabled.
|
|
36419
36653
|
example: true
|
|
@@ -37035,6 +37269,8 @@ components:
|
|
|
37035
37269
|
description: The `ocsf_mapper` processor transforms logs into the OCSF schema
|
|
37036
37270
|
using a predefined mapping configuration.
|
|
37037
37271
|
properties:
|
|
37272
|
+
display_name:
|
|
37273
|
+
$ref: '#/components/schemas/ObservabilityPipelineComponentDisplayName'
|
|
37038
37274
|
enabled:
|
|
37039
37275
|
description: Whether this processor is enabled.
|
|
37040
37276
|
example: true
|
|
@@ -37166,6 +37402,8 @@ components:
|
|
|
37166
37402
|
by Datadog.
|
|
37167
37403
|
example: true
|
|
37168
37404
|
type: boolean
|
|
37405
|
+
display_name:
|
|
37406
|
+
$ref: '#/components/schemas/ObservabilityPipelineComponentDisplayName'
|
|
37169
37407
|
enabled:
|
|
37170
37408
|
description: Whether this processor is enabled.
|
|
37171
37409
|
example: true
|
|
@@ -37278,6 +37516,8 @@ components:
|
|
|
37278
37516
|
and flattens it into the event. This is useful when logs contain embedded
|
|
37279
37517
|
JSON as a string.
|
|
37280
37518
|
properties:
|
|
37519
|
+
display_name:
|
|
37520
|
+
$ref: '#/components/schemas/ObservabilityPipelineComponentDisplayName'
|
|
37281
37521
|
enabled:
|
|
37282
37522
|
description: Whether this processor is enabled.
|
|
37283
37523
|
example: true
|
|
@@ -37331,6 +37571,8 @@ components:
|
|
|
37331
37571
|
a specified filter. When the configured daily quota is met, the processor
|
|
37332
37572
|
can drop or alert.
|
|
37333
37573
|
properties:
|
|
37574
|
+
display_name:
|
|
37575
|
+
$ref: '#/components/schemas/ObservabilityPipelineComponentDisplayName'
|
|
37334
37576
|
drop_events:
|
|
37335
37577
|
description: If set to `true`, logs that matched the quota filter and sent
|
|
37336
37578
|
after the quota has been met are dropped; only logs that did not match
|
|
@@ -37462,6 +37704,8 @@ components:
|
|
|
37462
37704
|
description: The `reduce` processor aggregates and merges logs based on matching
|
|
37463
37705
|
keys and merge strategies.
|
|
37464
37706
|
properties:
|
|
37707
|
+
display_name:
|
|
37708
|
+
$ref: '#/components/schemas/ObservabilityPipelineComponentDisplayName'
|
|
37465
37709
|
enabled:
|
|
37466
37710
|
description: Whether this processor is enabled.
|
|
37467
37711
|
example: true
|
|
@@ -37554,6 +37798,8 @@ components:
|
|
|
37554
37798
|
ObservabilityPipelineRemoveFieldsProcessor:
|
|
37555
37799
|
description: The `remove_fields` processor deletes specified fields from logs.
|
|
37556
37800
|
properties:
|
|
37801
|
+
display_name:
|
|
37802
|
+
$ref: '#/components/schemas/ObservabilityPipelineComponentDisplayName'
|
|
37557
37803
|
enabled:
|
|
37558
37804
|
description: Whether this processor is enabled.
|
|
37559
37805
|
example: true
|
|
@@ -37598,6 +37844,8 @@ components:
|
|
|
37598
37844
|
ObservabilityPipelineRenameFieldsProcessor:
|
|
37599
37845
|
description: The `rename_fields` processor changes field names.
|
|
37600
37846
|
properties:
|
|
37847
|
+
display_name:
|
|
37848
|
+
$ref: '#/components/schemas/ObservabilityPipelineComponentDisplayName'
|
|
37601
37849
|
enabled:
|
|
37602
37850
|
description: Whether this processor is enabled.
|
|
37603
37851
|
example: true
|
|
@@ -37733,6 +37981,8 @@ components:
|
|
|
37733
37981
|
description: The `sample` processor allows probabilistic sampling of logs at
|
|
37734
37982
|
a fixed rate.
|
|
37735
37983
|
properties:
|
|
37984
|
+
display_name:
|
|
37985
|
+
$ref: '#/components/schemas/ObservabilityPipelineComponentDisplayName'
|
|
37736
37986
|
enabled:
|
|
37737
37987
|
description: Whether this processor is enabled.
|
|
37738
37988
|
example: true
|
|
@@ -37780,6 +38030,8 @@ components:
|
|
|
37780
38030
|
description: The `sensitive_data_scanner` processor detects and optionally redacts
|
|
37781
38031
|
sensitive data in log events.
|
|
37782
38032
|
properties:
|
|
38033
|
+
display_name:
|
|
38034
|
+
$ref: '#/components/schemas/ObservabilityPipelineComponentDisplayName'
|
|
37783
38035
|
enabled:
|
|
37784
38036
|
description: Whether this processor is enabled.
|
|
37785
38037
|
example: true
|
|
@@ -38769,6 +39021,8 @@ components:
|
|
|
38769
39021
|
description: The `throttle` processor limits the number of events that pass
|
|
38770
39022
|
through over a given time window.
|
|
38771
39023
|
properties:
|
|
39024
|
+
display_name:
|
|
39025
|
+
$ref: '#/components/schemas/ObservabilityPipelineComponentDisplayName'
|
|
38772
39026
|
enabled:
|
|
38773
39027
|
description: Whether this processor is enabled.
|
|
38774
39028
|
example: true
|
|
@@ -39053,6 +39307,130 @@ components:
|
|
|
39053
39307
|
required:
|
|
39054
39308
|
- type
|
|
39055
39309
|
type: object
|
|
39310
|
+
OnCallNotificationRule:
|
|
39311
|
+
description: A top-level wrapper for a notification rule
|
|
39312
|
+
example:
|
|
39313
|
+
data:
|
|
39314
|
+
attributes:
|
|
39315
|
+
category: high_urgency
|
|
39316
|
+
channel_settings:
|
|
39317
|
+
method: sms
|
|
39318
|
+
type: phone
|
|
39319
|
+
delay_minutes: 1
|
|
39320
|
+
id: 27590dae-47be-4a7d-9abf-8f4e45124020
|
|
39321
|
+
relationships:
|
|
39322
|
+
channel:
|
|
39323
|
+
data:
|
|
39324
|
+
id: 1562fab3-a8c2-49e2-8f3a-28dcda2405e2
|
|
39325
|
+
type: notification_channels
|
|
39326
|
+
type: notification_rules
|
|
39327
|
+
properties:
|
|
39328
|
+
data:
|
|
39329
|
+
$ref: '#/components/schemas/OnCallNotificationRuleData'
|
|
39330
|
+
included:
|
|
39331
|
+
items:
|
|
39332
|
+
$ref: '#/components/schemas/OnCallNotificationRulesIncluded'
|
|
39333
|
+
type: array
|
|
39334
|
+
required:
|
|
39335
|
+
- data
|
|
39336
|
+
type: object
|
|
39337
|
+
OnCallNotificationRuleAttributes:
|
|
39338
|
+
description: Attributes for an on-call notification rule.
|
|
39339
|
+
properties:
|
|
39340
|
+
category:
|
|
39341
|
+
$ref: '#/components/schemas/OnCallNotificationRuleCategory'
|
|
39342
|
+
channel_settings:
|
|
39343
|
+
$ref: '#/components/schemas/OnCallNotificationRuleChannelSettings'
|
|
39344
|
+
description: Configuration for the associated channel, if necessary
|
|
39345
|
+
nullable: true
|
|
39346
|
+
delay_minutes:
|
|
39347
|
+
description: The number of minutes that will elapse before this rule is
|
|
39348
|
+
evaluated. 0 indicates immediate evaluation
|
|
39349
|
+
format: int64
|
|
39350
|
+
type: integer
|
|
39351
|
+
type: object
|
|
39352
|
+
OnCallNotificationRuleCategory:
|
|
39353
|
+
default: high_urgency
|
|
39354
|
+
description: Specifies the category a notification rule will apply to
|
|
39355
|
+
enum:
|
|
39356
|
+
- high_urgency
|
|
39357
|
+
- low_urgency
|
|
39358
|
+
type: string
|
|
39359
|
+
x-enum-varnames:
|
|
39360
|
+
- HIGH_URGENCY
|
|
39361
|
+
- LOW_URGENCY
|
|
39362
|
+
OnCallNotificationRuleChannelRelationship:
|
|
39363
|
+
description: Relationship object for creating a notification rule
|
|
39364
|
+
properties:
|
|
39365
|
+
data:
|
|
39366
|
+
$ref: '#/components/schemas/OnCallNotificationRuleChannelRelationshipData'
|
|
39367
|
+
required:
|
|
39368
|
+
- data
|
|
39369
|
+
type: object
|
|
39370
|
+
OnCallNotificationRuleChannelRelationshipData:
|
|
39371
|
+
description: Channel relationship data for creating a notification rule
|
|
39372
|
+
properties:
|
|
39373
|
+
id:
|
|
39374
|
+
description: ID of the notification channel
|
|
39375
|
+
type: string
|
|
39376
|
+
type:
|
|
39377
|
+
$ref: '#/components/schemas/NotificationChannelType'
|
|
39378
|
+
type: object
|
|
39379
|
+
OnCallNotificationRuleChannelSettings:
|
|
39380
|
+
description: Defines the configuration for a channel associated with a notification
|
|
39381
|
+
rule
|
|
39382
|
+
oneOf:
|
|
39383
|
+
- $ref: '#/components/schemas/OnCallPhoneNotificationRuleSettings'
|
|
39384
|
+
OnCallNotificationRuleData:
|
|
39385
|
+
description: Data for an on-call notification rule
|
|
39386
|
+
properties:
|
|
39387
|
+
attributes:
|
|
39388
|
+
$ref: '#/components/schemas/OnCallNotificationRuleAttributes'
|
|
39389
|
+
id:
|
|
39390
|
+
description: Unique identifier for the rule
|
|
39391
|
+
type: string
|
|
39392
|
+
relationships:
|
|
39393
|
+
$ref: '#/components/schemas/OnCallNotificationRuleRelationships'
|
|
39394
|
+
type:
|
|
39395
|
+
$ref: '#/components/schemas/OnCallNotificationRuleType'
|
|
39396
|
+
required:
|
|
39397
|
+
- type
|
|
39398
|
+
type: object
|
|
39399
|
+
OnCallNotificationRuleRelationships:
|
|
39400
|
+
description: Relationship object for creating a notification rule
|
|
39401
|
+
properties:
|
|
39402
|
+
channel:
|
|
39403
|
+
$ref: '#/components/schemas/OnCallNotificationRuleChannelRelationship'
|
|
39404
|
+
type: object
|
|
39405
|
+
OnCallNotificationRuleRequestAttributes:
|
|
39406
|
+
description: Attributes for creating or modifying an on-call notification rule.
|
|
39407
|
+
properties:
|
|
39408
|
+
category:
|
|
39409
|
+
$ref: '#/components/schemas/OnCallNotificationRuleCategory'
|
|
39410
|
+
channel_settings:
|
|
39411
|
+
$ref: '#/components/schemas/OnCallNotificationRuleChannelSettings'
|
|
39412
|
+
description: Configuration for the associated channel, if necessary
|
|
39413
|
+
nullable: true
|
|
39414
|
+
delay_minutes:
|
|
39415
|
+
description: The number of minutes that will elapse before this rule is
|
|
39416
|
+
evaluated. 0 indicates immediate evaluation
|
|
39417
|
+
format: int64
|
|
39418
|
+
type: integer
|
|
39419
|
+
type: object
|
|
39420
|
+
OnCallNotificationRuleType:
|
|
39421
|
+
default: notification_rules
|
|
39422
|
+
description: Indicates that the resource is of type 'notification_rules'.
|
|
39423
|
+
enum:
|
|
39424
|
+
- notification_rules
|
|
39425
|
+
example: notification_rules
|
|
39426
|
+
type: string
|
|
39427
|
+
x-enum-varnames:
|
|
39428
|
+
- NOTIFICATION_RULES
|
|
39429
|
+
OnCallNotificationRulesIncluded:
|
|
39430
|
+
description: Represents additional included resources for a on-call notification
|
|
39431
|
+
rules
|
|
39432
|
+
oneOf:
|
|
39433
|
+
- $ref: '#/components/schemas/NotificationChannelData'
|
|
39056
39434
|
OnCallPageTargetType:
|
|
39057
39435
|
description: The kind of target, `team_id` | `team_handle` | `user_id`.
|
|
39058
39436
|
enum:
|
|
@@ -39065,6 +39443,29 @@ components:
|
|
|
39065
39443
|
- TEAM_ID
|
|
39066
39444
|
- TEAM_HANDLE
|
|
39067
39445
|
- USER_ID
|
|
39446
|
+
OnCallPhoneNotificationRuleMethod:
|
|
39447
|
+
description: Specifies the method in which a phone is used in a notification
|
|
39448
|
+
rule
|
|
39449
|
+
enum:
|
|
39450
|
+
- sms
|
|
39451
|
+
- voice
|
|
39452
|
+
example: sms
|
|
39453
|
+
type: string
|
|
39454
|
+
x-enum-varnames:
|
|
39455
|
+
- SMS
|
|
39456
|
+
- VOICE
|
|
39457
|
+
OnCallPhoneNotificationRuleSettings:
|
|
39458
|
+
description: Configuration for using a phone notification channel in a notification
|
|
39459
|
+
rule
|
|
39460
|
+
properties:
|
|
39461
|
+
method:
|
|
39462
|
+
$ref: '#/components/schemas/OnCallPhoneNotificationRuleMethod'
|
|
39463
|
+
type:
|
|
39464
|
+
$ref: '#/components/schemas/NotificationChannelPhoneConfigType'
|
|
39465
|
+
required:
|
|
39466
|
+
- type
|
|
39467
|
+
- method
|
|
39468
|
+
type: object
|
|
39068
39469
|
OnDemandConcurrencyCap:
|
|
39069
39470
|
description: On-demand concurrency cap.
|
|
39070
39471
|
properties:
|
|
@@ -40161,6 +40562,41 @@ components:
|
|
|
40161
40562
|
$ref: '#/components/schemas/ApplicationKeyResponseIncludedItem'
|
|
40162
40563
|
type: array
|
|
40163
40564
|
type: object
|
|
40565
|
+
PatchAttachmentRequest:
|
|
40566
|
+
example:
|
|
40567
|
+
data:
|
|
40568
|
+
attributes:
|
|
40569
|
+
attachment:
|
|
40570
|
+
documentUrl: https://app.datadoghq.com/notebook/124/Postmortem-IR-124
|
|
40571
|
+
title: Postmortem-IR-124
|
|
40572
|
+
type: incident_attachments
|
|
40573
|
+
properties:
|
|
40574
|
+
data:
|
|
40575
|
+
$ref: '#/components/schemas/PatchAttachmentRequestData'
|
|
40576
|
+
type: object
|
|
40577
|
+
PatchAttachmentRequestData:
|
|
40578
|
+
properties:
|
|
40579
|
+
attributes:
|
|
40580
|
+
$ref: '#/components/schemas/PatchAttachmentRequestDataAttributes'
|
|
40581
|
+
id:
|
|
40582
|
+
type: string
|
|
40583
|
+
type:
|
|
40584
|
+
$ref: '#/components/schemas/IncidentAttachmentType'
|
|
40585
|
+
required:
|
|
40586
|
+
- type
|
|
40587
|
+
type: object
|
|
40588
|
+
PatchAttachmentRequestDataAttributes:
|
|
40589
|
+
properties:
|
|
40590
|
+
attachment:
|
|
40591
|
+
$ref: '#/components/schemas/PatchAttachmentRequestDataAttributesAttachment'
|
|
40592
|
+
type: object
|
|
40593
|
+
PatchAttachmentRequestDataAttributesAttachment:
|
|
40594
|
+
properties:
|
|
40595
|
+
documentUrl:
|
|
40596
|
+
type: string
|
|
40597
|
+
title:
|
|
40598
|
+
type: string
|
|
40599
|
+
type: object
|
|
40164
40600
|
PatchIncidentNotificationTemplateRequest:
|
|
40165
40601
|
description: Update request for a notification template.
|
|
40166
40602
|
properties:
|
|
@@ -40900,6 +41336,114 @@ components:
|
|
|
40900
41336
|
type: string
|
|
40901
41337
|
x-enum-varnames:
|
|
40902
41338
|
- PROCESS
|
|
41339
|
+
ProductAnalyticsServerSideEventError:
|
|
41340
|
+
description: Error details.
|
|
41341
|
+
properties:
|
|
41342
|
+
detail:
|
|
41343
|
+
description: Error message.
|
|
41344
|
+
example: Malformed payload
|
|
41345
|
+
type: string
|
|
41346
|
+
status:
|
|
41347
|
+
description: Error code.
|
|
41348
|
+
example: '400'
|
|
41349
|
+
type: string
|
|
41350
|
+
title:
|
|
41351
|
+
description: Error title.
|
|
41352
|
+
example: Bad Request
|
|
41353
|
+
type: string
|
|
41354
|
+
type: object
|
|
41355
|
+
ProductAnalyticsServerSideEventErrors:
|
|
41356
|
+
description: Error response.
|
|
41357
|
+
properties:
|
|
41358
|
+
errors:
|
|
41359
|
+
description: Structured errors.
|
|
41360
|
+
items:
|
|
41361
|
+
$ref: '#/components/schemas/ProductAnalyticsServerSideEventError'
|
|
41362
|
+
type: array
|
|
41363
|
+
type: object
|
|
41364
|
+
ProductAnalyticsServerSideEventItem:
|
|
41365
|
+
description: A Product Analytics server-side event.
|
|
41366
|
+
properties:
|
|
41367
|
+
account:
|
|
41368
|
+
$ref: '#/components/schemas/ProductAnalyticsServerSideEventItemAccount'
|
|
41369
|
+
application:
|
|
41370
|
+
$ref: '#/components/schemas/ProductAnalyticsServerSideEventItemApplication'
|
|
41371
|
+
event:
|
|
41372
|
+
$ref: '#/components/schemas/ProductAnalyticsServerSideEventItemEvent'
|
|
41373
|
+
session:
|
|
41374
|
+
$ref: '#/components/schemas/ProductAnalyticsServerSideEventItemSession'
|
|
41375
|
+
type:
|
|
41376
|
+
$ref: '#/components/schemas/ProductAnalyticsServerSideEventItemType'
|
|
41377
|
+
usr:
|
|
41378
|
+
$ref: '#/components/schemas/ProductAnalyticsServerSideEventItemUsr'
|
|
41379
|
+
required:
|
|
41380
|
+
- application
|
|
41381
|
+
- event
|
|
41382
|
+
- type
|
|
41383
|
+
type: object
|
|
41384
|
+
ProductAnalyticsServerSideEventItemAccount:
|
|
41385
|
+
description: The account linked to your event.
|
|
41386
|
+
properties:
|
|
41387
|
+
id:
|
|
41388
|
+
description: The account ID used in Datadog.
|
|
41389
|
+
example: account-67890
|
|
41390
|
+
type: string
|
|
41391
|
+
required:
|
|
41392
|
+
- id
|
|
41393
|
+
type: object
|
|
41394
|
+
ProductAnalyticsServerSideEventItemApplication:
|
|
41395
|
+
description: The application in which you want to send your events.
|
|
41396
|
+
properties:
|
|
41397
|
+
id:
|
|
41398
|
+
description: 'The application ID of your application. It can be found in
|
|
41399
|
+
your
|
|
41400
|
+
|
|
41401
|
+
[application management page](https://app.datadoghq.com/rum/list).'
|
|
41402
|
+
example: 123abcde-123a-123b-1234-123456789abc
|
|
41403
|
+
type: string
|
|
41404
|
+
required:
|
|
41405
|
+
- id
|
|
41406
|
+
type: object
|
|
41407
|
+
ProductAnalyticsServerSideEventItemEvent:
|
|
41408
|
+
description: Fields used for the event.
|
|
41409
|
+
properties:
|
|
41410
|
+
name:
|
|
41411
|
+
description: The name of your event, which is used for search in the same
|
|
41412
|
+
way as view or action names.
|
|
41413
|
+
example: payment.processed
|
|
41414
|
+
type: string
|
|
41415
|
+
required:
|
|
41416
|
+
- name
|
|
41417
|
+
type: object
|
|
41418
|
+
ProductAnalyticsServerSideEventItemSession:
|
|
41419
|
+
description: The session linked to your event.
|
|
41420
|
+
properties:
|
|
41421
|
+
id:
|
|
41422
|
+
description: The session ID captured by the SDK.
|
|
41423
|
+
example: session-abcdef
|
|
41424
|
+
type: string
|
|
41425
|
+
required:
|
|
41426
|
+
- id
|
|
41427
|
+
type: object
|
|
41428
|
+
ProductAnalyticsServerSideEventItemType:
|
|
41429
|
+
description: The type of Product Analytics event. Must be `server` for server-side
|
|
41430
|
+
events.
|
|
41431
|
+
enum:
|
|
41432
|
+
- server
|
|
41433
|
+
example: server
|
|
41434
|
+
type: string
|
|
41435
|
+
x-enum-varnames:
|
|
41436
|
+
- SERVER
|
|
41437
|
+
ProductAnalyticsServerSideEventItemUsr:
|
|
41438
|
+
description: The user linked to your event.
|
|
41439
|
+
properties:
|
|
41440
|
+
id:
|
|
41441
|
+
description: The user ID used in Datadog.
|
|
41442
|
+
example: user-12345
|
|
41443
|
+
type: string
|
|
41444
|
+
required:
|
|
41445
|
+
- id
|
|
41446
|
+
type: object
|
|
40903
41447
|
Project:
|
|
40904
41448
|
description: A Project
|
|
40905
41449
|
properties:
|
|
@@ -47320,6 +47864,86 @@ components:
|
|
|
47320
47864
|
description: The name of the reference table.
|
|
47321
47865
|
type: string
|
|
47322
47866
|
type: object
|
|
47867
|
+
SecurityMonitoringRuleAnomalyDetectionOptions:
|
|
47868
|
+
additionalProperties: {}
|
|
47869
|
+
description: Options on anomaly detection method.
|
|
47870
|
+
properties:
|
|
47871
|
+
bucketDuration:
|
|
47872
|
+
$ref: '#/components/schemas/SecurityMonitoringRuleAnomalyDetectionOptionsBucketDuration'
|
|
47873
|
+
detectionTolerance:
|
|
47874
|
+
$ref: '#/components/schemas/SecurityMonitoringRuleAnomalyDetectionOptionsDetectionTolerance'
|
|
47875
|
+
learningDuration:
|
|
47876
|
+
$ref: '#/components/schemas/SecurityMonitoringRuleAnomalyDetectionOptionsLearningDuration'
|
|
47877
|
+
learningPeriodBaseline:
|
|
47878
|
+
description: An optional override baseline to apply while the rule is in
|
|
47879
|
+
the learning period. Must be greater than or equal to 0.
|
|
47880
|
+
format: int64
|
|
47881
|
+
minimum: 0
|
|
47882
|
+
type: integer
|
|
47883
|
+
type: object
|
|
47884
|
+
SecurityMonitoringRuleAnomalyDetectionOptionsBucketDuration:
|
|
47885
|
+
description: 'Duration in seconds of the time buckets used to aggregate events
|
|
47886
|
+
matched by the rule.
|
|
47887
|
+
|
|
47888
|
+
Must be greater than or equal to 300.'
|
|
47889
|
+
enum:
|
|
47890
|
+
- 300
|
|
47891
|
+
- 600
|
|
47892
|
+
- 900
|
|
47893
|
+
- 1800
|
|
47894
|
+
- 3600
|
|
47895
|
+
- 10800
|
|
47896
|
+
example: 300
|
|
47897
|
+
format: int32
|
|
47898
|
+
type: integer
|
|
47899
|
+
x-enum-varnames:
|
|
47900
|
+
- FIVE_MINUTES
|
|
47901
|
+
- TEN_MINUTES
|
|
47902
|
+
- FIFTEEN_MINUTES
|
|
47903
|
+
- THIRTY_MINUTES
|
|
47904
|
+
- ONE_HOUR
|
|
47905
|
+
- THREE_HOURS
|
|
47906
|
+
SecurityMonitoringRuleAnomalyDetectionOptionsDetectionTolerance:
|
|
47907
|
+
description: 'An optional parameter that sets how permissive anomaly detection
|
|
47908
|
+
is.
|
|
47909
|
+
|
|
47910
|
+
Higher values require higher deviations before triggering a signal.'
|
|
47911
|
+
enum:
|
|
47912
|
+
- 1
|
|
47913
|
+
- 2
|
|
47914
|
+
- 3
|
|
47915
|
+
- 4
|
|
47916
|
+
- 5
|
|
47917
|
+
example: 5
|
|
47918
|
+
format: int32
|
|
47919
|
+
type: integer
|
|
47920
|
+
x-enum-varnames:
|
|
47921
|
+
- ONE
|
|
47922
|
+
- TWO
|
|
47923
|
+
- THREE
|
|
47924
|
+
- FOUR
|
|
47925
|
+
- FIVE
|
|
47926
|
+
SecurityMonitoringRuleAnomalyDetectionOptionsLearningDuration:
|
|
47927
|
+
description: Learning duration in hours. Anomaly detection waits for at least
|
|
47928
|
+
this amount of historical data before it starts evaluating.
|
|
47929
|
+
enum:
|
|
47930
|
+
- 1
|
|
47931
|
+
- 6
|
|
47932
|
+
- 12
|
|
47933
|
+
- 24
|
|
47934
|
+
- 48
|
|
47935
|
+
- 168
|
|
47936
|
+
- 336
|
|
47937
|
+
format: int32
|
|
47938
|
+
type: integer
|
|
47939
|
+
x-enum-varnames:
|
|
47940
|
+
- ONE_HOUR
|
|
47941
|
+
- SIX_HOURS
|
|
47942
|
+
- TWELVE_HOURS
|
|
47943
|
+
- ONE_DAY
|
|
47944
|
+
- TWO_DAYS
|
|
47945
|
+
- ONE_WEEK
|
|
47946
|
+
- TWO_WEEKS
|
|
47323
47947
|
SecurityMonitoringRuleCase:
|
|
47324
47948
|
description: Case when signal is generated.
|
|
47325
47949
|
properties:
|
|
@@ -47685,6 +48309,8 @@ components:
|
|
|
47685
48309
|
SecurityMonitoringRuleOptions:
|
|
47686
48310
|
description: Options.
|
|
47687
48311
|
properties:
|
|
48312
|
+
anomalyDetectionOptions:
|
|
48313
|
+
$ref: '#/components/schemas/SecurityMonitoringRuleAnomalyDetectionOptions'
|
|
47688
48314
|
complianceRuleOptions:
|
|
47689
48315
|
$ref: '#/components/schemas/CloudConfigurationComplianceRuleOptions'
|
|
47690
48316
|
decreaseCriticalityBasedOnEnv:
|
|
@@ -53172,6 +53798,178 @@ components:
|
|
|
53172
53798
|
suppression:
|
|
53173
53799
|
$ref: '#/components/schemas/SecurityMonitoringSuppressionAttributes'
|
|
53174
53800
|
type: object
|
|
53801
|
+
SyntheticsGlobalVariable:
|
|
53802
|
+
description: Synthetic global variable.
|
|
53803
|
+
properties:
|
|
53804
|
+
attributes:
|
|
53805
|
+
$ref: '#/components/schemas/SyntheticsGlobalVariableAttributes'
|
|
53806
|
+
description:
|
|
53807
|
+
description: Description of the global variable.
|
|
53808
|
+
example: Example description
|
|
53809
|
+
type: string
|
|
53810
|
+
id:
|
|
53811
|
+
description: Unique identifier of the global variable.
|
|
53812
|
+
readOnly: true
|
|
53813
|
+
type: string
|
|
53814
|
+
is_fido:
|
|
53815
|
+
description: Determines if the global variable is a FIDO variable.
|
|
53816
|
+
type: boolean
|
|
53817
|
+
is_totp:
|
|
53818
|
+
description: Determines if the global variable is a TOTP/MFA variable.
|
|
53819
|
+
type: boolean
|
|
53820
|
+
name:
|
|
53821
|
+
description: Name of the global variable. Unique across Synthetic global
|
|
53822
|
+
variables.
|
|
53823
|
+
example: MY_VARIABLE
|
|
53824
|
+
type: string
|
|
53825
|
+
parse_test_options:
|
|
53826
|
+
$ref: '#/components/schemas/SyntheticsGlobalVariableParseTestOptions'
|
|
53827
|
+
parse_test_public_id:
|
|
53828
|
+
description: A Synthetic test ID to use as a test to generate the variable
|
|
53829
|
+
value.
|
|
53830
|
+
example: abc-def-123
|
|
53831
|
+
type: string
|
|
53832
|
+
tags:
|
|
53833
|
+
description: Tags of the global variable.
|
|
53834
|
+
example:
|
|
53835
|
+
- team:front
|
|
53836
|
+
- test:workflow-1
|
|
53837
|
+
items:
|
|
53838
|
+
description: Tag name.
|
|
53839
|
+
type: string
|
|
53840
|
+
type: array
|
|
53841
|
+
value:
|
|
53842
|
+
$ref: '#/components/schemas/SyntheticsGlobalVariableValue'
|
|
53843
|
+
required:
|
|
53844
|
+
- description
|
|
53845
|
+
- name
|
|
53846
|
+
- tags
|
|
53847
|
+
- value
|
|
53848
|
+
type: object
|
|
53849
|
+
SyntheticsGlobalVariableAttributes:
|
|
53850
|
+
description: Attributes of the global variable.
|
|
53851
|
+
properties:
|
|
53852
|
+
restricted_roles:
|
|
53853
|
+
$ref: '#/components/schemas/SyntheticsRestrictedRoles'
|
|
53854
|
+
type: object
|
|
53855
|
+
SyntheticsGlobalVariableOptions:
|
|
53856
|
+
description: Options for the Global Variable for MFA.
|
|
53857
|
+
properties:
|
|
53858
|
+
totp_parameters:
|
|
53859
|
+
$ref: '#/components/schemas/SyntheticsGlobalVariableTOTPParameters'
|
|
53860
|
+
type: object
|
|
53861
|
+
SyntheticsGlobalVariableParseTestOptions:
|
|
53862
|
+
description: Parser options to use for retrieving a Synthetic global variable
|
|
53863
|
+
from a Synthetic test. Used in conjunction with `parse_test_public_id`.
|
|
53864
|
+
properties:
|
|
53865
|
+
field:
|
|
53866
|
+
description: When type is `http_header`, name of the header to use to extract
|
|
53867
|
+
the value.
|
|
53868
|
+
example: content-type
|
|
53869
|
+
type: string
|
|
53870
|
+
localVariableName:
|
|
53871
|
+
description: When type is `local_variable`, name of the local variable to
|
|
53872
|
+
use to extract the value.
|
|
53873
|
+
example: LOCAL_VARIABLE
|
|
53874
|
+
type: string
|
|
53875
|
+
parser:
|
|
53876
|
+
$ref: '#/components/schemas/SyntheticsVariableParser'
|
|
53877
|
+
type:
|
|
53878
|
+
$ref: '#/components/schemas/SyntheticsGlobalVariableParseTestOptionsType'
|
|
53879
|
+
required:
|
|
53880
|
+
- type
|
|
53881
|
+
type: object
|
|
53882
|
+
SyntheticsGlobalVariableParseTestOptionsType:
|
|
53883
|
+
description: Type of value to extract from a test for a Synthetic global variable.
|
|
53884
|
+
enum:
|
|
53885
|
+
- http_body
|
|
53886
|
+
- http_header
|
|
53887
|
+
- http_status_code
|
|
53888
|
+
- local_variable
|
|
53889
|
+
example: http_body
|
|
53890
|
+
type: string
|
|
53891
|
+
x-enum-varnames:
|
|
53892
|
+
- HTTP_BODY
|
|
53893
|
+
- HTTP_HEADER
|
|
53894
|
+
- HTTP_STATUS_CODE
|
|
53895
|
+
- LOCAL_VARIABLE
|
|
53896
|
+
SyntheticsGlobalVariableParserType:
|
|
53897
|
+
description: Type of parser for a Synthetic global variable from a synthetics
|
|
53898
|
+
test.
|
|
53899
|
+
enum:
|
|
53900
|
+
- raw
|
|
53901
|
+
- json_path
|
|
53902
|
+
- regex
|
|
53903
|
+
- x_path
|
|
53904
|
+
example: raw
|
|
53905
|
+
type: string
|
|
53906
|
+
x-enum-varnames:
|
|
53907
|
+
- RAW
|
|
53908
|
+
- JSON_PATH
|
|
53909
|
+
- REGEX
|
|
53910
|
+
- X_PATH
|
|
53911
|
+
SyntheticsGlobalVariableTOTPParameters:
|
|
53912
|
+
description: Parameters for the TOTP/MFA variable
|
|
53913
|
+
properties:
|
|
53914
|
+
digits:
|
|
53915
|
+
description: Number of digits for the OTP code.
|
|
53916
|
+
example: 6
|
|
53917
|
+
format: int32
|
|
53918
|
+
maximum: 10
|
|
53919
|
+
minimum: 4
|
|
53920
|
+
type: integer
|
|
53921
|
+
refresh_interval:
|
|
53922
|
+
description: Interval for which to refresh the token (in seconds).
|
|
53923
|
+
example: 30
|
|
53924
|
+
format: int32
|
|
53925
|
+
maximum: 999
|
|
53926
|
+
minimum: 0
|
|
53927
|
+
type: integer
|
|
53928
|
+
type: object
|
|
53929
|
+
SyntheticsGlobalVariableValue:
|
|
53930
|
+
description: Value of the global variable.
|
|
53931
|
+
example:
|
|
53932
|
+
secure: true
|
|
53933
|
+
value: value
|
|
53934
|
+
properties:
|
|
53935
|
+
options:
|
|
53936
|
+
$ref: '#/components/schemas/SyntheticsGlobalVariableOptions'
|
|
53937
|
+
secure:
|
|
53938
|
+
description: Determines if the value of the variable is hidden.
|
|
53939
|
+
type: boolean
|
|
53940
|
+
value:
|
|
53941
|
+
description: 'Value of the global variable. When reading a global variable,
|
|
53942
|
+
|
|
53943
|
+
the value will not be present if the variable is hidden with the `secure`
|
|
53944
|
+
property.'
|
|
53945
|
+
example: example-value
|
|
53946
|
+
type: string
|
|
53947
|
+
type: object
|
|
53948
|
+
SyntheticsRestrictedRoles:
|
|
53949
|
+
description: A list of role identifiers that can be pulled from the Roles API,
|
|
53950
|
+
for restricting read and write access.
|
|
53951
|
+
example:
|
|
53952
|
+
- xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
|
|
53953
|
+
items:
|
|
53954
|
+
description: UUID for a role.
|
|
53955
|
+
example: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
|
|
53956
|
+
type: string
|
|
53957
|
+
type: array
|
|
53958
|
+
SyntheticsVariableParser:
|
|
53959
|
+
description: Details of the parser to use for the global variable.
|
|
53960
|
+
example:
|
|
53961
|
+
type: regex
|
|
53962
|
+
value: .*
|
|
53963
|
+
properties:
|
|
53964
|
+
type:
|
|
53965
|
+
$ref: '#/components/schemas/SyntheticsGlobalVariableParserType'
|
|
53966
|
+
value:
|
|
53967
|
+
description: Regex or JSON path used for the parser. Not used with type
|
|
53968
|
+
`raw`.
|
|
53969
|
+
type: string
|
|
53970
|
+
required:
|
|
53971
|
+
- type
|
|
53972
|
+
type: object
|
|
53175
53973
|
TableResultV2:
|
|
53176
53974
|
description: A reference table resource containing its full configuration and
|
|
53177
53975
|
state.
|
|
@@ -54166,6 +54964,143 @@ components:
|
|
|
54166
54964
|
$ref: '#/components/schemas/TeamLink'
|
|
54167
54965
|
type: array
|
|
54168
54966
|
type: object
|
|
54967
|
+
TeamNotificationRule:
|
|
54968
|
+
description: Team notification rule
|
|
54969
|
+
properties:
|
|
54970
|
+
attributes:
|
|
54971
|
+
$ref: '#/components/schemas/TeamNotificationRuleAttributes'
|
|
54972
|
+
id:
|
|
54973
|
+
description: The identifier of the team notification rule
|
|
54974
|
+
example: b8626d7e-cedd-11eb-abf5-da7ad0900001
|
|
54975
|
+
type: string
|
|
54976
|
+
type:
|
|
54977
|
+
$ref: '#/components/schemas/TeamNotificationRuleType'
|
|
54978
|
+
required:
|
|
54979
|
+
- attributes
|
|
54980
|
+
- type
|
|
54981
|
+
type: object
|
|
54982
|
+
TeamNotificationRuleAttributes:
|
|
54983
|
+
description: Team notification rule attributes
|
|
54984
|
+
properties:
|
|
54985
|
+
email:
|
|
54986
|
+
$ref: '#/components/schemas/TeamNotificationRuleAttributesEmail'
|
|
54987
|
+
ms_teams:
|
|
54988
|
+
$ref: '#/components/schemas/TeamNotificationRuleAttributesMsTeams'
|
|
54989
|
+
pagerduty:
|
|
54990
|
+
$ref: '#/components/schemas/TeamNotificationRuleAttributesPagerduty'
|
|
54991
|
+
slack:
|
|
54992
|
+
$ref: '#/components/schemas/TeamNotificationRuleAttributesSlack'
|
|
54993
|
+
type: object
|
|
54994
|
+
TeamNotificationRuleAttributesEmail:
|
|
54995
|
+
description: Email notification settings for the team
|
|
54996
|
+
properties:
|
|
54997
|
+
enabled:
|
|
54998
|
+
description: Flag indicating email notification
|
|
54999
|
+
type: boolean
|
|
55000
|
+
type: object
|
|
55001
|
+
TeamNotificationRuleAttributesMsTeams:
|
|
55002
|
+
description: MS Teams notification settings for the team
|
|
55003
|
+
properties:
|
|
55004
|
+
connector_name:
|
|
55005
|
+
description: Handle for MS Teams
|
|
55006
|
+
type: string
|
|
55007
|
+
type: object
|
|
55008
|
+
TeamNotificationRuleAttributesPagerduty:
|
|
55009
|
+
description: PagerDuty notification settings for the team
|
|
55010
|
+
properties:
|
|
55011
|
+
service_name:
|
|
55012
|
+
description: Service name for PagerDuty
|
|
55013
|
+
type: string
|
|
55014
|
+
type: object
|
|
55015
|
+
TeamNotificationRuleAttributesSlack:
|
|
55016
|
+
description: Slack notification settings for the team
|
|
55017
|
+
properties:
|
|
55018
|
+
channel:
|
|
55019
|
+
description: Channel for Slack notification
|
|
55020
|
+
type: string
|
|
55021
|
+
workspace:
|
|
55022
|
+
description: Workspace for Slack notification
|
|
55023
|
+
type: string
|
|
55024
|
+
type: object
|
|
55025
|
+
TeamNotificationRuleRequest:
|
|
55026
|
+
description: Request to create or update a team notification rule
|
|
55027
|
+
properties:
|
|
55028
|
+
data:
|
|
55029
|
+
$ref: '#/components/schemas/TeamNotificationRule'
|
|
55030
|
+
required:
|
|
55031
|
+
- data
|
|
55032
|
+
type: object
|
|
55033
|
+
TeamNotificationRuleResponse:
|
|
55034
|
+
description: Team notification rule response
|
|
55035
|
+
properties:
|
|
55036
|
+
data:
|
|
55037
|
+
$ref: '#/components/schemas/TeamNotificationRule'
|
|
55038
|
+
type: object
|
|
55039
|
+
TeamNotificationRuleType:
|
|
55040
|
+
default: team_notification_rules
|
|
55041
|
+
description: Team notification rule type
|
|
55042
|
+
enum:
|
|
55043
|
+
- team_notification_rules
|
|
55044
|
+
example: team_notification_rules
|
|
55045
|
+
type: string
|
|
55046
|
+
x-enum-varnames:
|
|
55047
|
+
- TEAM_NOTIFICATION_RULES
|
|
55048
|
+
TeamNotificationRulesResponse:
|
|
55049
|
+
description: Team notification rules response
|
|
55050
|
+
properties:
|
|
55051
|
+
data:
|
|
55052
|
+
description: Team notification rules response data
|
|
55053
|
+
items:
|
|
55054
|
+
$ref: '#/components/schemas/TeamNotificationRule'
|
|
55055
|
+
type: array
|
|
55056
|
+
meta:
|
|
55057
|
+
$ref: '#/components/schemas/TeamNotificationRulesResponseMeta'
|
|
55058
|
+
type: object
|
|
55059
|
+
TeamNotificationRulesResponseMeta:
|
|
55060
|
+
description: Metadata that is included in the response when querying the team
|
|
55061
|
+
notification rules
|
|
55062
|
+
properties:
|
|
55063
|
+
page:
|
|
55064
|
+
$ref: '#/components/schemas/TeamNotificationRulesResponseMetaPage'
|
|
55065
|
+
type: object
|
|
55066
|
+
TeamNotificationRulesResponseMetaPage:
|
|
55067
|
+
description: Metadata related to paging information that is included in the
|
|
55068
|
+
response when querying the team notification rules
|
|
55069
|
+
properties:
|
|
55070
|
+
first_offset:
|
|
55071
|
+
description: The first offset.
|
|
55072
|
+
format: int64
|
|
55073
|
+
type: integer
|
|
55074
|
+
last_offset:
|
|
55075
|
+
description: The last offset.
|
|
55076
|
+
format: int64
|
|
55077
|
+
type: integer
|
|
55078
|
+
limit:
|
|
55079
|
+
description: Pagination limit.
|
|
55080
|
+
format: int64
|
|
55081
|
+
type: integer
|
|
55082
|
+
next_offset:
|
|
55083
|
+
description: The next offset.
|
|
55084
|
+
format: int64
|
|
55085
|
+
nullable: true
|
|
55086
|
+
type: integer
|
|
55087
|
+
offset:
|
|
55088
|
+
description: The offset.
|
|
55089
|
+
format: int64
|
|
55090
|
+
type: integer
|
|
55091
|
+
prev_offset:
|
|
55092
|
+
description: The previous offset.
|
|
55093
|
+
format: int64
|
|
55094
|
+
nullable: true
|
|
55095
|
+
type: integer
|
|
55096
|
+
total:
|
|
55097
|
+
description: Total results.
|
|
55098
|
+
format: int64
|
|
55099
|
+
type: integer
|
|
55100
|
+
type:
|
|
55101
|
+
description: Offset type.
|
|
55102
|
+
type: string
|
|
55103
|
+
type: object
|
|
54169
55104
|
TeamOnCallResponders:
|
|
54170
55105
|
description: Root object representing a team's on-call responder configuration.
|
|
54171
55106
|
example:
|
|
@@ -55124,6 +56059,8 @@ components:
|
|
|
55124
56059
|
ThreatHuntingJobOptions:
|
|
55125
56060
|
description: Job options.
|
|
55126
56061
|
properties:
|
|
56062
|
+
anomalyDetectionOptions:
|
|
56063
|
+
$ref: '#/components/schemas/SecurityMonitoringRuleAnomalyDetectionOptions'
|
|
55127
56064
|
detectionMethod:
|
|
55128
56065
|
$ref: '#/components/schemas/SecurityMonitoringRuleDetectionMethod'
|
|
55129
56066
|
evaluationWindow:
|
|
@@ -56220,6 +57157,59 @@ components:
|
|
|
56220
57157
|
- name
|
|
56221
57158
|
- options
|
|
56222
57159
|
type: object
|
|
57160
|
+
UpdateOnCallNotificationRuleRequest:
|
|
57161
|
+
description: A top-level wrapper for updating a notification rule for a user
|
|
57162
|
+
example:
|
|
57163
|
+
data:
|
|
57164
|
+
attributes:
|
|
57165
|
+
category: high_urgency
|
|
57166
|
+
channel_settings:
|
|
57167
|
+
method: sms
|
|
57168
|
+
type: phone
|
|
57169
|
+
delay_minutes: 1
|
|
57170
|
+
id: 2462ace1-49e2-aab1-xc4f-29cc4ae1105n7
|
|
57171
|
+
relationships:
|
|
57172
|
+
channel:
|
|
57173
|
+
data:
|
|
57174
|
+
id: 1562fab3-a8c2-49e2-8f3a-28dcda2405e2
|
|
57175
|
+
type: notification_channels
|
|
57176
|
+
type: notification_rules
|
|
57177
|
+
properties:
|
|
57178
|
+
data:
|
|
57179
|
+
$ref: '#/components/schemas/UpdateOnCallNotificationRuleRequestData'
|
|
57180
|
+
required:
|
|
57181
|
+
- data
|
|
57182
|
+
type: object
|
|
57183
|
+
UpdateOnCallNotificationRuleRequestAttributes:
|
|
57184
|
+
description: Attributes for creating or modifying an on-call notification rule.
|
|
57185
|
+
properties:
|
|
57186
|
+
category:
|
|
57187
|
+
$ref: '#/components/schemas/OnCallNotificationRuleCategory'
|
|
57188
|
+
channel_settings:
|
|
57189
|
+
$ref: '#/components/schemas/OnCallNotificationRuleChannelSettings'
|
|
57190
|
+
description: Configuration for the associated channel, if necessary
|
|
57191
|
+
nullable: true
|
|
57192
|
+
delay_minutes:
|
|
57193
|
+
description: The number of minutes that will elapse before this rule is
|
|
57194
|
+
evaluated. 0 indicates immediate evaluation
|
|
57195
|
+
format: int64
|
|
57196
|
+
type: integer
|
|
57197
|
+
type: object
|
|
57198
|
+
UpdateOnCallNotificationRuleRequestData:
|
|
57199
|
+
description: Data for updating an on-call notification rule
|
|
57200
|
+
properties:
|
|
57201
|
+
attributes:
|
|
57202
|
+
$ref: '#/components/schemas/UpdateOnCallNotificationRuleRequestAttributes'
|
|
57203
|
+
id:
|
|
57204
|
+
description: Unique identifier for the rule
|
|
57205
|
+
type: string
|
|
57206
|
+
relationships:
|
|
57207
|
+
$ref: '#/components/schemas/OnCallNotificationRuleRelationships'
|
|
57208
|
+
type:
|
|
57209
|
+
$ref: '#/components/schemas/OnCallNotificationRuleType'
|
|
57210
|
+
required:
|
|
57211
|
+
- type
|
|
57212
|
+
type: object
|
|
56223
57213
|
UpdateOpenAPIResponse:
|
|
56224
57214
|
description: Response for `UpdateOpenAPI`.
|
|
56225
57215
|
properties:
|
|
@@ -56858,6 +57848,17 @@ components:
|
|
|
56858
57848
|
type:
|
|
56859
57849
|
$ref: '#/components/schemas/UsersType'
|
|
56860
57850
|
type: object
|
|
57851
|
+
User140420082644000:
|
|
57852
|
+
properties:
|
|
57853
|
+
attributes:
|
|
57854
|
+
$ref: '#/components/schemas/UserAttributes'
|
|
57855
|
+
id:
|
|
57856
|
+
type: string
|
|
57857
|
+
type:
|
|
57858
|
+
$ref: '#/components/schemas/UserType'
|
|
57859
|
+
required:
|
|
57860
|
+
- type
|
|
57861
|
+
type: object
|
|
56861
57862
|
UserAttributes:
|
|
56862
57863
|
description: Attributes of user object returned by the API.
|
|
56863
57864
|
properties:
|
|
@@ -57308,6 +58309,15 @@ components:
|
|
|
57308
58309
|
meta:
|
|
57309
58310
|
$ref: '#/components/schemas/TeamsResponseMeta'
|
|
57310
58311
|
type: object
|
|
58312
|
+
UserType:
|
|
58313
|
+
default: users
|
|
58314
|
+
description: Users resource type.
|
|
58315
|
+
enum:
|
|
58316
|
+
- users
|
|
58317
|
+
example: users
|
|
58318
|
+
type: string
|
|
58319
|
+
x-enum-varnames:
|
|
58320
|
+
- USERS
|
|
57311
58321
|
UserUpdateAttributes:
|
|
57312
58322
|
description: Attributes of the edited user.
|
|
57313
58323
|
properties:
|
|
@@ -63547,6 +64557,14 @@ paths:
|
|
|
63547
64557
|
- $ref: '#/components/parameters/FilterByRelationType'
|
|
63548
64558
|
- $ref: '#/components/parameters/FilterByExcludeSnapshot'
|
|
63549
64559
|
- $ref: '#/components/parameters/Include'
|
|
64560
|
+
- description: If true, includes discovered services from APM and USM that do
|
|
64561
|
+
not have entity definitions.
|
|
64562
|
+
in: query
|
|
64563
|
+
name: includeDiscovered
|
|
64564
|
+
required: false
|
|
64565
|
+
schema:
|
|
64566
|
+
default: false
|
|
64567
|
+
type: boolean
|
|
63550
64568
|
responses:
|
|
63551
64569
|
'200':
|
|
63552
64570
|
content:
|
|
@@ -63765,6 +64783,13 @@ paths:
|
|
|
63765
64783
|
- $ref: '#/components/parameters/FilterRelationByFromRef'
|
|
63766
64784
|
- $ref: '#/components/parameters/FilterRelationByToRef'
|
|
63767
64785
|
- $ref: '#/components/parameters/RelationInclude'
|
|
64786
|
+
- description: If true, includes relationships discovered by APM and USM.
|
|
64787
|
+
in: query
|
|
64788
|
+
name: includeDiscovered
|
|
64789
|
+
required: false
|
|
64790
|
+
schema:
|
|
64791
|
+
default: false
|
|
64792
|
+
type: boolean
|
|
63768
64793
|
responses:
|
|
63769
64794
|
'200':
|
|
63770
64795
|
content:
|
|
@@ -67351,7 +68376,7 @@ paths:
|
|
|
67351
68376
|
content:
|
|
67352
68377
|
application/json:
|
|
67353
68378
|
schema:
|
|
67354
|
-
$ref: '#/components/schemas/
|
|
68379
|
+
$ref: '#/components/schemas/DORADeploymentsListResponse'
|
|
67355
68380
|
description: OK
|
|
67356
68381
|
'400':
|
|
67357
68382
|
content:
|
|
@@ -67389,26 +68414,8 @@ paths:
|
|
|
67389
68414
|
'200':
|
|
67390
68415
|
content:
|
|
67391
68416
|
application/json:
|
|
67392
|
-
|
|
67393
|
-
|
|
67394
|
-
attributes:
|
|
67395
|
-
custom_tags:
|
|
67396
|
-
- language:java
|
|
67397
|
-
- department:engineering
|
|
67398
|
-
- region:us-east-1
|
|
67399
|
-
env: staging
|
|
67400
|
-
finished_at: 1693491984000000000
|
|
67401
|
-
git:
|
|
67402
|
-
commit_sha: 66adc9350f2cc9b250b69abddab733dd55e1a588
|
|
67403
|
-
repository_url: https://github.com/organization/example-repository
|
|
67404
|
-
service: shopist
|
|
67405
|
-
started_at: 1693491974000000000
|
|
67406
|
-
team: backend
|
|
67407
|
-
version: v1.12.07
|
|
67408
|
-
id: 4242fcdd31586083
|
|
67409
|
-
type: dora_deployment
|
|
67410
|
-
schema:
|
|
67411
|
-
$ref: '#/components/schemas/DORAFetchResponse'
|
|
68417
|
+
schema:
|
|
68418
|
+
$ref: '#/components/schemas/DORADeploymentFetchResponse'
|
|
67412
68419
|
description: OK
|
|
67413
68420
|
'400':
|
|
67414
68421
|
content:
|
|
@@ -67525,66 +68532,8 @@ paths:
|
|
|
67525
68532
|
'200':
|
|
67526
68533
|
content:
|
|
67527
68534
|
application/json:
|
|
67528
|
-
|
|
67529
|
-
|
|
67530
|
-
- attributes:
|
|
67531
|
-
custom_tags:
|
|
67532
|
-
- language:java
|
|
67533
|
-
- department:engineering
|
|
67534
|
-
- region:us-east-1
|
|
67535
|
-
env: production
|
|
67536
|
-
finished_at: 1693491984000000000
|
|
67537
|
-
git:
|
|
67538
|
-
commit_sha: 66adc9350f2cc9b250b69abddab733dd55e1a588
|
|
67539
|
-
repository_url: https://github.com/organization/example-repository
|
|
67540
|
-
name: Web server is down; all requests are failing.
|
|
67541
|
-
services:
|
|
67542
|
-
- shopist
|
|
67543
|
-
severity: SEV-1
|
|
67544
|
-
started_at: 1693491974000000000
|
|
67545
|
-
team: backend
|
|
67546
|
-
id: 4242fcdd31586085
|
|
67547
|
-
type: dora_failure
|
|
67548
|
-
- attributes:
|
|
67549
|
-
custom_tags:
|
|
67550
|
-
- language:go
|
|
67551
|
-
- department:platform
|
|
67552
|
-
env: production
|
|
67553
|
-
finished_at: 1693492084000000000
|
|
67554
|
-
git:
|
|
67555
|
-
commit_sha: 77bdc9350f2cc9b250b69abddab733dd55e1a599
|
|
67556
|
-
repository_url: https://github.com/organization/api-service
|
|
67557
|
-
name: Database connection timeout
|
|
67558
|
-
services:
|
|
67559
|
-
- api-service
|
|
67560
|
-
- payment-service
|
|
67561
|
-
severity: SEV-1
|
|
67562
|
-
started_at: 1693492074000000000
|
|
67563
|
-
team: platform
|
|
67564
|
-
version: v2.1.0
|
|
67565
|
-
id: 4242fcdd31586086
|
|
67566
|
-
type: dora_failure
|
|
67567
|
-
- attributes:
|
|
67568
|
-
custom_tags:
|
|
67569
|
-
- language:python
|
|
67570
|
-
- department:payments
|
|
67571
|
-
- region:eu-west-1
|
|
67572
|
-
env: staging
|
|
67573
|
-
finished_at: 1693492204000000000
|
|
67574
|
-
git:
|
|
67575
|
-
commit_sha: 99edc9350f2cc9b250b69abddab733dd55e1a601
|
|
67576
|
-
repository_url: https://github.com/organization/payment-service
|
|
67577
|
-
name: Payment gateway API rate limit exceeded
|
|
67578
|
-
services:
|
|
67579
|
-
- payment-service
|
|
67580
|
-
severity: SEV-2
|
|
67581
|
-
started_at: 1693492174000000000
|
|
67582
|
-
team: payments
|
|
67583
|
-
version: v1.8.3
|
|
67584
|
-
id: 4242fcdd31586087
|
|
67585
|
-
type: dora_failure
|
|
67586
|
-
schema:
|
|
67587
|
-
$ref: '#/components/schemas/DORAListResponse'
|
|
68535
|
+
schema:
|
|
68536
|
+
$ref: '#/components/schemas/DORAFailuresListResponse'
|
|
67588
68537
|
description: OK
|
|
67589
68538
|
'400':
|
|
67590
68539
|
content:
|
|
@@ -67622,28 +68571,8 @@ paths:
|
|
|
67622
68571
|
'200':
|
|
67623
68572
|
content:
|
|
67624
68573
|
application/json:
|
|
67625
|
-
|
|
67626
|
-
|
|
67627
|
-
attributes:
|
|
67628
|
-
custom_tags:
|
|
67629
|
-
- language:java
|
|
67630
|
-
- department:engineering
|
|
67631
|
-
- region:us-east-1
|
|
67632
|
-
env: staging
|
|
67633
|
-
finished_at: 1693491984000000000
|
|
67634
|
-
git:
|
|
67635
|
-
commit_sha: 66adc9350f2cc9b250b69abddab733dd55e1a588
|
|
67636
|
-
repository_url: https://github.com/organization/example-repository
|
|
67637
|
-
name: Web server is down; all requests are failing.
|
|
67638
|
-
services:
|
|
67639
|
-
- shopist
|
|
67640
|
-
severity: High
|
|
67641
|
-
started_at: 1693491974000000000
|
|
67642
|
-
team: backend
|
|
67643
|
-
id: 4242fcdd31586085
|
|
67644
|
-
type: dora_failure
|
|
67645
|
-
schema:
|
|
67646
|
-
$ref: '#/components/schemas/DORAFetchResponse'
|
|
68574
|
+
schema:
|
|
68575
|
+
$ref: '#/components/schemas/DORAFailureFetchResponse'
|
|
67647
68576
|
description: OK
|
|
67648
68577
|
'400':
|
|
67649
68578
|
content:
|
|
@@ -68571,8 +69500,7 @@ paths:
|
|
|
68571
69500
|
security:
|
|
68572
69501
|
- apiKeyAuth: []
|
|
68573
69502
|
appKeyAuth: []
|
|
68574
|
-
- AuthZ:
|
|
68575
|
-
- incident_notification_settings_read
|
|
69503
|
+
- AuthZ: []
|
|
68576
69504
|
summary: List incident notification rules
|
|
68577
69505
|
tags:
|
|
68578
69506
|
- Incidents
|
|
@@ -68771,8 +69699,7 @@ paths:
|
|
|
68771
69699
|
security:
|
|
68772
69700
|
- apiKeyAuth: []
|
|
68773
69701
|
appKeyAuth: []
|
|
68774
|
-
- AuthZ:
|
|
68775
|
-
- incident_settings_read
|
|
69702
|
+
- AuthZ: []
|
|
68776
69703
|
summary: List incident notification templates
|
|
68777
69704
|
tags:
|
|
68778
69705
|
- Incidents
|
|
@@ -68887,7 +69814,8 @@ paths:
|
|
|
68887
69814
|
- apiKeyAuth: []
|
|
68888
69815
|
appKeyAuth: []
|
|
68889
69816
|
- AuthZ:
|
|
68890
|
-
-
|
|
69817
|
+
- incident_read
|
|
69818
|
+
- incident_write
|
|
68891
69819
|
summary: Get incident notification template
|
|
68892
69820
|
tags:
|
|
68893
69821
|
- Incidents
|
|
@@ -68977,6 +69905,7 @@ paths:
|
|
|
68977
69905
|
x-permission:
|
|
68978
69906
|
operator: OR
|
|
68979
69907
|
permissions:
|
|
69908
|
+
- incident_settings_read
|
|
68980
69909
|
- incident_read
|
|
68981
69910
|
x-unstable: '**Note**: This endpoint is in public beta.
|
|
68982
69911
|
|
|
@@ -69018,7 +69947,7 @@ paths:
|
|
|
69018
69947
|
- Incidents
|
|
69019
69948
|
x-codegen-request-body-name: body
|
|
69020
69949
|
x-permission:
|
|
69021
|
-
operator:
|
|
69950
|
+
operator: AND
|
|
69022
69951
|
permissions:
|
|
69023
69952
|
- incident_settings_write
|
|
69024
69953
|
x-unstable: '**Note**: This endpoint is in public beta.
|
|
@@ -69308,80 +70237,166 @@ paths:
|
|
|
69308
70237
|
If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).'
|
|
69309
70238
|
/api/v2/incidents/{incident_id}/attachments:
|
|
69310
70239
|
get:
|
|
69311
|
-
description:
|
|
70240
|
+
description: List incident attachments.
|
|
69312
70241
|
operationId: ListIncidentAttachments
|
|
69313
70242
|
parameters:
|
|
69314
70243
|
- $ref: '#/components/parameters/IncidentIDPathParameter'
|
|
69315
|
-
-
|
|
69316
|
-
|
|
70244
|
+
- description: Filter attachments by type. Supported values are `1` (`postmortem`)
|
|
70245
|
+
and `2` (`link`).
|
|
70246
|
+
in: query
|
|
70247
|
+
name: filter[attachment_type]
|
|
70248
|
+
schema:
|
|
70249
|
+
example: '1'
|
|
70250
|
+
type: string
|
|
70251
|
+
- $ref: '#/components/parameters/AttachmentIncludeQueryParameter'
|
|
69317
70252
|
responses:
|
|
69318
70253
|
'200':
|
|
69319
70254
|
content:
|
|
69320
70255
|
application/json:
|
|
69321
70256
|
schema:
|
|
69322
|
-
$ref: '#/components/schemas/
|
|
70257
|
+
$ref: '#/components/schemas/AttachmentArray'
|
|
69323
70258
|
description: OK
|
|
69324
70259
|
'400':
|
|
69325
70260
|
$ref: '#/components/responses/BadRequestResponse'
|
|
69326
|
-
'
|
|
69327
|
-
$ref: '#/components/responses/
|
|
70261
|
+
'429':
|
|
70262
|
+
$ref: '#/components/responses/TooManyRequestsResponse'
|
|
70263
|
+
security:
|
|
70264
|
+
- apiKeyAuth: []
|
|
70265
|
+
appKeyAuth: []
|
|
70266
|
+
summary: List incident attachments
|
|
70267
|
+
tags:
|
|
70268
|
+
- Incidents
|
|
70269
|
+
x-permission:
|
|
70270
|
+
operator: OR
|
|
70271
|
+
permissions:
|
|
70272
|
+
- incident_read
|
|
70273
|
+
x-unstable: '**Note**: This endpoint is in Preview.
|
|
70274
|
+
|
|
70275
|
+
If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).'
|
|
70276
|
+
post:
|
|
70277
|
+
description: Create an incident attachment.
|
|
70278
|
+
operationId: CreateIncidentAttachment
|
|
70279
|
+
parameters:
|
|
70280
|
+
- $ref: '#/components/parameters/IncidentIDPathParameter'
|
|
70281
|
+
- $ref: '#/components/parameters/AttachmentIncludeQueryParameter'
|
|
70282
|
+
requestBody:
|
|
70283
|
+
content:
|
|
70284
|
+
application/json:
|
|
70285
|
+
schema:
|
|
70286
|
+
$ref: '#/components/schemas/CreateAttachmentRequest'
|
|
70287
|
+
required: true
|
|
70288
|
+
responses:
|
|
70289
|
+
'201':
|
|
70290
|
+
content:
|
|
70291
|
+
application/json:
|
|
70292
|
+
schema:
|
|
70293
|
+
$ref: '#/components/schemas/Attachment'
|
|
70294
|
+
description: Created
|
|
70295
|
+
'400':
|
|
70296
|
+
$ref: '#/components/responses/BadRequestResponse'
|
|
70297
|
+
'403':
|
|
70298
|
+
$ref: '#/components/responses/ForbiddenResponse'
|
|
70299
|
+
'429':
|
|
70300
|
+
$ref: '#/components/responses/TooManyRequestsResponse'
|
|
70301
|
+
security:
|
|
70302
|
+
- apiKeyAuth: []
|
|
70303
|
+
appKeyAuth: []
|
|
70304
|
+
- AuthZ:
|
|
70305
|
+
- incident_write
|
|
70306
|
+
summary: Create incident attachment
|
|
70307
|
+
tags:
|
|
70308
|
+
- Incidents
|
|
70309
|
+
x-permission:
|
|
70310
|
+
operator: AND
|
|
70311
|
+
permissions:
|
|
70312
|
+
- incident_write
|
|
70313
|
+
x-unstable: '**Note**: This endpoint is in Preview.
|
|
70314
|
+
|
|
70315
|
+
If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).'
|
|
70316
|
+
/api/v2/incidents/{incident_id}/attachments/{attachment_id}:
|
|
70317
|
+
delete:
|
|
70318
|
+
operationId: DeleteIncidentAttachment
|
|
70319
|
+
parameters:
|
|
70320
|
+
- $ref: '#/components/parameters/IncidentIDPathParameter'
|
|
70321
|
+
- description: The ID of the attachment.
|
|
70322
|
+
in: path
|
|
70323
|
+
name: attachment_id
|
|
70324
|
+
required: true
|
|
70325
|
+
schema:
|
|
70326
|
+
example: 00000000-0000-0000-0000-000000000002
|
|
70327
|
+
responses:
|
|
70328
|
+
'204':
|
|
70329
|
+
description: No Content
|
|
70330
|
+
'400':
|
|
70331
|
+
$ref: '#/components/responses/BadRequestResponse'
|
|
69328
70332
|
'403':
|
|
69329
70333
|
$ref: '#/components/responses/ForbiddenResponse'
|
|
69330
70334
|
'404':
|
|
69331
70335
|
$ref: '#/components/responses/NotFoundResponse'
|
|
69332
70336
|
'429':
|
|
69333
70337
|
$ref: '#/components/responses/TooManyRequestsResponse'
|
|
69334
|
-
|
|
70338
|
+
security:
|
|
70339
|
+
- apiKeyAuth: []
|
|
70340
|
+
appKeyAuth: []
|
|
70341
|
+
- AuthZ:
|
|
70342
|
+
- incident_write
|
|
70343
|
+
summary: Delete incident attachment
|
|
69335
70344
|
tags:
|
|
69336
70345
|
- Incidents
|
|
69337
70346
|
x-permission:
|
|
69338
|
-
operator:
|
|
70347
|
+
operator: AND
|
|
69339
70348
|
permissions:
|
|
69340
|
-
-
|
|
69341
|
-
x-unstable: '**Note**: This endpoint is in
|
|
70349
|
+
- incident_write
|
|
70350
|
+
x-unstable: '**Note**: This endpoint is in Preview.
|
|
69342
70351
|
|
|
69343
70352
|
If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).'
|
|
69344
70353
|
patch:
|
|
69345
|
-
|
|
69346
|
-
description: The bulk update endpoint for creating, updating, and deleting attachments
|
|
69347
|
-
for a given incident.
|
|
69348
|
-
operationId: UpdateIncidentAttachments
|
|
70354
|
+
operationId: UpdateIncidentAttachment
|
|
69349
70355
|
parameters:
|
|
69350
70356
|
- $ref: '#/components/parameters/IncidentIDPathParameter'
|
|
69351
|
-
-
|
|
70357
|
+
- description: The ID of the attachment.
|
|
70358
|
+
in: path
|
|
70359
|
+
name: attachment_id
|
|
70360
|
+
required: true
|
|
70361
|
+
schema:
|
|
70362
|
+
example: 00000000-0000-0000-0000-000000000002
|
|
70363
|
+
- $ref: '#/components/parameters/AttachmentIncludeQueryParameter'
|
|
69352
70364
|
requestBody:
|
|
69353
70365
|
content:
|
|
69354
70366
|
application/json:
|
|
69355
70367
|
schema:
|
|
69356
|
-
$ref: '#/components/schemas/
|
|
69357
|
-
description: Incident Attachment Payload.
|
|
70368
|
+
$ref: '#/components/schemas/PatchAttachmentRequest'
|
|
69358
70369
|
required: true
|
|
69359
70370
|
responses:
|
|
69360
70371
|
'200':
|
|
69361
70372
|
content:
|
|
69362
70373
|
application/json:
|
|
69363
70374
|
schema:
|
|
69364
|
-
$ref: '#/components/schemas/
|
|
70375
|
+
$ref: '#/components/schemas/Attachment'
|
|
69365
70376
|
description: OK
|
|
69366
70377
|
'400':
|
|
69367
70378
|
$ref: '#/components/responses/BadRequestResponse'
|
|
69368
|
-
'401':
|
|
69369
|
-
$ref: '#/components/responses/UnauthorizedResponse'
|
|
69370
70379
|
'403':
|
|
69371
70380
|
$ref: '#/components/responses/ForbiddenResponse'
|
|
69372
70381
|
'404':
|
|
69373
70382
|
$ref: '#/components/responses/NotFoundResponse'
|
|
69374
70383
|
'429':
|
|
69375
70384
|
$ref: '#/components/responses/TooManyRequestsResponse'
|
|
69376
|
-
|
|
70385
|
+
security:
|
|
70386
|
+
- apiKeyAuth: []
|
|
70387
|
+
appKeyAuth: []
|
|
70388
|
+
- AuthZ:
|
|
70389
|
+
- incident_write
|
|
70390
|
+
summary: Update incident attachment
|
|
69377
70391
|
tags:
|
|
69378
70392
|
- Incidents
|
|
69379
|
-
x-codegen-request-body-name: body
|
|
69380
70393
|
x-permission:
|
|
69381
|
-
operator:
|
|
70394
|
+
operator: AND
|
|
69382
70395
|
permissions:
|
|
69383
70396
|
- incident_write
|
|
69384
|
-
x-unstable: '**Note**: This endpoint is
|
|
70397
|
+
x-unstable: '**Note**: This endpoint is in Preview.
|
|
70398
|
+
|
|
70399
|
+
If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).'
|
|
69385
70400
|
/api/v2/incidents/{incident_id}/impacts:
|
|
69386
70401
|
get:
|
|
69387
70402
|
description: Get all impacts for an incident.
|
|
@@ -76244,6 +77259,255 @@ paths:
|
|
|
76244
77259
|
operator: AND
|
|
76245
77260
|
permissions:
|
|
76246
77261
|
- on_call_read
|
|
77262
|
+
/api/v2/on-call/users/{user_id}/notification-rules:
|
|
77263
|
+
get:
|
|
77264
|
+
description: List the notification rules for a user. The authenticated user
|
|
77265
|
+
must be the target user or have the `on_call_admin` permission
|
|
77266
|
+
operationId: ListUserNotificationRules
|
|
77267
|
+
parameters:
|
|
77268
|
+
- description: 'Comma-separated list of included relationships to be returned.
|
|
77269
|
+
Allowed values: `channel`.'
|
|
77270
|
+
in: query
|
|
77271
|
+
name: include
|
|
77272
|
+
schema:
|
|
77273
|
+
type: string
|
|
77274
|
+
- description: The user ID
|
|
77275
|
+
in: path
|
|
77276
|
+
name: user_id
|
|
77277
|
+
required: true
|
|
77278
|
+
schema:
|
|
77279
|
+
example: 00000000-0000-0000-0000-000000000000
|
|
77280
|
+
type: string
|
|
77281
|
+
responses:
|
|
77282
|
+
'200':
|
|
77283
|
+
content:
|
|
77284
|
+
application/json:
|
|
77285
|
+
schema:
|
|
77286
|
+
$ref: '#/components/schemas/ListOnCallNotificationRulesResponse'
|
|
77287
|
+
description: OK
|
|
77288
|
+
'400':
|
|
77289
|
+
$ref: '#/components/responses/BadRequestResponse'
|
|
77290
|
+
'401':
|
|
77291
|
+
$ref: '#/components/responses/UnauthorizedResponse'
|
|
77292
|
+
'403':
|
|
77293
|
+
$ref: '#/components/responses/ForbiddenResponse'
|
|
77294
|
+
'404':
|
|
77295
|
+
$ref: '#/components/responses/NotFoundResponse'
|
|
77296
|
+
'429':
|
|
77297
|
+
$ref: '#/components/responses/TooManyRequestsResponse'
|
|
77298
|
+
security:
|
|
77299
|
+
- apiKeyAuth: []
|
|
77300
|
+
appKeyAuth: []
|
|
77301
|
+
- AuthZ: []
|
|
77302
|
+
summary: List On-Call notification rules for a user
|
|
77303
|
+
tags:
|
|
77304
|
+
- On-Call
|
|
77305
|
+
x-permission:
|
|
77306
|
+
operator: AND
|
|
77307
|
+
permissions:
|
|
77308
|
+
- on_call_read
|
|
77309
|
+
post:
|
|
77310
|
+
description: Create a new notification rule for a user. The authenticated user
|
|
77311
|
+
must be the target user or have the `on_call_admin` permission
|
|
77312
|
+
operationId: CreateUserNotificationRule
|
|
77313
|
+
parameters:
|
|
77314
|
+
- description: The user ID
|
|
77315
|
+
in: path
|
|
77316
|
+
name: user_id
|
|
77317
|
+
required: true
|
|
77318
|
+
schema:
|
|
77319
|
+
example: 00000000-0000-0000-0000-000000000000
|
|
77320
|
+
type: string
|
|
77321
|
+
requestBody:
|
|
77322
|
+
content:
|
|
77323
|
+
application/json:
|
|
77324
|
+
schema:
|
|
77325
|
+
$ref: '#/components/schemas/CreateOnCallNotificationRuleRequest'
|
|
77326
|
+
required: true
|
|
77327
|
+
responses:
|
|
77328
|
+
'201':
|
|
77329
|
+
content:
|
|
77330
|
+
application/json:
|
|
77331
|
+
schema:
|
|
77332
|
+
$ref: '#/components/schemas/OnCallNotificationRule'
|
|
77333
|
+
description: Created
|
|
77334
|
+
'400':
|
|
77335
|
+
$ref: '#/components/responses/BadRequestResponse'
|
|
77336
|
+
'401':
|
|
77337
|
+
$ref: '#/components/responses/UnauthorizedResponse'
|
|
77338
|
+
'403':
|
|
77339
|
+
$ref: '#/components/responses/ForbiddenResponse'
|
|
77340
|
+
'404':
|
|
77341
|
+
$ref: '#/components/responses/NotFoundResponse'
|
|
77342
|
+
'429':
|
|
77343
|
+
$ref: '#/components/responses/TooManyRequestsResponse'
|
|
77344
|
+
security:
|
|
77345
|
+
- apiKeyAuth: []
|
|
77346
|
+
appKeyAuth: []
|
|
77347
|
+
- AuthZ: []
|
|
77348
|
+
summary: Create an On-Call notification rule for a user
|
|
77349
|
+
tags:
|
|
77350
|
+
- On-Call
|
|
77351
|
+
x-permission:
|
|
77352
|
+
operator: AND
|
|
77353
|
+
permissions:
|
|
77354
|
+
- on_call_respond
|
|
77355
|
+
/api/v2/on-call/users/{user_id}/notification-rules/{rule_id}:
|
|
77356
|
+
delete:
|
|
77357
|
+
description: Delete a notification rule for a user. The authenticated user must
|
|
77358
|
+
be the target user or have the `on_call_admin` permission
|
|
77359
|
+
operationId: DeleteUserNotificationRule
|
|
77360
|
+
parameters:
|
|
77361
|
+
- description: The user ID
|
|
77362
|
+
in: path
|
|
77363
|
+
name: user_id
|
|
77364
|
+
required: true
|
|
77365
|
+
schema:
|
|
77366
|
+
example: 00000000-0000-0000-0000-000000000000
|
|
77367
|
+
type: string
|
|
77368
|
+
- description: The rule ID
|
|
77369
|
+
in: path
|
|
77370
|
+
name: rule_id
|
|
77371
|
+
required: true
|
|
77372
|
+
schema:
|
|
77373
|
+
example: 00000000-0000-0000-0000-000000000000
|
|
77374
|
+
type: string
|
|
77375
|
+
responses:
|
|
77376
|
+
'204':
|
|
77377
|
+
description: No Content
|
|
77378
|
+
'400':
|
|
77379
|
+
$ref: '#/components/responses/BadRequestResponse'
|
|
77380
|
+
'401':
|
|
77381
|
+
$ref: '#/components/responses/UnauthorizedResponse'
|
|
77382
|
+
'403':
|
|
77383
|
+
$ref: '#/components/responses/ForbiddenResponse'
|
|
77384
|
+
'404':
|
|
77385
|
+
$ref: '#/components/responses/NotFoundResponse'
|
|
77386
|
+
'429':
|
|
77387
|
+
$ref: '#/components/responses/TooManyRequestsResponse'
|
|
77388
|
+
security:
|
|
77389
|
+
- apiKeyAuth: []
|
|
77390
|
+
appKeyAuth: []
|
|
77391
|
+
- AuthZ: []
|
|
77392
|
+
summary: Delete an On-Call notification rule for a user
|
|
77393
|
+
tags:
|
|
77394
|
+
- On-Call
|
|
77395
|
+
x-permission:
|
|
77396
|
+
operator: OR
|
|
77397
|
+
permissions:
|
|
77398
|
+
- on_call_respond
|
|
77399
|
+
get:
|
|
77400
|
+
description: Get a notification rule for a user. The authenticated user must
|
|
77401
|
+
be the target user or have the `on_call_admin` permission
|
|
77402
|
+
operationId: GetUserNotificationRule
|
|
77403
|
+
parameters:
|
|
77404
|
+
- description: The user ID
|
|
77405
|
+
in: path
|
|
77406
|
+
name: user_id
|
|
77407
|
+
required: true
|
|
77408
|
+
schema:
|
|
77409
|
+
example: 00000000-0000-0000-0000-000000000000
|
|
77410
|
+
type: string
|
|
77411
|
+
- description: The rule ID
|
|
77412
|
+
in: path
|
|
77413
|
+
name: rule_id
|
|
77414
|
+
required: true
|
|
77415
|
+
schema:
|
|
77416
|
+
example: 00000000-0000-0000-0000-000000000000
|
|
77417
|
+
type: string
|
|
77418
|
+
- description: 'Comma-separated list of included relationships to be returned.
|
|
77419
|
+
Allowed values: `channel`.'
|
|
77420
|
+
in: query
|
|
77421
|
+
name: include
|
|
77422
|
+
schema:
|
|
77423
|
+
type: string
|
|
77424
|
+
responses:
|
|
77425
|
+
'200':
|
|
77426
|
+
content:
|
|
77427
|
+
application/json:
|
|
77428
|
+
schema:
|
|
77429
|
+
$ref: '#/components/schemas/OnCallNotificationRule'
|
|
77430
|
+
description: OK
|
|
77431
|
+
'400':
|
|
77432
|
+
$ref: '#/components/responses/BadRequestResponse'
|
|
77433
|
+
'401':
|
|
77434
|
+
$ref: '#/components/responses/UnauthorizedResponse'
|
|
77435
|
+
'403':
|
|
77436
|
+
$ref: '#/components/responses/ForbiddenResponse'
|
|
77437
|
+
'404':
|
|
77438
|
+
$ref: '#/components/responses/NotFoundResponse'
|
|
77439
|
+
'429':
|
|
77440
|
+
$ref: '#/components/responses/TooManyRequestsResponse'
|
|
77441
|
+
security:
|
|
77442
|
+
- apiKeyAuth: []
|
|
77443
|
+
appKeyAuth: []
|
|
77444
|
+
- AuthZ: []
|
|
77445
|
+
summary: Get an On-Call notification rule for a user
|
|
77446
|
+
tags:
|
|
77447
|
+
- On-Call
|
|
77448
|
+
x-permission:
|
|
77449
|
+
operator: OR
|
|
77450
|
+
permissions:
|
|
77451
|
+
- on_call_read
|
|
77452
|
+
put:
|
|
77453
|
+
description: Update a notification rule for a user. The authenticated user must
|
|
77454
|
+
be the target user or have the `on_call_admin` permission
|
|
77455
|
+
operationId: UpdateUserNotificationRule
|
|
77456
|
+
parameters:
|
|
77457
|
+
- description: The user ID
|
|
77458
|
+
in: path
|
|
77459
|
+
name: user_id
|
|
77460
|
+
required: true
|
|
77461
|
+
schema:
|
|
77462
|
+
example: 00000000-0000-0000-0000-000000000000
|
|
77463
|
+
type: string
|
|
77464
|
+
- description: The rule ID
|
|
77465
|
+
in: path
|
|
77466
|
+
name: rule_id
|
|
77467
|
+
required: true
|
|
77468
|
+
schema:
|
|
77469
|
+
example: 00000000-0000-0000-0000-000000000000
|
|
77470
|
+
type: string
|
|
77471
|
+
- description: 'Comma-separated list of included relationships to be returned.
|
|
77472
|
+
Allowed values: `channel`.'
|
|
77473
|
+
in: query
|
|
77474
|
+
name: include
|
|
77475
|
+
schema:
|
|
77476
|
+
type: string
|
|
77477
|
+
requestBody:
|
|
77478
|
+
content:
|
|
77479
|
+
application/json:
|
|
77480
|
+
schema:
|
|
77481
|
+
$ref: '#/components/schemas/UpdateOnCallNotificationRuleRequest'
|
|
77482
|
+
required: true
|
|
77483
|
+
responses:
|
|
77484
|
+
'200':
|
|
77485
|
+
content:
|
|
77486
|
+
application/json:
|
|
77487
|
+
schema:
|
|
77488
|
+
$ref: '#/components/schemas/OnCallNotificationRule'
|
|
77489
|
+
description: OK
|
|
77490
|
+
'400':
|
|
77491
|
+
$ref: '#/components/responses/BadRequestResponse'
|
|
77492
|
+
'401':
|
|
77493
|
+
$ref: '#/components/responses/UnauthorizedResponse'
|
|
77494
|
+
'403':
|
|
77495
|
+
$ref: '#/components/responses/ForbiddenResponse'
|
|
77496
|
+
'404':
|
|
77497
|
+
$ref: '#/components/responses/NotFoundResponse'
|
|
77498
|
+
'429':
|
|
77499
|
+
$ref: '#/components/responses/TooManyRequestsResponse'
|
|
77500
|
+
security:
|
|
77501
|
+
- apiKeyAuth: []
|
|
77502
|
+
appKeyAuth: []
|
|
77503
|
+
- AuthZ: []
|
|
77504
|
+
summary: Update an On-Call notification rule for a user
|
|
77505
|
+
tags:
|
|
77506
|
+
- On-Call
|
|
77507
|
+
x-permission:
|
|
77508
|
+
operator: OR
|
|
77509
|
+
permissions:
|
|
77510
|
+
- on_call_read
|
|
76247
77511
|
/api/v2/org_configs:
|
|
76248
77512
|
get:
|
|
76249
77513
|
description: Returns all Org Configs (name, description, and value).
|
|
@@ -77124,6 +78388,218 @@ paths:
|
|
|
77124
78388
|
x-permission:
|
|
77125
78389
|
operator: OPEN
|
|
77126
78390
|
permissions: []
|
|
78391
|
+
/api/v2/prodlytics:
|
|
78392
|
+
post:
|
|
78393
|
+
description: 'Send server-side events to Product Analytics. Server-side events
|
|
78394
|
+
are retained for 15 months.
|
|
78395
|
+
|
|
78396
|
+
|
|
78397
|
+
Server-Side events in Product Analytics are helpful for tracking events that
|
|
78398
|
+
occur on the server,
|
|
78399
|
+
|
|
78400
|
+
as opposed to client-side events, which are captured by Real User Monitoring
|
|
78401
|
+
(RUM) SDKs.
|
|
78402
|
+
|
|
78403
|
+
This allows for a more comprehensive view of the user journey by including
|
|
78404
|
+
actions that happen on the server.
|
|
78405
|
+
|
|
78406
|
+
Typical examples could be `checkout.completed` or `payment.processed`.
|
|
78407
|
+
|
|
78408
|
+
|
|
78409
|
+
Ingested server-side events are integrated into Product Analytics to allow
|
|
78410
|
+
users to select and filter
|
|
78411
|
+
|
|
78412
|
+
these events in the event picker, similar to how views or actions are handled.
|
|
78413
|
+
|
|
78414
|
+
|
|
78415
|
+
**Requirements:**
|
|
78416
|
+
|
|
78417
|
+
- At least one of `usr`, `account`, or `session` must be provided with a valid
|
|
78418
|
+
ID.
|
|
78419
|
+
|
|
78420
|
+
- The `application.id` must reference a Product Analytics-enabled application.
|
|
78421
|
+
|
|
78422
|
+
|
|
78423
|
+
**Custom Attributes:**
|
|
78424
|
+
|
|
78425
|
+
Any additional fields in the payload are flattened and searchable as facets.
|
|
78426
|
+
|
|
78427
|
+
For example, a payload with `{"customer": {"tier": "premium"}}` is searchable
|
|
78428
|
+
with
|
|
78429
|
+
|
|
78430
|
+
the syntax `@customer.tier:premium` in Datadog.
|
|
78431
|
+
|
|
78432
|
+
|
|
78433
|
+
The status codes answered by the HTTP API are:
|
|
78434
|
+
|
|
78435
|
+
- 202: Accepted: The request has been accepted for processing
|
|
78436
|
+
|
|
78437
|
+
- 400: Bad request (likely an issue in the payload formatting)
|
|
78438
|
+
|
|
78439
|
+
- 401: Unauthorized (likely a missing API Key)
|
|
78440
|
+
|
|
78441
|
+
- 403: Permission issue (likely using an invalid API Key)
|
|
78442
|
+
|
|
78443
|
+
- 408: Request Timeout, request should be retried after some time
|
|
78444
|
+
|
|
78445
|
+
- 413: Payload too large (batch is above 5MB uncompressed)
|
|
78446
|
+
|
|
78447
|
+
- 429: Too Many Requests, request should be retried after some time
|
|
78448
|
+
|
|
78449
|
+
- 500: Internal Server Error, the server encountered an unexpected condition
|
|
78450
|
+
that prevented it from fulfilling the request, request should be retried after
|
|
78451
|
+
some time
|
|
78452
|
+
|
|
78453
|
+
- 503: Service Unavailable, the server is not ready to handle the request
|
|
78454
|
+
probably because it is overloaded, request should be retried after some time'
|
|
78455
|
+
operationId: SubmitProductAnalyticsEvent
|
|
78456
|
+
requestBody:
|
|
78457
|
+
content:
|
|
78458
|
+
application/json:
|
|
78459
|
+
examples:
|
|
78460
|
+
event-with-account:
|
|
78461
|
+
description: Send a server-side event linked to an account.
|
|
78462
|
+
summary: Event with account ID
|
|
78463
|
+
value:
|
|
78464
|
+
account:
|
|
78465
|
+
id: account-456
|
|
78466
|
+
application:
|
|
78467
|
+
id: 123abcde-123a-123b-1234-123456789abc
|
|
78468
|
+
event:
|
|
78469
|
+
name: checkout.completed
|
|
78470
|
+
type: server
|
|
78471
|
+
event-with-custom-attributes:
|
|
78472
|
+
description: Send a server-side event with additional custom attributes.
|
|
78473
|
+
summary: Event with custom attributes
|
|
78474
|
+
value:
|
|
78475
|
+
application:
|
|
78476
|
+
id: 123abcde-123a-123b-1234-123456789abc
|
|
78477
|
+
customer:
|
|
78478
|
+
tier: premium
|
|
78479
|
+
event:
|
|
78480
|
+
name: payment.processed
|
|
78481
|
+
type: server
|
|
78482
|
+
usr:
|
|
78483
|
+
id: '123'
|
|
78484
|
+
event-with-session:
|
|
78485
|
+
description: Send a server-side event linked to a session.
|
|
78486
|
+
summary: Event with session ID
|
|
78487
|
+
value:
|
|
78488
|
+
application:
|
|
78489
|
+
id: 123abcde-123a-123b-1234-123456789abc
|
|
78490
|
+
event:
|
|
78491
|
+
name: form.submitted
|
|
78492
|
+
session:
|
|
78493
|
+
id: session-789
|
|
78494
|
+
type: server
|
|
78495
|
+
simple-event-with-user:
|
|
78496
|
+
description: Send a server-side event linked to a user.
|
|
78497
|
+
summary: Simple event with user ID
|
|
78498
|
+
value:
|
|
78499
|
+
application:
|
|
78500
|
+
id: 123abcde-123a-123b-1234-123456789abc
|
|
78501
|
+
event:
|
|
78502
|
+
name: payment.processed
|
|
78503
|
+
type: server
|
|
78504
|
+
usr:
|
|
78505
|
+
id: '123'
|
|
78506
|
+
schema:
|
|
78507
|
+
$ref: '#/components/schemas/ProductAnalyticsServerSideEventItem'
|
|
78508
|
+
description: Server-side event to send (JSON format).
|
|
78509
|
+
required: true
|
|
78510
|
+
responses:
|
|
78511
|
+
'202':
|
|
78512
|
+
content:
|
|
78513
|
+
application/json:
|
|
78514
|
+
schema:
|
|
78515
|
+
type: object
|
|
78516
|
+
description: Request accepted for processing (always 202 empty JSON).
|
|
78517
|
+
'400':
|
|
78518
|
+
content:
|
|
78519
|
+
application/json:
|
|
78520
|
+
schema:
|
|
78521
|
+
$ref: '#/components/schemas/ProductAnalyticsServerSideEventErrors'
|
|
78522
|
+
description: Bad Request
|
|
78523
|
+
'401':
|
|
78524
|
+
content:
|
|
78525
|
+
application/json:
|
|
78526
|
+
schema:
|
|
78527
|
+
$ref: '#/components/schemas/ProductAnalyticsServerSideEventErrors'
|
|
78528
|
+
description: Unauthorized
|
|
78529
|
+
'403':
|
|
78530
|
+
content:
|
|
78531
|
+
application/json:
|
|
78532
|
+
schema:
|
|
78533
|
+
$ref: '#/components/schemas/ProductAnalyticsServerSideEventErrors'
|
|
78534
|
+
description: Forbidden
|
|
78535
|
+
'408':
|
|
78536
|
+
content:
|
|
78537
|
+
application/json:
|
|
78538
|
+
schema:
|
|
78539
|
+
$ref: '#/components/schemas/ProductAnalyticsServerSideEventErrors'
|
|
78540
|
+
description: Request Timeout
|
|
78541
|
+
'413':
|
|
78542
|
+
content:
|
|
78543
|
+
application/json:
|
|
78544
|
+
schema:
|
|
78545
|
+
$ref: '#/components/schemas/ProductAnalyticsServerSideEventErrors'
|
|
78546
|
+
description: Payload Too Large
|
|
78547
|
+
'429':
|
|
78548
|
+
content:
|
|
78549
|
+
application/json:
|
|
78550
|
+
schema:
|
|
78551
|
+
$ref: '#/components/schemas/ProductAnalyticsServerSideEventErrors'
|
|
78552
|
+
description: Too Many Requests
|
|
78553
|
+
'500':
|
|
78554
|
+
content:
|
|
78555
|
+
application/json:
|
|
78556
|
+
schema:
|
|
78557
|
+
$ref: '#/components/schemas/ProductAnalyticsServerSideEventErrors'
|
|
78558
|
+
description: Internal Server Error
|
|
78559
|
+
'503':
|
|
78560
|
+
content:
|
|
78561
|
+
application/json:
|
|
78562
|
+
schema:
|
|
78563
|
+
$ref: '#/components/schemas/ProductAnalyticsServerSideEventErrors'
|
|
78564
|
+
description: Service Unavailable
|
|
78565
|
+
security:
|
|
78566
|
+
- apiKeyAuth: []
|
|
78567
|
+
servers:
|
|
78568
|
+
- url: https://{subdomain}.{site}
|
|
78569
|
+
variables:
|
|
78570
|
+
site:
|
|
78571
|
+
default: datadoghq.com
|
|
78572
|
+
description: The regional site for customers.
|
|
78573
|
+
enum:
|
|
78574
|
+
- datadoghq.com
|
|
78575
|
+
- us3.datadoghq.com
|
|
78576
|
+
- us5.datadoghq.com
|
|
78577
|
+
- ap1.datadoghq.com
|
|
78578
|
+
- ap2.datadoghq.com
|
|
78579
|
+
- datadoghq.eu
|
|
78580
|
+
subdomain:
|
|
78581
|
+
default: browser-intake
|
|
78582
|
+
description: The subdomain where the API is deployed.
|
|
78583
|
+
- url: '{protocol}://{name}'
|
|
78584
|
+
variables:
|
|
78585
|
+
name:
|
|
78586
|
+
default: browser-intake-datadoghq.com
|
|
78587
|
+
description: Full site DNS name.
|
|
78588
|
+
protocol:
|
|
78589
|
+
default: https
|
|
78590
|
+
description: The protocol for accessing the API.
|
|
78591
|
+
- url: https://{subdomain}.{site}
|
|
78592
|
+
variables:
|
|
78593
|
+
site:
|
|
78594
|
+
default: datadoghq.com
|
|
78595
|
+
description: Any Datadog deployment.
|
|
78596
|
+
subdomain:
|
|
78597
|
+
default: browser-intake
|
|
78598
|
+
description: The subdomain where the API is deployed.
|
|
78599
|
+
summary: Send server-side events
|
|
78600
|
+
tags:
|
|
78601
|
+
- Product Analytics
|
|
78602
|
+
x-codegen-request-body-name: body
|
|
77127
78603
|
/api/v2/product-analytics/accounts/facet_info:
|
|
77128
78604
|
post:
|
|
77129
78605
|
description: Get facet information for account attributes including possible
|
|
@@ -85259,6 +86735,60 @@ paths:
|
|
|
85259
86735
|
operator: OR
|
|
85260
86736
|
permissions:
|
|
85261
86737
|
- billing_edit
|
|
86738
|
+
/api/v2/synthetics/variables/{variable_id}/jsonpatch:
|
|
86739
|
+
patch:
|
|
86740
|
+
description: 'Patch a global variable using JSON Patch (RFC 6902).
|
|
86741
|
+
|
|
86742
|
+
This endpoint allows partial updates to a global variable by specifying only
|
|
86743
|
+
the fields to modify.
|
|
86744
|
+
|
|
86745
|
+
|
|
86746
|
+
Common operations include:
|
|
86747
|
+
|
|
86748
|
+
- Replace field values: `{"op": "replace", "path": "/name", "value": "new_name"}`
|
|
86749
|
+
|
|
86750
|
+
- Update nested values: `{"op": "replace", "path": "/value/value", "value":
|
|
86751
|
+
"new_value"}`
|
|
86752
|
+
|
|
86753
|
+
- Add/update tags: `{"op": "add", "path": "/tags/-", "value": "new_tag"}`
|
|
86754
|
+
|
|
86755
|
+
- Remove fields: `{"op": "remove", "path": "/description"}`'
|
|
86756
|
+
operationId: PatchGlobalVariable
|
|
86757
|
+
parameters:
|
|
86758
|
+
- description: The ID of the global variable.
|
|
86759
|
+
in: path
|
|
86760
|
+
name: variable_id
|
|
86761
|
+
required: true
|
|
86762
|
+
schema:
|
|
86763
|
+
type: string
|
|
86764
|
+
requestBody:
|
|
86765
|
+
content:
|
|
86766
|
+
application/json:
|
|
86767
|
+
schema:
|
|
86768
|
+
$ref: '#/components/schemas/GlobalVariableJsonPatchRequest'
|
|
86769
|
+
description: JSON Patch document with operations to apply.
|
|
86770
|
+
required: true
|
|
86771
|
+
responses:
|
|
86772
|
+
'200':
|
|
86773
|
+
content:
|
|
86774
|
+
application/json:
|
|
86775
|
+
schema:
|
|
86776
|
+
$ref: '#/components/schemas/GlobalVariableResponse'
|
|
86777
|
+
description: OK
|
|
86778
|
+
'400':
|
|
86779
|
+
$ref: '#/components/responses/BadRequestResponse'
|
|
86780
|
+
'404':
|
|
86781
|
+
$ref: '#/components/responses/NotFoundResponse'
|
|
86782
|
+
'429':
|
|
86783
|
+
$ref: '#/components/responses/TooManyRequestsResponse'
|
|
86784
|
+
summary: Patch a global variable
|
|
86785
|
+
tags:
|
|
86786
|
+
- Synthetics
|
|
86787
|
+
x-codegen-request-body-name: body
|
|
86788
|
+
x-permission:
|
|
86789
|
+
operator: OR
|
|
86790
|
+
permissions:
|
|
86791
|
+
- synthetics_global_variable_write
|
|
85262
86792
|
/api/v2/tags/enrichment:
|
|
85263
86793
|
get:
|
|
85264
86794
|
description: List all tag pipeline rulesets - Retrieve a list of all tag pipeline
|
|
@@ -85761,10 +87291,6 @@ paths:
|
|
|
85761
87291
|
operator: OR
|
|
85762
87292
|
permissions:
|
|
85763
87293
|
- teams_read
|
|
85764
|
-
x-unstable: '**Note**: This endpoint is in Preview. To request access, fill
|
|
85765
|
-
out this [form](https://www.datadoghq.com/product-preview/github-integration-for-teams/).
|
|
85766
|
-
|
|
85767
|
-
If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).'
|
|
85768
87294
|
get:
|
|
85769
87295
|
description: Returns all team connections.
|
|
85770
87296
|
operationId: ListTeamConnections
|
|
@@ -85844,10 +87370,6 @@ paths:
|
|
|
85844
87370
|
operator: OR
|
|
85845
87371
|
permissions:
|
|
85846
87372
|
- teams_read
|
|
85847
|
-
x-unstable: '**Note**: This endpoint is in Preview. To request access, fill
|
|
85848
|
-
out this [form](https://www.datadoghq.com/product-preview/github-integration-for-teams/).
|
|
85849
|
-
|
|
85850
|
-
If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).'
|
|
85851
87373
|
post:
|
|
85852
87374
|
description: Create multiple team connections.
|
|
85853
87375
|
operationId: CreateTeamConnections
|
|
@@ -85884,10 +87406,6 @@ paths:
|
|
|
85884
87406
|
operator: OR
|
|
85885
87407
|
permissions:
|
|
85886
87408
|
- teams_read
|
|
85887
|
-
x-unstable: '**Note**: This endpoint is in Preview. To request access, fill
|
|
85888
|
-
out this [form](https://www.datadoghq.com/product-preview/github-integration-for-teams/).
|
|
85889
|
-
|
|
85890
|
-
If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).'
|
|
85891
87409
|
/api/v2/team/sync:
|
|
85892
87410
|
get:
|
|
85893
87411
|
description: 'Get all team synchronization configurations.
|
|
@@ -85931,10 +87449,6 @@ paths:
|
|
|
85931
87449
|
operator: OR
|
|
85932
87450
|
permissions:
|
|
85933
87451
|
- teams_read
|
|
85934
|
-
x-unstable: '**Note**: This endpoint is in Preview. To request access, fill
|
|
85935
|
-
out this [form](https://www.datadoghq.com/product-preview/github-integration-for-teams/).
|
|
85936
|
-
|
|
85937
|
-
If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).'
|
|
85938
87452
|
post:
|
|
85939
87453
|
description: 'This endpoint attempts to link your existing Datadog teams with
|
|
85940
87454
|
GitHub teams by matching their names.
|
|
@@ -85996,10 +87510,6 @@ paths:
|
|
|
85996
87510
|
operator: AND
|
|
85997
87511
|
permissions:
|
|
85998
87512
|
- teams_manage
|
|
85999
|
-
x-unstable: '**Note**: This endpoint is in Preview. To request access, fill
|
|
86000
|
-
out this [form](https://www.datadoghq.com/product-preview/github-integration-for-teams/).
|
|
86001
|
-
|
|
86002
|
-
If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).'
|
|
86003
87513
|
/api/v2/team/{super_team_id}/member_teams:
|
|
86004
87514
|
get:
|
|
86005
87515
|
deprecated: true
|
|
@@ -86300,7 +87810,354 @@ paths:
|
|
|
86300
87810
|
appKeyAuth: []
|
|
86301
87811
|
- AuthZ:
|
|
86302
87812
|
- teams_read
|
|
86303
|
-
summary: Update a team
|
|
87813
|
+
summary: Update a team
|
|
87814
|
+
tags:
|
|
87815
|
+
- Teams
|
|
87816
|
+
x-codegen-request-body-name: body
|
|
87817
|
+
x-permission:
|
|
87818
|
+
operator: OR
|
|
87819
|
+
permissions:
|
|
87820
|
+
- teams_read
|
|
87821
|
+
/api/v2/team/{team_id}/links:
|
|
87822
|
+
get:
|
|
87823
|
+
description: Get all links for a given team.
|
|
87824
|
+
operationId: GetTeamLinks
|
|
87825
|
+
parameters:
|
|
87826
|
+
- description: None
|
|
87827
|
+
in: path
|
|
87828
|
+
name: team_id
|
|
87829
|
+
required: true
|
|
87830
|
+
schema:
|
|
87831
|
+
type: string
|
|
87832
|
+
responses:
|
|
87833
|
+
'200':
|
|
87834
|
+
content:
|
|
87835
|
+
application/json:
|
|
87836
|
+
schema:
|
|
87837
|
+
$ref: '#/components/schemas/TeamLinksResponse'
|
|
87838
|
+
description: OK
|
|
87839
|
+
'403':
|
|
87840
|
+
$ref: '#/components/responses/ForbiddenResponse'
|
|
87841
|
+
'404':
|
|
87842
|
+
content:
|
|
87843
|
+
application/json:
|
|
87844
|
+
schema:
|
|
87845
|
+
$ref: '#/components/schemas/APIErrorResponse'
|
|
87846
|
+
description: API error response.
|
|
87847
|
+
'429':
|
|
87848
|
+
$ref: '#/components/responses/TooManyRequestsResponse'
|
|
87849
|
+
security:
|
|
87850
|
+
- apiKeyAuth: []
|
|
87851
|
+
appKeyAuth: []
|
|
87852
|
+
- AuthZ:
|
|
87853
|
+
- teams_read
|
|
87854
|
+
summary: Get links for a team
|
|
87855
|
+
tags:
|
|
87856
|
+
- Teams
|
|
87857
|
+
x-permission:
|
|
87858
|
+
operator: OR
|
|
87859
|
+
permissions:
|
|
87860
|
+
- teams_read
|
|
87861
|
+
post:
|
|
87862
|
+
description: Add a new link to a team.
|
|
87863
|
+
operationId: CreateTeamLink
|
|
87864
|
+
parameters:
|
|
87865
|
+
- description: None
|
|
87866
|
+
in: path
|
|
87867
|
+
name: team_id
|
|
87868
|
+
required: true
|
|
87869
|
+
schema:
|
|
87870
|
+
type: string
|
|
87871
|
+
requestBody:
|
|
87872
|
+
content:
|
|
87873
|
+
application/json:
|
|
87874
|
+
schema:
|
|
87875
|
+
$ref: '#/components/schemas/TeamLinkCreateRequest'
|
|
87876
|
+
required: true
|
|
87877
|
+
responses:
|
|
87878
|
+
'200':
|
|
87879
|
+
content:
|
|
87880
|
+
application/json:
|
|
87881
|
+
schema:
|
|
87882
|
+
$ref: '#/components/schemas/TeamLinkResponse'
|
|
87883
|
+
description: OK
|
|
87884
|
+
'403':
|
|
87885
|
+
$ref: '#/components/responses/ForbiddenResponse'
|
|
87886
|
+
'404':
|
|
87887
|
+
content:
|
|
87888
|
+
application/json:
|
|
87889
|
+
schema:
|
|
87890
|
+
$ref: '#/components/schemas/APIErrorResponse'
|
|
87891
|
+
description: API error response.
|
|
87892
|
+
'422':
|
|
87893
|
+
content:
|
|
87894
|
+
application/json:
|
|
87895
|
+
schema:
|
|
87896
|
+
$ref: '#/components/schemas/APIErrorResponse'
|
|
87897
|
+
description: API error response.
|
|
87898
|
+
'429':
|
|
87899
|
+
$ref: '#/components/responses/TooManyRequestsResponse'
|
|
87900
|
+
security:
|
|
87901
|
+
- apiKeyAuth: []
|
|
87902
|
+
appKeyAuth: []
|
|
87903
|
+
- AuthZ:
|
|
87904
|
+
- teams_read
|
|
87905
|
+
summary: Create a team link
|
|
87906
|
+
tags:
|
|
87907
|
+
- Teams
|
|
87908
|
+
x-codegen-request-body-name: body
|
|
87909
|
+
x-permission:
|
|
87910
|
+
operator: OR
|
|
87911
|
+
permissions:
|
|
87912
|
+
- teams_read
|
|
87913
|
+
/api/v2/team/{team_id}/links/{link_id}:
|
|
87914
|
+
delete:
|
|
87915
|
+
description: Remove a link from a team.
|
|
87916
|
+
operationId: DeleteTeamLink
|
|
87917
|
+
parameters:
|
|
87918
|
+
- description: None
|
|
87919
|
+
in: path
|
|
87920
|
+
name: team_id
|
|
87921
|
+
required: true
|
|
87922
|
+
schema:
|
|
87923
|
+
type: string
|
|
87924
|
+
- description: None
|
|
87925
|
+
in: path
|
|
87926
|
+
name: link_id
|
|
87927
|
+
required: true
|
|
87928
|
+
schema:
|
|
87929
|
+
type: string
|
|
87930
|
+
responses:
|
|
87931
|
+
'204':
|
|
87932
|
+
description: No Content
|
|
87933
|
+
'403':
|
|
87934
|
+
$ref: '#/components/responses/ForbiddenResponse'
|
|
87935
|
+
'404':
|
|
87936
|
+
content:
|
|
87937
|
+
application/json:
|
|
87938
|
+
schema:
|
|
87939
|
+
$ref: '#/components/schemas/APIErrorResponse'
|
|
87940
|
+
description: API error response.
|
|
87941
|
+
'429':
|
|
87942
|
+
$ref: '#/components/responses/TooManyRequestsResponse'
|
|
87943
|
+
security:
|
|
87944
|
+
- apiKeyAuth: []
|
|
87945
|
+
appKeyAuth: []
|
|
87946
|
+
- AuthZ:
|
|
87947
|
+
- teams_read
|
|
87948
|
+
summary: Remove a team link
|
|
87949
|
+
tags:
|
|
87950
|
+
- Teams
|
|
87951
|
+
x-permission:
|
|
87952
|
+
operator: OR
|
|
87953
|
+
permissions:
|
|
87954
|
+
- teams_read
|
|
87955
|
+
get:
|
|
87956
|
+
description: Get a single link for a team.
|
|
87957
|
+
operationId: GetTeamLink
|
|
87958
|
+
parameters:
|
|
87959
|
+
- description: None
|
|
87960
|
+
in: path
|
|
87961
|
+
name: team_id
|
|
87962
|
+
required: true
|
|
87963
|
+
schema:
|
|
87964
|
+
type: string
|
|
87965
|
+
- description: None
|
|
87966
|
+
in: path
|
|
87967
|
+
name: link_id
|
|
87968
|
+
required: true
|
|
87969
|
+
schema:
|
|
87970
|
+
type: string
|
|
87971
|
+
responses:
|
|
87972
|
+
'200':
|
|
87973
|
+
content:
|
|
87974
|
+
application/json:
|
|
87975
|
+
schema:
|
|
87976
|
+
$ref: '#/components/schemas/TeamLinkResponse'
|
|
87977
|
+
description: OK
|
|
87978
|
+
'403':
|
|
87979
|
+
$ref: '#/components/responses/ForbiddenResponse'
|
|
87980
|
+
'404':
|
|
87981
|
+
content:
|
|
87982
|
+
application/json:
|
|
87983
|
+
schema:
|
|
87984
|
+
$ref: '#/components/schemas/APIErrorResponse'
|
|
87985
|
+
description: API error response.
|
|
87986
|
+
'429':
|
|
87987
|
+
$ref: '#/components/responses/TooManyRequestsResponse'
|
|
87988
|
+
security:
|
|
87989
|
+
- apiKeyAuth: []
|
|
87990
|
+
appKeyAuth: []
|
|
87991
|
+
- AuthZ:
|
|
87992
|
+
- teams_read
|
|
87993
|
+
summary: Get a team link
|
|
87994
|
+
tags:
|
|
87995
|
+
- Teams
|
|
87996
|
+
x-permission:
|
|
87997
|
+
operator: OR
|
|
87998
|
+
permissions:
|
|
87999
|
+
- teams_read
|
|
88000
|
+
patch:
|
|
88001
|
+
description: Update a team link.
|
|
88002
|
+
operationId: UpdateTeamLink
|
|
88003
|
+
parameters:
|
|
88004
|
+
- description: None
|
|
88005
|
+
in: path
|
|
88006
|
+
name: team_id
|
|
88007
|
+
required: true
|
|
88008
|
+
schema:
|
|
88009
|
+
type: string
|
|
88010
|
+
- description: None
|
|
88011
|
+
in: path
|
|
88012
|
+
name: link_id
|
|
88013
|
+
required: true
|
|
88014
|
+
schema:
|
|
88015
|
+
type: string
|
|
88016
|
+
requestBody:
|
|
88017
|
+
content:
|
|
88018
|
+
application/json:
|
|
88019
|
+
schema:
|
|
88020
|
+
$ref: '#/components/schemas/TeamLinkCreateRequest'
|
|
88021
|
+
required: true
|
|
88022
|
+
responses:
|
|
88023
|
+
'200':
|
|
88024
|
+
content:
|
|
88025
|
+
application/json:
|
|
88026
|
+
schema:
|
|
88027
|
+
$ref: '#/components/schemas/TeamLinkResponse'
|
|
88028
|
+
description: OK
|
|
88029
|
+
'403':
|
|
88030
|
+
$ref: '#/components/responses/ForbiddenResponse'
|
|
88031
|
+
'404':
|
|
88032
|
+
content:
|
|
88033
|
+
application/json:
|
|
88034
|
+
schema:
|
|
88035
|
+
$ref: '#/components/schemas/APIErrorResponse'
|
|
88036
|
+
description: API error response.
|
|
88037
|
+
'429':
|
|
88038
|
+
$ref: '#/components/responses/TooManyRequestsResponse'
|
|
88039
|
+
security:
|
|
88040
|
+
- apiKeyAuth: []
|
|
88041
|
+
appKeyAuth: []
|
|
88042
|
+
- AuthZ:
|
|
88043
|
+
- teams_read
|
|
88044
|
+
summary: Update a team link
|
|
88045
|
+
tags:
|
|
88046
|
+
- Teams
|
|
88047
|
+
x-codegen-request-body-name: body
|
|
88048
|
+
x-permission:
|
|
88049
|
+
operator: OR
|
|
88050
|
+
permissions:
|
|
88051
|
+
- teams_read
|
|
88052
|
+
/api/v2/team/{team_id}/memberships:
|
|
88053
|
+
get:
|
|
88054
|
+
description: Get a paginated list of members for a team
|
|
88055
|
+
operationId: GetTeamMemberships
|
|
88056
|
+
parameters:
|
|
88057
|
+
- description: None
|
|
88058
|
+
in: path
|
|
88059
|
+
name: team_id
|
|
88060
|
+
required: true
|
|
88061
|
+
schema:
|
|
88062
|
+
type: string
|
|
88063
|
+
- $ref: '#/components/parameters/PageSize'
|
|
88064
|
+
- $ref: '#/components/parameters/PageNumber'
|
|
88065
|
+
- description: Specifies the order of returned team memberships
|
|
88066
|
+
in: query
|
|
88067
|
+
name: sort
|
|
88068
|
+
required: false
|
|
88069
|
+
schema:
|
|
88070
|
+
$ref: '#/components/schemas/GetTeamMembershipsSort'
|
|
88071
|
+
- description: Search query, can be user email or name
|
|
88072
|
+
in: query
|
|
88073
|
+
name: filter[keyword]
|
|
88074
|
+
required: false
|
|
88075
|
+
schema:
|
|
88076
|
+
type: string
|
|
88077
|
+
responses:
|
|
88078
|
+
'200':
|
|
88079
|
+
content:
|
|
88080
|
+
application/json:
|
|
88081
|
+
schema:
|
|
88082
|
+
$ref: '#/components/schemas/UserTeamsResponse'
|
|
88083
|
+
description: Represents a user's association to a team
|
|
88084
|
+
'403':
|
|
88085
|
+
$ref: '#/components/responses/ForbiddenResponse'
|
|
88086
|
+
'404':
|
|
88087
|
+
content:
|
|
88088
|
+
application/json:
|
|
88089
|
+
schema:
|
|
88090
|
+
$ref: '#/components/schemas/APIErrorResponse'
|
|
88091
|
+
description: API error response.
|
|
88092
|
+
'429':
|
|
88093
|
+
$ref: '#/components/responses/TooManyRequestsResponse'
|
|
88094
|
+
security:
|
|
88095
|
+
- apiKeyAuth: []
|
|
88096
|
+
appKeyAuth: []
|
|
88097
|
+
- AuthZ:
|
|
88098
|
+
- teams_read
|
|
88099
|
+
summary: Get team memberships
|
|
88100
|
+
tags:
|
|
88101
|
+
- Teams
|
|
88102
|
+
x-pagination:
|
|
88103
|
+
limitParam: page[size]
|
|
88104
|
+
pageParam: page[number]
|
|
88105
|
+
resultsPath: data
|
|
88106
|
+
x-permission:
|
|
88107
|
+
operator: OR
|
|
88108
|
+
permissions:
|
|
88109
|
+
- teams_read
|
|
88110
|
+
post:
|
|
88111
|
+
description: 'Add a user to a team.
|
|
88112
|
+
|
|
88113
|
+
|
|
88114
|
+
**Note**: Each team has a setting that determines who is allowed to modify
|
|
88115
|
+
membership of the team. The `user_access_manage` permission generally grants
|
|
88116
|
+
access to modify membership of any team. To get the full picture, see [Team
|
|
88117
|
+
Membership documentation](https://docs.datadoghq.com/account_management/teams/manage/#team-membership).'
|
|
88118
|
+
operationId: CreateTeamMembership
|
|
88119
|
+
parameters:
|
|
88120
|
+
- description: None
|
|
88121
|
+
in: path
|
|
88122
|
+
name: team_id
|
|
88123
|
+
required: true
|
|
88124
|
+
schema:
|
|
88125
|
+
type: string
|
|
88126
|
+
requestBody:
|
|
88127
|
+
content:
|
|
88128
|
+
application/json:
|
|
88129
|
+
schema:
|
|
88130
|
+
$ref: '#/components/schemas/UserTeamRequest'
|
|
88131
|
+
required: true
|
|
88132
|
+
responses:
|
|
88133
|
+
'200':
|
|
88134
|
+
content:
|
|
88135
|
+
application/json:
|
|
88136
|
+
schema:
|
|
88137
|
+
$ref: '#/components/schemas/UserTeamResponse'
|
|
88138
|
+
description: Represents a user's association to a team
|
|
88139
|
+
'403':
|
|
88140
|
+
$ref: '#/components/responses/ForbiddenResponse'
|
|
88141
|
+
'404':
|
|
88142
|
+
content:
|
|
88143
|
+
application/json:
|
|
88144
|
+
schema:
|
|
88145
|
+
$ref: '#/components/schemas/APIErrorResponse'
|
|
88146
|
+
description: API error response.
|
|
88147
|
+
'409':
|
|
88148
|
+
content:
|
|
88149
|
+
application/json:
|
|
88150
|
+
schema:
|
|
88151
|
+
$ref: '#/components/schemas/APIErrorResponse'
|
|
88152
|
+
description: API error response.
|
|
88153
|
+
'429':
|
|
88154
|
+
$ref: '#/components/responses/TooManyRequestsResponse'
|
|
88155
|
+
security:
|
|
88156
|
+
- apiKeyAuth: []
|
|
88157
|
+
appKeyAuth: []
|
|
88158
|
+
- AuthZ:
|
|
88159
|
+
- teams_read
|
|
88160
|
+
summary: Add a user to a team
|
|
86304
88161
|
tags:
|
|
86305
88162
|
- Teams
|
|
86306
88163
|
x-codegen-request-body-name: body
|
|
@@ -86308,10 +88165,16 @@ paths:
|
|
|
86308
88165
|
operator: OR
|
|
86309
88166
|
permissions:
|
|
86310
88167
|
- teams_read
|
|
86311
|
-
/api/v2/team/{team_id}/
|
|
86312
|
-
|
|
86313
|
-
description:
|
|
86314
|
-
|
|
88168
|
+
/api/v2/team/{team_id}/memberships/{user_id}:
|
|
88169
|
+
delete:
|
|
88170
|
+
description: 'Remove a user from a team.
|
|
88171
|
+
|
|
88172
|
+
|
|
88173
|
+
**Note**: Each team has a setting that determines who is allowed to modify
|
|
88174
|
+
membership of the team. The `user_access_manage` permission generally grants
|
|
88175
|
+
access to modify membership of any team. To get the full picture, see [Team
|
|
88176
|
+
Membership documentation](https://docs.datadoghq.com/account_management/teams/manage/#team-membership).'
|
|
88177
|
+
operationId: DeleteTeamMembership
|
|
86315
88178
|
parameters:
|
|
86316
88179
|
- description: None
|
|
86317
88180
|
in: path
|
|
@@ -86319,58 +88182,15 @@ paths:
|
|
|
86319
88182
|
required: true
|
|
86320
88183
|
schema:
|
|
86321
88184
|
type: string
|
|
86322
|
-
responses:
|
|
86323
|
-
'200':
|
|
86324
|
-
content:
|
|
86325
|
-
application/json:
|
|
86326
|
-
schema:
|
|
86327
|
-
$ref: '#/components/schemas/TeamLinksResponse'
|
|
86328
|
-
description: OK
|
|
86329
|
-
'403':
|
|
86330
|
-
$ref: '#/components/responses/ForbiddenResponse'
|
|
86331
|
-
'404':
|
|
86332
|
-
content:
|
|
86333
|
-
application/json:
|
|
86334
|
-
schema:
|
|
86335
|
-
$ref: '#/components/schemas/APIErrorResponse'
|
|
86336
|
-
description: API error response.
|
|
86337
|
-
'429':
|
|
86338
|
-
$ref: '#/components/responses/TooManyRequestsResponse'
|
|
86339
|
-
security:
|
|
86340
|
-
- apiKeyAuth: []
|
|
86341
|
-
appKeyAuth: []
|
|
86342
|
-
- AuthZ:
|
|
86343
|
-
- teams_read
|
|
86344
|
-
summary: Get links for a team
|
|
86345
|
-
tags:
|
|
86346
|
-
- Teams
|
|
86347
|
-
x-permission:
|
|
86348
|
-
operator: OR
|
|
86349
|
-
permissions:
|
|
86350
|
-
- teams_read
|
|
86351
|
-
post:
|
|
86352
|
-
description: Add a new link to a team.
|
|
86353
|
-
operationId: CreateTeamLink
|
|
86354
|
-
parameters:
|
|
86355
88185
|
- description: None
|
|
86356
88186
|
in: path
|
|
86357
|
-
name:
|
|
88187
|
+
name: user_id
|
|
86358
88188
|
required: true
|
|
86359
88189
|
schema:
|
|
86360
88190
|
type: string
|
|
86361
|
-
requestBody:
|
|
86362
|
-
content:
|
|
86363
|
-
application/json:
|
|
86364
|
-
schema:
|
|
86365
|
-
$ref: '#/components/schemas/TeamLinkCreateRequest'
|
|
86366
|
-
required: true
|
|
86367
88191
|
responses:
|
|
86368
|
-
'
|
|
86369
|
-
|
|
86370
|
-
application/json:
|
|
86371
|
-
schema:
|
|
86372
|
-
$ref: '#/components/schemas/TeamLinkResponse'
|
|
86373
|
-
description: OK
|
|
88192
|
+
'204':
|
|
88193
|
+
description: No Content
|
|
86374
88194
|
'403':
|
|
86375
88195
|
$ref: '#/components/responses/ForbiddenResponse'
|
|
86376
88196
|
'404':
|
|
@@ -86379,12 +88199,6 @@ paths:
|
|
|
86379
88199
|
schema:
|
|
86380
88200
|
$ref: '#/components/schemas/APIErrorResponse'
|
|
86381
88201
|
description: API error response.
|
|
86382
|
-
'422':
|
|
86383
|
-
content:
|
|
86384
|
-
application/json:
|
|
86385
|
-
schema:
|
|
86386
|
-
$ref: '#/components/schemas/APIErrorResponse'
|
|
86387
|
-
description: API error response.
|
|
86388
88202
|
'429':
|
|
86389
88203
|
$ref: '#/components/responses/TooManyRequestsResponse'
|
|
86390
88204
|
security:
|
|
@@ -86392,18 +88206,22 @@ paths:
|
|
|
86392
88206
|
appKeyAuth: []
|
|
86393
88207
|
- AuthZ:
|
|
86394
88208
|
- teams_read
|
|
86395
|
-
summary:
|
|
88209
|
+
summary: Remove a user from a team
|
|
86396
88210
|
tags:
|
|
86397
88211
|
- Teams
|
|
86398
|
-
x-codegen-request-body-name: body
|
|
86399
88212
|
x-permission:
|
|
86400
88213
|
operator: OR
|
|
86401
88214
|
permissions:
|
|
86402
88215
|
- teams_read
|
|
86403
|
-
|
|
86404
|
-
|
|
86405
|
-
|
|
86406
|
-
|
|
88216
|
+
patch:
|
|
88217
|
+
description: 'Update a user''s membership attributes on a team.
|
|
88218
|
+
|
|
88219
|
+
|
|
88220
|
+
**Note**: Each team has a setting that determines who is allowed to modify
|
|
88221
|
+
membership of the team. The `user_access_manage` permission generally grants
|
|
88222
|
+
access to modify membership of any team. To get the full picture, see [Team
|
|
88223
|
+
Membership documentation](https://docs.datadoghq.com/account_management/teams/manage/#team-membership).'
|
|
88224
|
+
operationId: UpdateTeamMembership
|
|
86407
88225
|
parameters:
|
|
86408
88226
|
- description: None
|
|
86409
88227
|
in: path
|
|
@@ -86413,13 +88231,23 @@ paths:
|
|
|
86413
88231
|
type: string
|
|
86414
88232
|
- description: None
|
|
86415
88233
|
in: path
|
|
86416
|
-
name:
|
|
88234
|
+
name: user_id
|
|
86417
88235
|
required: true
|
|
86418
88236
|
schema:
|
|
86419
88237
|
type: string
|
|
88238
|
+
requestBody:
|
|
88239
|
+
content:
|
|
88240
|
+
application/json:
|
|
88241
|
+
schema:
|
|
88242
|
+
$ref: '#/components/schemas/UserTeamUpdateRequest'
|
|
88243
|
+
required: true
|
|
86420
88244
|
responses:
|
|
86421
|
-
'
|
|
86422
|
-
|
|
88245
|
+
'200':
|
|
88246
|
+
content:
|
|
88247
|
+
application/json:
|
|
88248
|
+
schema:
|
|
88249
|
+
$ref: '#/components/schemas/UserTeamResponse'
|
|
88250
|
+
description: Represents a user's association to a team
|
|
86423
88251
|
'403':
|
|
86424
88252
|
$ref: '#/components/responses/ForbiddenResponse'
|
|
86425
88253
|
'404':
|
|
@@ -86435,16 +88263,17 @@ paths:
|
|
|
86435
88263
|
appKeyAuth: []
|
|
86436
88264
|
- AuthZ:
|
|
86437
88265
|
- teams_read
|
|
86438
|
-
summary:
|
|
88266
|
+
summary: Update a user's membership attributes on a team
|
|
86439
88267
|
tags:
|
|
86440
88268
|
- Teams
|
|
88269
|
+
x-codegen-request-body-name: body
|
|
86441
88270
|
x-permission:
|
|
86442
88271
|
operator: OR
|
|
86443
88272
|
permissions:
|
|
86444
88273
|
- teams_read
|
|
88274
|
+
/api/v2/team/{team_id}/notification-rules:
|
|
86445
88275
|
get:
|
|
86446
|
-
|
|
86447
|
-
operationId: GetTeamLink
|
|
88276
|
+
operationId: GetTeamNotificationRules
|
|
86448
88277
|
parameters:
|
|
86449
88278
|
- description: None
|
|
86450
88279
|
in: path
|
|
@@ -86452,18 +88281,12 @@ paths:
|
|
|
86452
88281
|
required: true
|
|
86453
88282
|
schema:
|
|
86454
88283
|
type: string
|
|
86455
|
-
- description: None
|
|
86456
|
-
in: path
|
|
86457
|
-
name: link_id
|
|
86458
|
-
required: true
|
|
86459
|
-
schema:
|
|
86460
|
-
type: string
|
|
86461
88284
|
responses:
|
|
86462
88285
|
'200':
|
|
86463
88286
|
content:
|
|
86464
88287
|
application/json:
|
|
86465
88288
|
schema:
|
|
86466
|
-
$ref: '#/components/schemas/
|
|
88289
|
+
$ref: '#/components/schemas/TeamNotificationRulesResponse'
|
|
86467
88290
|
description: OK
|
|
86468
88291
|
'403':
|
|
86469
88292
|
$ref: '#/components/responses/ForbiddenResponse'
|
|
@@ -86480,16 +88303,15 @@ paths:
|
|
|
86480
88303
|
appKeyAuth: []
|
|
86481
88304
|
- AuthZ:
|
|
86482
88305
|
- teams_read
|
|
86483
|
-
summary: Get
|
|
88306
|
+
summary: Get team notification rules
|
|
86484
88307
|
tags:
|
|
86485
88308
|
- Teams
|
|
86486
88309
|
x-permission:
|
|
86487
88310
|
operator: OR
|
|
86488
88311
|
permissions:
|
|
86489
88312
|
- teams_read
|
|
86490
|
-
|
|
86491
|
-
|
|
86492
|
-
operationId: UpdateTeamLink
|
|
88313
|
+
post:
|
|
88314
|
+
operationId: CreateTeamNotificationRule
|
|
86493
88315
|
parameters:
|
|
86494
88316
|
- description: None
|
|
86495
88317
|
in: path
|
|
@@ -86497,24 +88319,18 @@ paths:
|
|
|
86497
88319
|
required: true
|
|
86498
88320
|
schema:
|
|
86499
88321
|
type: string
|
|
86500
|
-
- description: None
|
|
86501
|
-
in: path
|
|
86502
|
-
name: link_id
|
|
86503
|
-
required: true
|
|
86504
|
-
schema:
|
|
86505
|
-
type: string
|
|
86506
88322
|
requestBody:
|
|
86507
88323
|
content:
|
|
86508
88324
|
application/json:
|
|
86509
88325
|
schema:
|
|
86510
|
-
$ref: '#/components/schemas/
|
|
88326
|
+
$ref: '#/components/schemas/TeamNotificationRuleRequest'
|
|
86511
88327
|
required: true
|
|
86512
88328
|
responses:
|
|
86513
|
-
'
|
|
88329
|
+
'201':
|
|
86514
88330
|
content:
|
|
86515
88331
|
application/json:
|
|
86516
88332
|
schema:
|
|
86517
|
-
$ref: '#/components/schemas/
|
|
88333
|
+
$ref: '#/components/schemas/TeamNotificationRuleResponse'
|
|
86518
88334
|
description: OK
|
|
86519
88335
|
'403':
|
|
86520
88336
|
$ref: '#/components/responses/ForbiddenResponse'
|
|
@@ -86524,56 +88340,7 @@ paths:
|
|
|
86524
88340
|
schema:
|
|
86525
88341
|
$ref: '#/components/schemas/APIErrorResponse'
|
|
86526
88342
|
description: API error response.
|
|
86527
|
-
'
|
|
86528
|
-
$ref: '#/components/responses/TooManyRequestsResponse'
|
|
86529
|
-
security:
|
|
86530
|
-
- apiKeyAuth: []
|
|
86531
|
-
appKeyAuth: []
|
|
86532
|
-
- AuthZ:
|
|
86533
|
-
- teams_read
|
|
86534
|
-
summary: Update a team link
|
|
86535
|
-
tags:
|
|
86536
|
-
- Teams
|
|
86537
|
-
x-codegen-request-body-name: body
|
|
86538
|
-
x-permission:
|
|
86539
|
-
operator: OR
|
|
86540
|
-
permissions:
|
|
86541
|
-
- teams_read
|
|
86542
|
-
/api/v2/team/{team_id}/memberships:
|
|
86543
|
-
get:
|
|
86544
|
-
description: Get a paginated list of members for a team
|
|
86545
|
-
operationId: GetTeamMemberships
|
|
86546
|
-
parameters:
|
|
86547
|
-
- description: None
|
|
86548
|
-
in: path
|
|
86549
|
-
name: team_id
|
|
86550
|
-
required: true
|
|
86551
|
-
schema:
|
|
86552
|
-
type: string
|
|
86553
|
-
- $ref: '#/components/parameters/PageSize'
|
|
86554
|
-
- $ref: '#/components/parameters/PageNumber'
|
|
86555
|
-
- description: Specifies the order of returned team memberships
|
|
86556
|
-
in: query
|
|
86557
|
-
name: sort
|
|
86558
|
-
required: false
|
|
86559
|
-
schema:
|
|
86560
|
-
$ref: '#/components/schemas/GetTeamMembershipsSort'
|
|
86561
|
-
- description: Search query, can be user email or name
|
|
86562
|
-
in: query
|
|
86563
|
-
name: filter[keyword]
|
|
86564
|
-
required: false
|
|
86565
|
-
schema:
|
|
86566
|
-
type: string
|
|
86567
|
-
responses:
|
|
86568
|
-
'200':
|
|
86569
|
-
content:
|
|
86570
|
-
application/json:
|
|
86571
|
-
schema:
|
|
86572
|
-
$ref: '#/components/schemas/UserTeamsResponse'
|
|
86573
|
-
description: Represents a user's association to a team
|
|
86574
|
-
'403':
|
|
86575
|
-
$ref: '#/components/responses/ForbiddenResponse'
|
|
86576
|
-
'404':
|
|
88343
|
+
'409':
|
|
86577
88344
|
content:
|
|
86578
88345
|
application/json:
|
|
86579
88346
|
schema:
|
|
@@ -86586,26 +88353,16 @@ paths:
|
|
|
86586
88353
|
appKeyAuth: []
|
|
86587
88354
|
- AuthZ:
|
|
86588
88355
|
- teams_read
|
|
86589
|
-
summary:
|
|
88356
|
+
summary: Create team notification rule
|
|
86590
88357
|
tags:
|
|
86591
88358
|
- Teams
|
|
86592
|
-
x-pagination:
|
|
86593
|
-
limitParam: page[size]
|
|
86594
|
-
pageParam: page[number]
|
|
86595
|
-
resultsPath: data
|
|
86596
88359
|
x-permission:
|
|
86597
88360
|
operator: OR
|
|
86598
88361
|
permissions:
|
|
86599
88362
|
- teams_read
|
|
86600
|
-
|
|
86601
|
-
|
|
86602
|
-
|
|
86603
|
-
|
|
86604
|
-
**Note**: Each team has a setting that determines who is allowed to modify
|
|
86605
|
-
membership of the team. The `user_access_manage` permission generally grants
|
|
86606
|
-
access to modify membership of any team. To get the full picture, see [Team
|
|
86607
|
-
Membership documentation](https://docs.datadoghq.com/account_management/teams/manage/#team-membership).'
|
|
86608
|
-
operationId: CreateTeamMembership
|
|
88363
|
+
/api/v2/team/{team_id}/notification-rules/{rule_id}:
|
|
88364
|
+
delete:
|
|
88365
|
+
operationId: DeleteTeamNotificationRule
|
|
86609
88366
|
parameters:
|
|
86610
88367
|
- description: None
|
|
86611
88368
|
in: path
|
|
@@ -86613,19 +88370,15 @@ paths:
|
|
|
86613
88370
|
required: true
|
|
86614
88371
|
schema:
|
|
86615
88372
|
type: string
|
|
86616
|
-
|
|
86617
|
-
|
|
86618
|
-
|
|
86619
|
-
schema:
|
|
86620
|
-
$ref: '#/components/schemas/UserTeamRequest'
|
|
88373
|
+
- description: None
|
|
88374
|
+
in: path
|
|
88375
|
+
name: rule_id
|
|
86621
88376
|
required: true
|
|
88377
|
+
schema:
|
|
88378
|
+
type: string
|
|
86622
88379
|
responses:
|
|
86623
|
-
'
|
|
86624
|
-
|
|
86625
|
-
application/json:
|
|
86626
|
-
schema:
|
|
86627
|
-
$ref: '#/components/schemas/UserTeamResponse'
|
|
86628
|
-
description: Represents a user's association to a team
|
|
88380
|
+
'204':
|
|
88381
|
+
description: No Content
|
|
86629
88382
|
'403':
|
|
86630
88383
|
$ref: '#/components/responses/ForbiddenResponse'
|
|
86631
88384
|
'404':
|
|
@@ -86634,12 +88387,6 @@ paths:
|
|
|
86634
88387
|
schema:
|
|
86635
88388
|
$ref: '#/components/schemas/APIErrorResponse'
|
|
86636
88389
|
description: API error response.
|
|
86637
|
-
'409':
|
|
86638
|
-
content:
|
|
86639
|
-
application/json:
|
|
86640
|
-
schema:
|
|
86641
|
-
$ref: '#/components/schemas/APIErrorResponse'
|
|
86642
|
-
description: API error response.
|
|
86643
88390
|
'429':
|
|
86644
88391
|
$ref: '#/components/responses/TooManyRequestsResponse'
|
|
86645
88392
|
security:
|
|
@@ -86647,24 +88394,15 @@ paths:
|
|
|
86647
88394
|
appKeyAuth: []
|
|
86648
88395
|
- AuthZ:
|
|
86649
88396
|
- teams_read
|
|
86650
|
-
summary:
|
|
88397
|
+
summary: Delete team notification rule
|
|
86651
88398
|
tags:
|
|
86652
88399
|
- Teams
|
|
86653
|
-
x-codegen-request-body-name: body
|
|
86654
88400
|
x-permission:
|
|
86655
88401
|
operator: OR
|
|
86656
88402
|
permissions:
|
|
86657
88403
|
- teams_read
|
|
86658
|
-
|
|
86659
|
-
|
|
86660
|
-
description: 'Remove a user from a team.
|
|
86661
|
-
|
|
86662
|
-
|
|
86663
|
-
**Note**: Each team has a setting that determines who is allowed to modify
|
|
86664
|
-
membership of the team. The `user_access_manage` permission generally grants
|
|
86665
|
-
access to modify membership of any team. To get the full picture, see [Team
|
|
86666
|
-
Membership documentation](https://docs.datadoghq.com/account_management/teams/manage/#team-membership).'
|
|
86667
|
-
operationId: DeleteTeamMembership
|
|
88404
|
+
get:
|
|
88405
|
+
operationId: GetTeamNotificationRule
|
|
86668
88406
|
parameters:
|
|
86669
88407
|
- description: None
|
|
86670
88408
|
in: path
|
|
@@ -86674,13 +88412,17 @@ paths:
|
|
|
86674
88412
|
type: string
|
|
86675
88413
|
- description: None
|
|
86676
88414
|
in: path
|
|
86677
|
-
name:
|
|
88415
|
+
name: rule_id
|
|
86678
88416
|
required: true
|
|
86679
88417
|
schema:
|
|
86680
88418
|
type: string
|
|
86681
88419
|
responses:
|
|
86682
|
-
'
|
|
86683
|
-
|
|
88420
|
+
'200':
|
|
88421
|
+
content:
|
|
88422
|
+
application/json:
|
|
88423
|
+
schema:
|
|
88424
|
+
$ref: '#/components/schemas/TeamNotificationRuleResponse'
|
|
88425
|
+
description: OK
|
|
86684
88426
|
'403':
|
|
86685
88427
|
$ref: '#/components/responses/ForbiddenResponse'
|
|
86686
88428
|
'404':
|
|
@@ -86696,22 +88438,15 @@ paths:
|
|
|
86696
88438
|
appKeyAuth: []
|
|
86697
88439
|
- AuthZ:
|
|
86698
88440
|
- teams_read
|
|
86699
|
-
summary:
|
|
88441
|
+
summary: Get team notification rule
|
|
86700
88442
|
tags:
|
|
86701
88443
|
- Teams
|
|
86702
88444
|
x-permission:
|
|
86703
88445
|
operator: OR
|
|
86704
88446
|
permissions:
|
|
86705
88447
|
- teams_read
|
|
86706
|
-
|
|
86707
|
-
|
|
86708
|
-
|
|
86709
|
-
|
|
86710
|
-
**Note**: Each team has a setting that determines who is allowed to modify
|
|
86711
|
-
membership of the team. The `user_access_manage` permission generally grants
|
|
86712
|
-
access to modify membership of any team. To get the full picture, see [Team
|
|
86713
|
-
Membership documentation](https://docs.datadoghq.com/account_management/teams/manage/#team-membership).'
|
|
86714
|
-
operationId: UpdateTeamMembership
|
|
88448
|
+
put:
|
|
88449
|
+
operationId: UpdateTeamNotificationRule
|
|
86715
88450
|
parameters:
|
|
86716
88451
|
- description: None
|
|
86717
88452
|
in: path
|
|
@@ -86721,7 +88456,7 @@ paths:
|
|
|
86721
88456
|
type: string
|
|
86722
88457
|
- description: None
|
|
86723
88458
|
in: path
|
|
86724
|
-
name:
|
|
88459
|
+
name: rule_id
|
|
86725
88460
|
required: true
|
|
86726
88461
|
schema:
|
|
86727
88462
|
type: string
|
|
@@ -86729,15 +88464,15 @@ paths:
|
|
|
86729
88464
|
content:
|
|
86730
88465
|
application/json:
|
|
86731
88466
|
schema:
|
|
86732
|
-
$ref: '#/components/schemas/
|
|
88467
|
+
$ref: '#/components/schemas/TeamNotificationRuleRequest'
|
|
86733
88468
|
required: true
|
|
86734
88469
|
responses:
|
|
86735
88470
|
'200':
|
|
86736
88471
|
content:
|
|
86737
88472
|
application/json:
|
|
86738
88473
|
schema:
|
|
86739
|
-
$ref: '#/components/schemas/
|
|
86740
|
-
description:
|
|
88474
|
+
$ref: '#/components/schemas/TeamNotificationRuleResponse'
|
|
88475
|
+
description: OK
|
|
86741
88476
|
'403':
|
|
86742
88477
|
$ref: '#/components/responses/ForbiddenResponse'
|
|
86743
88478
|
'404':
|
|
@@ -86753,10 +88488,9 @@ paths:
|
|
|
86753
88488
|
appKeyAuth: []
|
|
86754
88489
|
- AuthZ:
|
|
86755
88490
|
- teams_read
|
|
86756
|
-
summary: Update
|
|
88491
|
+
summary: Update team notification rule
|
|
86757
88492
|
tags:
|
|
86758
88493
|
- Teams
|
|
86759
|
-
x-codegen-request-body-name: body
|
|
86760
88494
|
x-permission:
|
|
86761
88495
|
operator: OR
|
|
86762
88496
|
permissions:
|
|
@@ -89116,6 +90850,18 @@ tags:
|
|
|
89116
90850
|
See the [Live Processes page](https://docs.datadoghq.com/infrastructure/process/)
|
|
89117
90851
|
for more information.
|
|
89118
90852
|
name: Processes
|
|
90853
|
+
- description: 'Send server-side events to Product Analytics. Server-Side Events Ingestion
|
|
90854
|
+
allows you to collect custom events
|
|
90855
|
+
|
|
90856
|
+
from any server-side source, and retains events for 15 months. Server-side events
|
|
90857
|
+
are helpful for understanding
|
|
90858
|
+
|
|
90859
|
+
causes of a funnel drop-off which are external to the client-side (for example,
|
|
90860
|
+
payment processing error).
|
|
90861
|
+
|
|
90862
|
+
See the [Product Analytics page](https://docs.datadoghq.com/product_analytics/)
|
|
90863
|
+
for more information.'
|
|
90864
|
+
name: Product Analytics
|
|
89119
90865
|
- description: Manage your Real User Monitoring (RUM) applications, and search or
|
|
89120
90866
|
aggregate your RUM events over HTTP. See the [RUM & Session Replay page](https://docs.datadoghq.com/real_user_monitoring/)
|
|
89121
90867
|
for more information
|