datadog_api_client 2.46.0 → 2.47.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.
Files changed (141) hide show
  1. checksums.yaml +4 -4
  2. data/.generator/schemas/v1/openapi.yaml +105 -7
  3. data/.generator/schemas/v2/openapi.yaml +1285 -324
  4. data/CHANGELOG.md +26 -0
  5. data/examples/v1/dashboards/CreateDashboard_3685886950.rb +36 -0
  6. data/examples/v1/dashboards/CreateDashboard_865807520.rb +36 -0
  7. data/examples/v1/dashboards/CreateDashboard_9836563.rb +118 -0
  8. data/examples/v2/apm/GetServiceList.rb +5 -0
  9. data/examples/v2/aws-integration/CreateAWSAccount.rb +11 -0
  10. data/examples/v2/aws-integration/CreateAWSAccount_1716720881.rb +11 -0
  11. data/examples/v2/aws-integration/UpdateAWSAccount.rb +11 -0
  12. data/examples/v2/csm-threats/CreateCSMThreatsAgentRule_1295653933.rb +3 -1
  13. data/examples/v2/csm-threats/CreateCSMThreatsAgentRule_1363354233.rb +1 -1
  14. data/examples/v2/deployment-gates/GetDeploymentGateRules.rb +11 -0
  15. data/examples/v2/events/CreateEvent.rb +1 -0
  16. data/examples/v2/observability-pipelines/CreatePipeline.rb +12 -4
  17. data/examples/v2/observability-pipelines/UpdatePipeline.rb +12 -4
  18. data/examples/v2/observability-pipelines/ValidatePipeline.rb +12 -4
  19. data/examples/v2/on-call/CreateUserNotificationChannel.rb +23 -0
  20. data/examples/v2/on-call/DeleteUserNotificationChannel.rb +11 -0
  21. data/examples/v2/on-call/GetUserNotificationChannel.rb +11 -0
  22. data/examples/v2/on-call/ListUserNotificationChannels.rb +8 -0
  23. data/examples/v2/security-monitoring/CreateCases.rb +2 -2
  24. data/examples/v2/security-monitoring/CreateCases_2385516013.rb +1 -1
  25. data/examples/v2/security-monitoring/CreateCases_2798851680.rb +2 -2
  26. data/examples/v2/security-monitoring/CreateJiraIssues.rb +14 -69
  27. data/examples/v2/security-monitoring/GetSecretsRules.rb +1 -1
  28. data/examples/v2/security-monitoring/GetSuppressionVersionHistory.rb +8 -0
  29. data/examples/v2/security-monitoring/ValidateSecurityMonitoringRule_2609327779.rb +54 -0
  30. data/lib/datadog_api_client/configuration.rb +4 -3
  31. data/lib/datadog_api_client/inflector.rb +43 -6
  32. data/lib/datadog_api_client/v1/models/formula_and_function_metric_query_definition.rb +13 -3
  33. data/lib/datadog_api_client/v1/models/formula_and_function_metric_semantic_mode.rb +27 -0
  34. data/lib/datadog_api_client/v1/models/geomap_widget_definition.rb +4 -5
  35. data/lib/datadog_api_client/v1/models/geomap_widget_definition_view.rb +1 -1
  36. data/lib/datadog_api_client/v1/models/geomap_widget_request.rb +37 -3
  37. data/lib/datadog_api_client/v1/models/geomap_widget_request_style.rb +105 -0
  38. data/lib/datadog_api_client/v1/models/monitor_search_response.rb +1 -1
  39. data/lib/datadog_api_client/v1/models/usage_summary_date.rb +41 -1
  40. data/lib/datadog_api_client/v1/models/usage_summary_date_org.rb +41 -1
  41. data/lib/datadog_api_client/v1/models/usage_summary_response.rb +41 -1
  42. data/lib/datadog_api_client/v2/api/apm_api.rb +83 -0
  43. data/lib/datadog_api_client/v2/api/deployment_gates_api.rb +71 -0
  44. data/lib/datadog_api_client/v2/api/incidents_api.rb +0 -18
  45. data/lib/datadog_api_client/v2/api/on_call_api.rb +277 -0
  46. data/lib/datadog_api_client/v2/api/security_monitoring_api.rb +99 -11
  47. data/lib/datadog_api_client/v2/api/teams_api.rb +6 -0
  48. data/lib/datadog_api_client/v2/models/attach_case_request_data.rb +1 -1
  49. data/lib/datadog_api_client/v2/models/attach_jira_issue_request_data.rb +1 -11
  50. data/lib/datadog_api_client/v2/models/attach_jira_issue_request_data_attributes.rb +1 -1
  51. data/lib/datadog_api_client/v2/models/aws_account_create_request_attributes.rb +11 -1
  52. data/lib/datadog_api_client/v2/models/aws_account_response_attributes.rb +11 -1
  53. data/lib/datadog_api_client/v2/models/aws_account_update_request_attributes.rb +11 -1
  54. data/lib/datadog_api_client/v2/models/awsccm_config.rb +107 -0
  55. data/lib/datadog_api_client/v2/models/case_insights_items.rb +3 -3
  56. data/lib/datadog_api_client/v2/models/case_management_project_data.rb +1 -1
  57. data/lib/datadog_api_client/v2/models/cloud_workload_security_agent_policy_attributes.rb +11 -1
  58. data/lib/datadog_api_client/v2/models/cloud_workload_security_agent_policy_version.rb +2 -2
  59. data/lib/datadog_api_client/v2/models/cloud_workload_security_agent_rule_action.rb +2 -2
  60. data/lib/datadog_api_client/v2/models/cloud_workload_security_agent_rule_action_hash.rb +105 -0
  61. data/lib/datadog_api_client/v2/models/cloud_workload_security_agent_rule_action_set.rb +1 -1
  62. data/lib/datadog_api_client/v2/models/{create_jira_issue_request_array_included.rb → cloud_workload_security_agent_rule_action_set_value.rb} +5 -5
  63. data/lib/datadog_api_client/v2/models/create_case_request_data.rb +1 -11
  64. data/lib/datadog_api_client/v2/models/create_case_request_data_attributes.rb +3 -3
  65. data/lib/datadog_api_client/v2/models/create_email_notification_channel_config.rb +167 -0
  66. data/lib/datadog_api_client/v2/models/create_jira_issue_request_array.rb +3 -15
  67. data/lib/datadog_api_client/v2/models/create_jira_issue_request_data.rb +1 -11
  68. data/lib/datadog_api_client/v2/models/create_jira_issue_request_data_attributes.rb +43 -3
  69. data/lib/datadog_api_client/v2/models/create_jira_issue_request_data_relationships.rb +35 -14
  70. data/lib/datadog_api_client/v2/models/create_notification_channel_attributes.rb +105 -0
  71. data/lib/datadog_api_client/v2/models/create_notification_channel_config.rb +63 -0
  72. data/lib/datadog_api_client/v2/models/create_notification_channel_data.rb +133 -0
  73. data/lib/datadog_api_client/v2/models/create_phone_notification_channel_config.rb +144 -0
  74. data/lib/datadog_api_client/v2/models/{create_jira_issue_request_data_relationships_case.rb → create_user_notification_channel_request.rb} +5 -5
  75. data/lib/datadog_api_client/v2/models/data_export_config.rb +145 -0
  76. data/lib/datadog_api_client/v2/models/deployment_gate_rules_response.rb +105 -0
  77. data/lib/datadog_api_client/v2/models/detach_case_request_data.rb +1 -11
  78. data/lib/datadog_api_client/v2/models/event_payload.rb +26 -1
  79. data/lib/datadog_api_client/v2/models/finding_case_response_data.rb +1 -1
  80. data/lib/datadog_api_client/v2/models/finding_data.rb +1 -1
  81. data/lib/datadog_api_client/v2/models/finding_jira_issue.rb +2 -2
  82. data/lib/datadog_api_client/v2/models/finding_jira_issue_result.rb +4 -4
  83. data/lib/datadog_api_client/v2/models/get_suppression_version_history_data.rb +125 -0
  84. data/lib/datadog_api_client/v2/models/get_suppression_version_history_data_type.rb +26 -0
  85. data/lib/datadog_api_client/v2/models/get_suppression_version_history_response.rb +105 -0
  86. data/lib/datadog_api_client/v2/models/library.rb +13 -1
  87. data/lib/datadog_api_client/v2/models/list_deployment_rule_response_data.rb +165 -0
  88. data/lib/datadog_api_client/v2/models/list_deployment_rules_data_type.rb +26 -0
  89. data/lib/datadog_api_client/v2/models/{create_jira_issue_request_data_attributes_fields.rb → list_deployment_rules_response_data_attributes.rb} +12 -10
  90. data/lib/datadog_api_client/v2/models/list_notification_channels_response.rb +107 -0
  91. data/lib/datadog_api_client/v2/models/notification_channel.rb +105 -0
  92. data/lib/datadog_api_client/v2/models/notification_channel_attributes.rb +115 -0
  93. data/lib/datadog_api_client/v2/models/notification_channel_config.rb +64 -0
  94. data/lib/datadog_api_client/v2/models/notification_channel_data.rb +143 -0
  95. data/lib/datadog_api_client/v2/models/notification_channel_email_config.rb +167 -0
  96. data/lib/datadog_api_client/v2/models/notification_channel_email_config_type.rb +26 -0
  97. data/lib/datadog_api_client/v2/models/notification_channel_email_format_type.rb +27 -0
  98. data/lib/datadog_api_client/v2/models/notification_channel_phone_config.rb +225 -0
  99. data/lib/datadog_api_client/v2/models/notification_channel_phone_config_type.rb +26 -0
  100. data/lib/datadog_api_client/v2/models/notification_channel_push_config.rb +165 -0
  101. data/lib/datadog_api_client/v2/models/notification_channel_push_config_type.rb +26 -0
  102. data/lib/datadog_api_client/v2/models/notification_channel_type.rb +26 -0
  103. data/lib/datadog_api_client/v2/models/observability_pipeline_add_env_vars_processor.rb +22 -24
  104. data/lib/datadog_api_client/v2/models/observability_pipeline_add_fields_processor.rb +22 -24
  105. data/lib/datadog_api_client/v2/models/observability_pipeline_config.rb +2 -2
  106. data/lib/datadog_api_client/v2/models/observability_pipeline_config_processor_group.rb +211 -0
  107. data/lib/datadog_api_client/v2/models/observability_pipeline_custom_processor.rb +22 -24
  108. data/lib/datadog_api_client/v2/models/observability_pipeline_custom_processor_remap.rb +1 -12
  109. data/lib/datadog_api_client/v2/models/observability_pipeline_datadog_tags_processor.rb +22 -24
  110. data/lib/datadog_api_client/v2/models/observability_pipeline_dedupe_processor.rb +22 -24
  111. data/lib/datadog_api_client/v2/models/observability_pipeline_enrichment_table_processor.rb +22 -24
  112. data/lib/datadog_api_client/v2/models/observability_pipeline_filter_processor.rb +22 -24
  113. data/lib/datadog_api_client/v2/models/observability_pipeline_generate_metrics_processor.rb +24 -48
  114. data/lib/datadog_api_client/v2/models/observability_pipeline_ocsf_mapper_processor.rb +22 -24
  115. data/lib/datadog_api_client/v2/models/observability_pipeline_parse_grok_processor.rb +22 -24
  116. data/lib/datadog_api_client/v2/models/observability_pipeline_parse_json_processor.rb +22 -24
  117. data/lib/datadog_api_client/v2/models/observability_pipeline_quota_processor.rb +18 -31
  118. data/lib/datadog_api_client/v2/models/observability_pipeline_reduce_processor.rb +22 -24
  119. data/lib/datadog_api_client/v2/models/observability_pipeline_remove_fields_processor.rb +22 -24
  120. data/lib/datadog_api_client/v2/models/observability_pipeline_rename_fields_processor.rb +22 -24
  121. data/lib/datadog_api_client/v2/models/observability_pipeline_sample_processor.rb +22 -24
  122. data/lib/datadog_api_client/v2/models/observability_pipeline_sensitive_data_scanner_processor.rb +22 -24
  123. data/lib/datadog_api_client/v2/models/observability_pipeline_throttle_processor.rb +22 -24
  124. data/lib/datadog_api_client/v2/models/rule_versions.rb +1 -1
  125. data/lib/datadog_api_client/v2/models/security_monitoring_rule_new_value_options.rb +11 -1
  126. data/lib/datadog_api_client/v2/models/service_list.rb +105 -0
  127. data/lib/datadog_api_client/v2/models/{create_jira_issue_request_data_relationships_case_data.rb → service_list_data.rb} +17 -18
  128. data/lib/datadog_api_client/v2/models/service_list_data_attributes.rb +119 -0
  129. data/lib/datadog_api_client/v2/models/service_list_data_attributes_metadata_items.rb +115 -0
  130. data/lib/datadog_api_client/v2/models/service_list_data_type.rb +26 -0
  131. data/lib/datadog_api_client/v2/models/suppression_version_history.rb +133 -0
  132. data/lib/datadog_api_client/v2/models/suppression_versions.rb +117 -0
  133. data/lib/datadog_api_client/v2/models/{rule_version_update.rb → version_history_update.rb} +3 -3
  134. data/lib/datadog_api_client/v2/models/{rule_version_update_type.rb → version_history_update_type.rb} +1 -1
  135. data/lib/datadog_api_client/v2/models/vulnerability_attributes.rb +11 -1
  136. data/lib/datadog_api_client/v2/models/vulnerability_ecosystem.rb +6 -1
  137. data/lib/datadog_api_client/v2/models/vulnerability_tool.rb +1 -0
  138. data/lib/datadog_api_client/version.rb +1 -1
  139. metadata +55 -9
  140. data/examples/v2/security-monitoring/CreateJiraIssues_379590688.rb +0 -56
  141. data/examples/v2/security-monitoring/CreateJiraIssues_829823123.rb +0 -64
@@ -1496,6 +1496,8 @@ components:
1496
1496
  $ref: '#/components/schemas/AWSAccountPartition'
1497
1497
  aws_regions:
1498
1498
  $ref: '#/components/schemas/AWSRegions'
1499
+ ccm_config:
1500
+ $ref: '#/components/schemas/AWSCCMConfig'
1499
1501
  logs_config:
1500
1502
  $ref: '#/components/schemas/AWSLogsConfig'
1501
1503
  metrics_config:
@@ -1561,6 +1563,8 @@ components:
1561
1563
  $ref: '#/components/schemas/AWSAccountPartition'
1562
1564
  aws_regions:
1563
1565
  $ref: '#/components/schemas/AWSRegions'
1566
+ ccm_config:
1567
+ $ref: '#/components/schemas/AWSCCMConfig'
1564
1568
  created_at:
1565
1569
  description: Timestamp of when the account integration was created.
1566
1570
  format: date-time
@@ -1634,6 +1638,8 @@ components:
1634
1638
  $ref: '#/components/schemas/AWSAccountPartition'
1635
1639
  aws_regions:
1636
1640
  $ref: '#/components/schemas/AWSRegions'
1641
+ ccm_config:
1642
+ $ref: '#/components/schemas/AWSCCMConfig'
1637
1643
  logs_config:
1638
1644
  $ref: '#/components/schemas/AWSLogsConfig'
1639
1645
  metrics_config:
@@ -1765,6 +1771,15 @@ components:
1765
1771
  required:
1766
1772
  - role_name
1767
1773
  type: object
1774
+ AWSCCMConfig:
1775
+ description: AWS Cloud Cost Management config.
1776
+ properties:
1777
+ data_export_configs:
1778
+ description: List of data export configurations for Cost and Usage Reports.
1779
+ items:
1780
+ $ref: '#/components/schemas/DataExportConfig'
1781
+ type: array
1782
+ type: object
1768
1783
  AWSCredentials:
1769
1784
  description: The definition of `AWSCredentials` object.
1770
1785
  oneOf:
@@ -5280,7 +5295,7 @@ components:
5280
5295
  description: Data of the case to attach security findings to.
5281
5296
  properties:
5282
5297
  id:
5283
- description: The unique identifier of the case.
5298
+ description: Unique identifier of the case.
5284
5299
  example: c1234567-89ab-cdef-0123-456789abcdef
5285
5300
  type: string
5286
5301
  relationships:
@@ -5311,10 +5326,6 @@ components:
5311
5326
  properties:
5312
5327
  attributes:
5313
5328
  $ref: '#/components/schemas/AttachJiraIssueRequestDataAttributes'
5314
- id:
5315
- description: The unique identifier of the Jira issue attachment request.
5316
- example: j1234567-89ab-cdef-0123-456789abcdef
5317
- type: string
5318
5329
  relationships:
5319
5330
  $ref: '#/components/schemas/AttachJiraIssueRequestDataRelationships'
5320
5331
  type:
@@ -5326,7 +5337,7 @@ components:
5326
5337
  description: Attributes of the Jira issue to attach security findings to.
5327
5338
  properties:
5328
5339
  jira_issue_url:
5329
- description: The URL of the Jira issue to attach security findings to.
5340
+ description: URL of the Jira issue to attach security findings to.
5330
5341
  example: https://domain.atlassian.net/browse/PROJ-123
5331
5342
  type: string
5332
5343
  required:
@@ -5337,8 +5348,12 @@ components:
5337
5348
  properties:
5338
5349
  findings:
5339
5350
  $ref: '#/components/schemas/Findings'
5351
+ description: Security findings to attach to the Jira issue.
5340
5352
  project:
5341
5353
  $ref: '#/components/schemas/CaseManagementProject'
5354
+ description: Case management project with Jira integration configured. It
5355
+ is used to attach security findings to the Jira issue. To configure the
5356
+ integration, see [Bidirectional ticket syncing with Jira](https://docs.datadoghq.com/security/ticketing_integrations/#bidirectional-ticket-syncing-with-jira).
5342
5357
  required:
5343
5358
  - findings
5344
5359
  - project
@@ -9110,17 +9125,17 @@ components:
9110
9125
  description: An insight of the case.
9111
9126
  properties:
9112
9127
  ref:
9113
- description: The reference of the insight.
9128
+ description: Reference of the insight.
9114
9129
  example: /security/appsec/vm/library/vulnerability/dfa027f7c037b2f77159adc027fecb56?detection=static
9115
9130
  type: string
9116
9131
  resource_id:
9117
- description: The unique identifier of the resource. For example, the unique
9132
+ description: Unique identifier of the resource. For example, the unique
9118
9133
  identifier of a security finding.
9119
9134
  example: ZGVmLTAwcC1pZXJ-aS0wZjhjNjMyZDNmMzRlZTgzNw==
9120
9135
  type: string
9121
9136
  type:
9122
- description: The type of the resource. For example, the type of a security
9123
- finding is "SECURITY_FINDING".
9137
+ description: Type of the resource. For example, the type of a security finding
9138
+ is "SECURITY_FINDING".
9124
9139
  example: SECURITY_FINDING
9125
9140
  type: string
9126
9141
  type: object
@@ -9135,7 +9150,7 @@ components:
9135
9150
  CaseManagementProjectData:
9136
9151
  properties:
9137
9152
  id:
9138
- description: The unique identifier of the case management project.
9153
+ description: Unique identifier of the case management project.
9139
9154
  example: aeadc05e-98a8-11ec-ac2c-da7ad0900001
9140
9155
  type: string
9141
9156
  type:
@@ -10243,6 +10258,10 @@ components:
10243
10258
  description: Whether the policy is pinned
10244
10259
  example: false
10245
10260
  type: boolean
10261
+ policyType:
10262
+ description: The type of the policy
10263
+ example: policy
10264
+ type: string
10246
10265
  policyVersion:
10247
10266
  description: The version of the policy
10248
10267
  example: '1'
@@ -10421,11 +10440,11 @@ components:
10421
10440
  CloudWorkloadSecurityAgentPolicyVersion:
10422
10441
  description: The versions of the policy
10423
10442
  properties:
10424
- Date:
10443
+ date:
10425
10444
  description: The date and time the version was created
10426
10445
  nullable: true
10427
10446
  type: string
10428
- Name:
10447
+ name:
10429
10448
  description: The version of the policy
10430
10449
  example: 1.47.0-rc2
10431
10450
  type: string
@@ -10452,8 +10471,11 @@ components:
10452
10471
  $ref: '#/components/schemas/CloudWorkloadSecurityAgentRuleActionSet'
10453
10472
  type: object
10454
10473
  CloudWorkloadSecurityAgentRuleActionHash:
10455
- additionalProperties: {}
10456
- description: An empty object indicating the hash action
10474
+ description: Hash file specified by the field attribute
10475
+ properties:
10476
+ field:
10477
+ description: The field of the hash action
10478
+ type: string
10457
10479
  type: object
10458
10480
  CloudWorkloadSecurityAgentRuleActionMetadata:
10459
10481
  description: The metadata action applied on the scope matching the rule
@@ -10501,9 +10523,14 @@ components:
10501
10523
  format: int64
10502
10524
  type: integer
10503
10525
  value:
10504
- description: The value of the set action
10505
- type: string
10526
+ $ref: '#/components/schemas/CloudWorkloadSecurityAgentRuleActionSetValue'
10506
10527
  type: object
10528
+ CloudWorkloadSecurityAgentRuleActionSetValue:
10529
+ description: The value of the set action
10530
+ oneOf:
10531
+ - type: string
10532
+ - type: integer
10533
+ - type: boolean
10507
10534
  CloudWorkloadSecurityAgentRuleActions:
10508
10535
  description: The array of actions the rule can perform if triggered
10509
10536
  items:
@@ -12882,10 +12909,6 @@ components:
12882
12909
  properties:
12883
12910
  attributes:
12884
12911
  $ref: '#/components/schemas/CreateCaseRequestDataAttributes'
12885
- id:
12886
- description: The unique identifier of the case.
12887
- example: c1234567-89ab-cdef-0123-456789abcdef
12888
- type: string
12889
12912
  relationships:
12890
12913
  $ref: '#/components/schemas/CreateCaseRequestDataRelationships'
12891
12914
  type:
@@ -12897,21 +12920,21 @@ components:
12897
12920
  description: Attributes of the case to create.
12898
12921
  properties:
12899
12922
  assignee_id:
12900
- description: The unique identifier of the user assigned to the case.
12923
+ description: Unique identifier of the user assigned to the case.
12901
12924
  example: f315bdaf-9ee7-4808-a9c1-99c15bf0f4d0
12902
12925
  type: string
12903
12926
  description:
12904
- description: The description of the case. If not provided, the description
12905
- will be automatically generated.
12927
+ description: Description of the case. If not provided, the description will
12928
+ be automatically generated.
12906
12929
  example: A description of the case.
12907
12930
  type: string
12908
12931
  priority:
12909
12932
  $ref: '#/components/schemas/CasePriority'
12910
- description: The priority of the case. If not provided, the priority will
12911
- be automatically set to "NOT_DEFINED".
12933
+ description: Priority of the case. If not provided, the priority will be
12934
+ automatically set to "NOT_DEFINED".
12912
12935
  example: P4
12913
12936
  title:
12914
- description: The title of the case. If not provided, the title will be automatically
12937
+ description: Title of the case. If not provided, the title will be automatically
12915
12938
  generated.
12916
12939
  example: A title for the case.
12917
12940
  type: string
@@ -12921,10 +12944,10 @@ components:
12921
12944
  properties:
12922
12945
  findings:
12923
12946
  $ref: '#/components/schemas/Findings'
12924
- description: Security findings of the case to create.
12947
+ description: Security findings to create a case for.
12925
12948
  project:
12926
12949
  $ref: '#/components/schemas/CaseManagementProject'
12927
- description: Project of the case to create.
12950
+ description: Case management project in which the case will be created.
12928
12951
  required:
12929
12952
  - findings
12930
12953
  - project
@@ -13184,6 +13207,27 @@ components:
13184
13207
  - options
13185
13208
  - type
13186
13209
  type: object
13210
+ CreateEmailNotificationChannelConfig:
13211
+ description: Configuration to create an e-mail notification channel
13212
+ properties:
13213
+ address:
13214
+ description: The e-mail address to be notified
13215
+ example: ''
13216
+ type: string
13217
+ formats:
13218
+ description: Preferred content formats for notifications.
13219
+ example:
13220
+ - html
13221
+ items:
13222
+ $ref: '#/components/schemas/NotificationChannelEmailFormatType'
13223
+ type: array
13224
+ type:
13225
+ $ref: '#/components/schemas/NotificationChannelEmailConfigType'
13226
+ required:
13227
+ - type
13228
+ - address
13229
+ - formats
13230
+ type: object
13187
13231
  CreateIncidentNotificationRuleRequest:
13188
13232
  description: Create request for a notification rule.
13189
13233
  properties:
@@ -13207,29 +13251,14 @@ components:
13207
13251
  items:
13208
13252
  $ref: '#/components/schemas/CreateJiraIssueRequestData'
13209
13253
  type: array
13210
- included:
13211
- items:
13212
- $ref: '#/components/schemas/CreateJiraIssueRequestArrayIncluded'
13213
- type: array
13214
13254
  required:
13215
13255
  - data
13216
13256
  type: object
13217
- CreateJiraIssueRequestArrayIncluded:
13218
- description: 'Attributes and relationships of the case linked to the Jira issue.
13219
- Should contain all of the following: case, project, and security findings.'
13220
- oneOf:
13221
- - $ref: '#/components/schemas/CreateCaseRequestData'
13222
- - $ref: '#/components/schemas/CaseManagementProjectData'
13223
- - $ref: '#/components/schemas/FindingData'
13224
13257
  CreateJiraIssueRequestData:
13225
13258
  description: Data of the Jira issue to create.
13226
13259
  properties:
13227
13260
  attributes:
13228
13261
  $ref: '#/components/schemas/CreateJiraIssueRequestDataAttributes'
13229
- id:
13230
- description: The unique identifier of the Jira issue creation request.
13231
- example: j1234567-89ab-cdef-0123-456789abcdef
13232
- type: string
13233
13262
  relationships:
13234
13263
  $ref: '#/components/schemas/CreateJiraIssueRequestDataRelationships'
13235
13264
  type:
@@ -13240,48 +13269,74 @@ components:
13240
13269
  CreateJiraIssueRequestDataAttributes:
13241
13270
  description: Attributes of the Jira issue to create.
13242
13271
  properties:
13272
+ assignee_id:
13273
+ description: Unique identifier of the user assigned to the Jira issue.
13274
+ example: f315bdaf-9ee7-4808-a9c1-99c15bf0f4d0
13275
+ type: string
13276
+ description:
13277
+ description: Description of the Jira issue. If not provided, the description
13278
+ will be automatically generated.
13279
+ example: A description of the Jira issue.
13280
+ type: string
13243
13281
  fields:
13244
- $ref: '#/components/schemas/CreateJiraIssueRequestDataAttributesFields'
13245
- type: object
13246
- CreateJiraIssueRequestDataAttributesFields:
13247
- description: Custom fields of the Jira issue to create. For the list of available
13248
- fields, see [Jira documentation](https://developer.atlassian.com/cloud/jira/platform/rest/v2/api-group-issues/#api-rest-api-2-issue-createmeta-projectidorkey-issuetypes-issuetypeid-get).
13249
- properties:
13250
- fields:
13282
+ additionalProperties: {}
13283
+ description: Custom fields of the Jira issue to create. For the list of
13284
+ available fields, see [Jira documentation](https://developer.atlassian.com/cloud/jira/platform/rest/v2/api-group-issues/#api-rest-api-2-issue-createmeta-projectidorkey-issuetypes-issuetypeid-get).
13251
13285
  example:
13252
- customfield_10001: Value 1
13253
- customfield_10002:
13254
- - Value 2
13255
- - Value 3
13286
+ key1: value
13287
+ key2:
13288
+ - value
13289
+ key3:
13290
+ key4: value
13256
13291
  type: object
13292
+ priority:
13293
+ $ref: '#/components/schemas/CasePriority'
13294
+ description: Priority of the Jira issue. If not provided, the priority will
13295
+ be automatically set to "NOT_DEFINED".
13296
+ example: P4
13297
+ title:
13298
+ description: Title of the Jira issue. If not provided, the title will be
13299
+ automatically generated.
13300
+ example: A title for the Jira issue.
13301
+ type: string
13257
13302
  type: object
13258
13303
  CreateJiraIssueRequestDataRelationships:
13259
13304
  description: Relationships of the Jira issue to create.
13260
13305
  properties:
13261
- case:
13262
- $ref: '#/components/schemas/CreateJiraIssueRequestDataRelationshipsCase'
13306
+ findings:
13307
+ $ref: '#/components/schemas/Findings'
13308
+ description: Security findings to create a Jira issue for.
13309
+ project:
13310
+ $ref: '#/components/schemas/CaseManagementProject'
13311
+ description: Case management project configured with the Jira integration.
13312
+ It is used to create the Jira issue. To configure the Jira integration,
13313
+ see [Bidirectional ticket syncing with Jira](https://docs.datadoghq.com/security/ticketing_integrations/#bidirectional-ticket-syncing-with-jira).
13263
13314
  required:
13264
- - case
13315
+ - findings
13316
+ - project
13265
13317
  type: object
13266
- CreateJiraIssueRequestDataRelationshipsCase:
13267
- description: Case linked to the Jira issue.
13318
+ CreateNotificationChannelAttributes:
13319
+ description: Attributes for creating an on-call notification channel.
13268
13320
  properties:
13269
- data:
13270
- $ref: '#/components/schemas/CreateJiraIssueRequestDataRelationshipsCaseData'
13271
- required:
13272
- - data
13321
+ config:
13322
+ $ref: '#/components/schemas/CreateNotificationChannelConfig'
13323
+ description: Notification channel configuration
13273
13324
  type: object
13274
- CreateJiraIssueRequestDataRelationshipsCaseData:
13275
- description: Case linked to the Jira issue.
13325
+ CreateNotificationChannelConfig:
13326
+ description: Defines the configuration for creating an On-Call notification
13327
+ channel
13328
+ oneOf:
13329
+ - $ref: '#/components/schemas/CreatePhoneNotificationChannelConfig'
13330
+ - $ref: '#/components/schemas/CreateEmailNotificationChannelConfig'
13331
+ CreateNotificationChannelData:
13332
+ description: Data for creating an on-call notification channel
13276
13333
  properties:
13277
- id:
13278
- example: c1234567-89ab-cdef-0123-456789abcdef
13279
- type: string
13334
+ attributes:
13335
+ $ref: '#/components/schemas/CreateNotificationChannelAttributes'
13280
13336
  type:
13281
- $ref: '#/components/schemas/CaseDataType'
13337
+ $ref: '#/components/schemas/NotificationChannelType'
13282
13338
  required:
13283
13339
  - type
13284
- - id
13285
13340
  type: object
13286
13341
  CreateNotificationRuleParameters:
13287
13342
  description: Body of the notification rule create request.
@@ -13443,6 +13498,19 @@ components:
13443
13498
  type: string
13444
13499
  x-enum-varnames:
13445
13500
  - PAGES
13501
+ CreatePhoneNotificationChannelConfig:
13502
+ description: Configuration to create a phone notification channel
13503
+ properties:
13504
+ number:
13505
+ description: The E-164 formatted phone number (e.g. +3371234567)
13506
+ example: ''
13507
+ type: string
13508
+ type:
13509
+ $ref: '#/components/schemas/NotificationChannelPhoneConfigType'
13510
+ required:
13511
+ - type
13512
+ - number
13513
+ type: object
13446
13514
  CreateRuleRequest:
13447
13515
  description: Scorecard create rule request.
13448
13516
  properties:
@@ -14009,6 +14077,23 @@ components:
14009
14077
  type: string
14010
14078
  x-enum-varnames:
14011
14079
  - UPLOAD
14080
+ CreateUserNotificationChannelRequest:
14081
+ description: A top-level wrapper for creating a notification channel for a user
14082
+ example:
14083
+ data:
14084
+ attributes:
14085
+ config:
14086
+ address: foo@bar.com
14087
+ formats:
14088
+ - html
14089
+ type: email
14090
+ type: notification_channels
14091
+ properties:
14092
+ data:
14093
+ $ref: '#/components/schemas/CreateNotificationChannelData'
14094
+ required:
14095
+ - data
14096
+ type: object
14012
14097
  CreateWorkflowRequest:
14013
14098
  description: A request object for creating a new workflow.
14014
14099
  example:
@@ -15837,6 +15922,15 @@ components:
15837
15922
  type: object
15838
15923
  DORAListDeploymentsRequest:
15839
15924
  description: Request to get a list of deployments.
15925
+ example:
15926
+ data:
15927
+ attributes:
15928
+ from: '2025-01-01T00:00:00Z'
15929
+ limit: 100
15930
+ query: service:(shopist OR api-service) env:production team:backend
15931
+ sort: -started_at
15932
+ to: '2025-01-31T23:59:59Z'
15933
+ type: dora_deployments_list_request
15840
15934
  properties:
15841
15935
  data:
15842
15936
  $ref: '#/components/schemas/DORAListDeploymentsRequestData'
@@ -15845,6 +15939,13 @@ components:
15845
15939
  type: object
15846
15940
  DORAListDeploymentsRequestAttributes:
15847
15941
  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'
15848
15949
  properties:
15849
15950
  from:
15850
15951
  description: Minimum timestamp for requested events.
@@ -15869,6 +15970,14 @@ components:
15869
15970
  type: object
15870
15971
  DORAListDeploymentsRequestData:
15871
15972
  description: The JSON:API data.
15973
+ example:
15974
+ attributes:
15975
+ from: '2025-01-15T08:00:00Z'
15976
+ limit: 200
15977
+ query: env:production service:payment-service version:*v2*
15978
+ sort: -finished_at
15979
+ to: '2025-01-15T18:00:00Z'
15980
+ type: dora_deployments_list_request
15872
15981
  properties:
15873
15982
  attributes:
15874
15983
  $ref: '#/components/schemas/DORAListDeploymentsRequestAttributes'
@@ -15886,6 +15995,15 @@ components:
15886
15995
  - DORA_DEPLOYMENTS_LIST_REQUEST
15887
15996
  DORAListFailuresRequest:
15888
15997
  description: Request to get a list of failures.
15998
+ example:
15999
+ data:
16000
+ attributes:
16001
+ from: '2025-01-01T00:00:00Z'
16002
+ limit: 100
16003
+ query: severity:(SEV-1 OR SEV-2) env:production team:backend
16004
+ sort: -started_at
16005
+ to: '2025-01-31T23:59:59Z'
16006
+ type: dora_failures_list_request
15889
16007
  properties:
15890
16008
  data:
15891
16009
  $ref: '#/components/schemas/DORAListFailuresRequestData'
@@ -15894,6 +16012,13 @@ components:
15894
16012
  type: object
15895
16013
  DORAListFailuresRequestAttributes:
15896
16014
  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'
15897
16022
  properties:
15898
16023
  from:
15899
16024
  description: Minimum timestamp for requested events.
@@ -15918,6 +16043,14 @@ components:
15918
16043
  type: object
15919
16044
  DORAListFailuresRequestData:
15920
16045
  description: The JSON:API data.
16046
+ example:
16047
+ attributes:
16048
+ from: '2025-01-15T00:00:00Z'
16049
+ limit: 200
16050
+ query: severity:SEV-1 service:(api-service OR payment-service) env:production
16051
+ sort: -finished_at
16052
+ to: '2025-01-15T23:59:59Z'
16053
+ type: dora_failures_list_request
15921
16054
  properties:
15922
16055
  attributes:
15923
16056
  $ref: '#/components/schemas/DORAListFailuresRequestAttributes'
@@ -15935,6 +16068,39 @@ components:
15935
16068
  - DORA_FAILURES_LIST_REQUEST
15936
16069
  DORAListResponse:
15937
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
15938
16104
  properties:
15939
16105
  data:
15940
16106
  description: The list of DORA events.
@@ -16273,6 +16439,30 @@ components:
16273
16439
  example: canceled
16274
16440
  type: string
16275
16441
  type: object
16442
+ DataExportConfig:
16443
+ description: AWS Cost and Usage Report data export configuration.
16444
+ properties:
16445
+ bucket_name:
16446
+ description: Name of the S3 bucket where the Cost and Usage Report is stored.
16447
+ example: billing
16448
+ type: string
16449
+ bucket_region:
16450
+ description: AWS region of the S3 bucket.
16451
+ example: us-east-1
16452
+ type: string
16453
+ report_name:
16454
+ description: Name of the Cost and Usage Report.
16455
+ example: cost-and-usage-report
16456
+ type: string
16457
+ report_prefix:
16458
+ description: S3 prefix where the Cost and Usage Report is stored.
16459
+ example: reports
16460
+ type: string
16461
+ report_type:
16462
+ description: Type of the Cost and Usage Report.
16463
+ example: CUR2.0
16464
+ type: string
16465
+ type: object
16276
16466
  DataRelationshipsTeams:
16277
16467
  description: Associates teams with this schedule in a data structure.
16278
16468
  properties:
@@ -17075,6 +17265,12 @@ components:
17075
17265
  required:
17076
17266
  - id
17077
17267
  type: object
17268
+ DeploymentGateRulesResponse:
17269
+ description: Response for a deployment gate rules.
17270
+ properties:
17271
+ data:
17272
+ $ref: '#/components/schemas/ListDeploymentRuleResponseData'
17273
+ type: object
17078
17274
  DeploymentMetadata:
17079
17275
  description: Metadata object containing the publication creation information.
17080
17276
  properties:
@@ -17281,10 +17477,6 @@ components:
17281
17477
  DetachCaseRequestData:
17282
17478
  description: Data for detaching security findings from their case.
17283
17479
  properties:
17284
- id:
17285
- description: The unique identifier of the detachment request.
17286
- example: f8b9e3b1-24ec-4413-8be5-1b12b98533c6
17287
- type: string
17288
17480
  relationships:
17289
17481
  $ref: '#/components/schemas/DetachCaseRequestDataRelationships'
17290
17482
  type:
@@ -20219,6 +20411,13 @@ components:
20219
20411
  $ref: '#/components/schemas/EventPayloadAttributes'
20220
20412
  category:
20221
20413
  $ref: '#/components/schemas/EventCategory'
20414
+ host:
20415
+ description: Host name to associate with the event. Any tags associated
20416
+ with the host are also applied to this event. Limited to 255 characters.
20417
+ example: hostname
20418
+ maxLength: 255
20419
+ minLength: 1
20420
+ type: string
20222
20421
  integration_id:
20223
20422
  $ref: '#/components/schemas/EventPayloadIntegrationId'
20224
20423
  message:
@@ -21220,7 +21419,7 @@ components:
21220
21419
  attributes:
21221
21420
  $ref: '#/components/schemas/FindingCaseResponseDataAttributes'
21222
21421
  id:
21223
- description: The unique identifier of the case.
21422
+ description: Unique identifier of the case.
21224
21423
  example: c1234567-89ab-cdef-0123-456789abcdef
21225
21424
  type: string
21226
21425
  relationships:
@@ -21327,7 +21526,7 @@ components:
21327
21526
  FindingData:
21328
21527
  properties:
21329
21528
  id:
21330
- description: The unique identifier of the security finding.
21529
+ description: Unique identifier of the security finding.
21331
21530
  example: ZGVmLTAwcC1pZXJ-aS0wZjhjNjMyZDNmMzRlZTgzNw==
21332
21531
  type: string
21333
21532
  type:
@@ -21390,15 +21589,15 @@ components:
21390
21589
  description: Jira issue associated with the case.
21391
21590
  properties:
21392
21591
  error_message:
21393
- description: The error message if the Jira issue creation failed.
21592
+ description: Error message if the Jira issue creation failed.
21394
21593
  example: '{"errorMessages":["An error occured."],"errors":{}}'
21395
21594
  type: string
21396
21595
  result:
21397
21596
  $ref: '#/components/schemas/FindingJiraIssueResult'
21398
21597
  status:
21399
- description: The status of the Jira issue creation. Can be "COMPLETED" if
21400
- the Jira issue was created successfully, or "FAILED" if the Jira issue
21401
- creation failed.
21598
+ description: Status of the Jira issue creation. Can be "COMPLETED" if the
21599
+ Jira issue was created successfully, or "FAILED" if the Jira issue creation
21600
+ failed.
21402
21601
  example: COMPLETED
21403
21602
  type: string
21404
21603
  type: object
@@ -21406,19 +21605,19 @@ components:
21406
21605
  description: Result of the Jira issue creation.
21407
21606
  properties:
21408
21607
  account_id:
21409
- description: The account ID of the Jira issue.
21608
+ description: Account ID of the Jira issue.
21410
21609
  example: 463a8631-680e-455c-bfd3-3ed04d326eb7
21411
21610
  type: string
21412
21611
  issue_id:
21413
- description: The unique identifier of the Jira issue.
21612
+ description: Unique identifier of the Jira issue.
21414
21613
  example: '2871276'
21415
21614
  type: string
21416
21615
  issue_key:
21417
- description: The key of the Jira issue.
21616
+ description: Key of the Jira issue.
21418
21617
  example: PROJ-123
21419
21618
  type: string
21420
21619
  issue_url:
21421
- description: The URL of the Jira issue.
21620
+ description: URL of the Jira issue.
21422
21621
  example: https://domain.atlassian.net/browse/PROJ-123
21423
21622
  type: string
21424
21623
  type: object
@@ -24666,6 +24865,30 @@ components:
24666
24865
  required:
24667
24866
  - data
24668
24867
  type: object
24868
+ GetSuppressionVersionHistoryData:
24869
+ description: Data for the suppression version history.
24870
+ properties:
24871
+ attributes:
24872
+ $ref: '#/components/schemas/SuppressionVersionHistory'
24873
+ id:
24874
+ description: ID of the suppression.
24875
+ type: string
24876
+ type:
24877
+ $ref: '#/components/schemas/GetSuppressionVersionHistoryDataType'
24878
+ type: object
24879
+ GetSuppressionVersionHistoryDataType:
24880
+ description: Type of data.
24881
+ enum:
24882
+ - suppression_version_history
24883
+ type: string
24884
+ x-enum-varnames:
24885
+ - SUPPRESSIONVERSIONHISTORY
24886
+ GetSuppressionVersionHistoryResponse:
24887
+ description: Response for getting the suppression version history.
24888
+ properties:
24889
+ data:
24890
+ $ref: '#/components/schemas/GetSuppressionVersionHistoryData'
24891
+ type: object
24669
24892
  GetTeamMembershipsSort:
24670
24893
  description: Specifies the order of returned team memberships
24671
24894
  enum:
@@ -29863,6 +30086,13 @@ components:
29863
30086
  Library:
29864
30087
  description: Vulnerability library.
29865
30088
  properties:
30089
+ additional_names:
30090
+ description: Related library or package names (such as child packages or
30091
+ affected binary paths).
30092
+ items:
30093
+ example: linux-tools-common
30094
+ type: string
30095
+ type: array
29866
30096
  name:
29867
30097
  description: Vulnerability library name.
29868
30098
  example: linux-aws-5.15
@@ -30199,6 +30429,37 @@ components:
30199
30429
  type: string
30200
30430
  x-enum-varnames:
30201
30431
  - LIST_CONNECTIONS_RESPONSE
30432
+ ListDeploymentRuleResponseData:
30433
+ description: Data for a list of deployment rules.
30434
+ properties:
30435
+ attributes:
30436
+ $ref: '#/components/schemas/ListDeploymentRulesResponseDataAttributes'
30437
+ id:
30438
+ description: Unique identifier of the deployment rule.
30439
+ example: 1111-2222-3333-4444-555566667777
30440
+ type: string
30441
+ type:
30442
+ $ref: '#/components/schemas/ListDeploymentRulesDataType'
30443
+ required:
30444
+ - type
30445
+ - attributes
30446
+ - id
30447
+ type: object
30448
+ ListDeploymentRulesDataType:
30449
+ description: List deployment rule resource type.
30450
+ enum:
30451
+ - list_deployment_rules
30452
+ example: list_deployment_rules
30453
+ type: string
30454
+ x-enum-varnames:
30455
+ - LIST_DEPLOYMENT_RULES
30456
+ ListDeploymentRulesResponseDataAttributes:
30457
+ properties:
30458
+ rules:
30459
+ items:
30460
+ $ref: '#/components/schemas/DeploymentRuleResponseDataAttributes'
30461
+ type: array
30462
+ type: object
30202
30463
  ListDevicesResponse:
30203
30464
  description: List devices response.
30204
30465
  properties:
@@ -30330,6 +30591,14 @@ components:
30330
30591
  meta:
30331
30592
  $ref: '#/components/schemas/KindResponseMeta'
30332
30593
  type: object
30594
+ ListNotificationChannelsResponse:
30595
+ description: Response type for listing notification channels for a user
30596
+ properties:
30597
+ data:
30598
+ items:
30599
+ $ref: '#/components/schemas/NotificationChannelData'
30600
+ type: array
30601
+ type: object
30333
30602
  ListPipelinesResponse:
30334
30603
  description: Represents the response payload containing a list of pipelines
30335
30604
  and associated metadata.
@@ -34504,6 +34773,174 @@ components:
34504
34773
  required:
34505
34774
  - notebookTrigger
34506
34775
  type: object
34776
+ NotificationChannel:
34777
+ description: A top-level wrapper for a user notification channel
34778
+ example:
34779
+ data:
34780
+ attributes:
34781
+ config:
34782
+ address: foo@bar.com
34783
+ formats:
34784
+ - html
34785
+ type: email
34786
+ id: 27590dae-47be-4a7d-9abf-8f4e45124020
34787
+ type: notification_channels
34788
+ properties:
34789
+ data:
34790
+ $ref: '#/components/schemas/NotificationChannelData'
34791
+ type: object
34792
+ NotificationChannelAttributes:
34793
+ description: Attributes for an on-call notification channel.
34794
+ properties:
34795
+ active:
34796
+ description: Whether the notification channel is currently active.
34797
+ type: boolean
34798
+ config:
34799
+ $ref: '#/components/schemas/NotificationChannelConfig'
34800
+ description: Notification channel configuration
34801
+ type: object
34802
+ NotificationChannelConfig:
34803
+ description: Defines the configuration for an On-Call notification channel
34804
+ oneOf:
34805
+ - $ref: '#/components/schemas/NotificationChannelPhoneConfig'
34806
+ - $ref: '#/components/schemas/NotificationChannelEmailConfig'
34807
+ - $ref: '#/components/schemas/NotificationChannelPushConfig'
34808
+ NotificationChannelData:
34809
+ description: Data for an on-call notification channel
34810
+ properties:
34811
+ attributes:
34812
+ $ref: '#/components/schemas/NotificationChannelAttributes'
34813
+ id:
34814
+ description: Unique identifier for the channel
34815
+ type: string
34816
+ type:
34817
+ $ref: '#/components/schemas/NotificationChannelType'
34818
+ required:
34819
+ - type
34820
+ type: object
34821
+ NotificationChannelEmailConfig:
34822
+ description: Email notification channel configuration
34823
+ properties:
34824
+ address:
34825
+ description: The e-mail address to be notified
34826
+ example: ''
34827
+ type: string
34828
+ formats:
34829
+ description: Preferred content formats for notifications.
34830
+ example:
34831
+ - html
34832
+ items:
34833
+ $ref: '#/components/schemas/NotificationChannelEmailFormatType'
34834
+ type: array
34835
+ type:
34836
+ $ref: '#/components/schemas/NotificationChannelEmailConfigType'
34837
+ required:
34838
+ - type
34839
+ - address
34840
+ - formats
34841
+ type: object
34842
+ NotificationChannelEmailConfigType:
34843
+ default: email
34844
+ description: Indicates that the notification channel is an e-mail address
34845
+ enum:
34846
+ - email
34847
+ example: email
34848
+ type: string
34849
+ x-enum-varnames:
34850
+ - EMAIL
34851
+ NotificationChannelEmailFormatType:
34852
+ default: html
34853
+ description: Specifies the format of the e-mail that is sent for On-Call notifications
34854
+ enum:
34855
+ - html
34856
+ - text
34857
+ example: html
34858
+ type: string
34859
+ x-enum-varnames:
34860
+ - HTML
34861
+ - TEXT
34862
+ NotificationChannelPhoneConfig:
34863
+ description: Phone notification channel configuration
34864
+ properties:
34865
+ formatted_number:
34866
+ description: The formatted international version of Number (e.g. +33 7 1
34867
+ 23 45 67).
34868
+ example: ''
34869
+ type: string
34870
+ number:
34871
+ description: The E-164 formatted phone number (e.g. +3371234567)
34872
+ example: ''
34873
+ type: string
34874
+ region:
34875
+ description: The ISO 3166-1 alpha-2 two-letter country code.
34876
+ example: ''
34877
+ type: string
34878
+ sms_subscribed_at:
34879
+ description: If present, the date the user subscribed this number to SMS
34880
+ messages
34881
+ format: date-time
34882
+ nullable: true
34883
+ type: string
34884
+ type:
34885
+ $ref: '#/components/schemas/NotificationChannelPhoneConfigType'
34886
+ verified:
34887
+ description: Indicates whether this phone has been verified by the user
34888
+ in Datadog On-Call
34889
+ example: false
34890
+ type: boolean
34891
+ required:
34892
+ - type
34893
+ - number
34894
+ - formatted_number
34895
+ - region
34896
+ - verified
34897
+ type: object
34898
+ NotificationChannelPhoneConfigType:
34899
+ default: phone
34900
+ description: Indicates that the notification channel is a phone
34901
+ enum:
34902
+ - phone
34903
+ example: phone
34904
+ type: string
34905
+ x-enum-varnames:
34906
+ - PHONE
34907
+ NotificationChannelPushConfig:
34908
+ description: Push notification channel configuration
34909
+ properties:
34910
+ application_name:
34911
+ description: The name of the application used to receive push notifications
34912
+ example: ''
34913
+ type: string
34914
+ device_name:
34915
+ description: The name of the mobile device being used
34916
+ example: ''
34917
+ type: string
34918
+ type:
34919
+ $ref: '#/components/schemas/NotificationChannelPushConfigType'
34920
+ required:
34921
+ - type
34922
+ - device_name
34923
+ - application_name
34924
+ type: object
34925
+ NotificationChannelPushConfigType:
34926
+ default: push
34927
+ description: Indicates that the notification channel is a mobile device for
34928
+ push notifications
34929
+ enum:
34930
+ - push
34931
+ example: push
34932
+ type: string
34933
+ x-enum-varnames:
34934
+ - PUSH
34935
+ NotificationChannelType:
34936
+ default: notification_channels
34937
+ description: Indicates that the resource is of type 'notification_channels'.
34938
+ enum:
34939
+ - notification_channels
34940
+ example: notification_channels
34941
+ type: string
34942
+ x-enum-varnames:
34943
+ - NOTIFICATION_CHANNELS
34507
34944
  NotificationRule:
34508
34945
  description: 'Notification rules allow full control over notifications generated
34509
34946
  by the various Datadog security products.
@@ -34707,6 +35144,10 @@ components:
34707
35144
  description: The `add_env_vars` processor adds environment variable values to
34708
35145
  log events.
34709
35146
  properties:
35147
+ enabled:
35148
+ description: Whether this processor is enabled.
35149
+ example: true
35150
+ type: boolean
34710
35151
  id:
34711
35152
  description: The unique identifier for this component. Used to reference
34712
35153
  this processor in the pipeline.
@@ -34717,14 +35158,6 @@ components:
34717
35158
  targets.
34718
35159
  example: service:my-service
34719
35160
  type: string
34720
- inputs:
34721
- description: A list of component IDs whose output is used as the input for
34722
- this processor.
34723
- example:
34724
- - datadog-agent-source
34725
- items:
34726
- type: string
34727
- type: array
34728
35161
  type:
34729
35162
  $ref: '#/components/schemas/ObservabilityPipelineAddEnvVarsProcessorType'
34730
35163
  variables:
@@ -34736,8 +35169,8 @@ components:
34736
35169
  - id
34737
35170
  - type
34738
35171
  - include
34739
- - inputs
34740
35172
  - variables
35173
+ - enabled
34741
35174
  type: object
34742
35175
  ObservabilityPipelineAddEnvVarsProcessorType:
34743
35176
  default: add_env_vars
@@ -34766,6 +35199,10 @@ components:
34766
35199
  ObservabilityPipelineAddFieldsProcessor:
34767
35200
  description: The `add_fields` processor adds static key-value fields to logs.
34768
35201
  properties:
35202
+ enabled:
35203
+ description: Whether this processor is enabled.
35204
+ example: true
35205
+ type: boolean
34769
35206
  fields:
34770
35207
  description: A list of static fields (key-value pairs) that is added to
34771
35208
  each log event processed by this component.
@@ -34783,14 +35220,6 @@ components:
34783
35220
  targets.
34784
35221
  example: service:my-service
34785
35222
  type: string
34786
- inputs:
34787
- description: A list of component IDs whose output is used as the `input`
34788
- for this component.
34789
- example:
34790
- - datadog-agent-source
34791
- items:
34792
- type: string
34793
- type: array
34794
35223
  type:
34795
35224
  $ref: '#/components/schemas/ObservabilityPipelineAddFieldsProcessorType'
34796
35225
  required:
@@ -34798,7 +35227,7 @@ components:
34798
35227
  - type
34799
35228
  - include
34800
35229
  - fields
34801
- - inputs
35230
+ - enabled
34802
35231
  type: object
34803
35232
  ObservabilityPipelineAddFieldsProcessorType:
34804
35233
  default: add_fields
@@ -35101,15 +35530,25 @@ components:
35101
35530
  $ref: '#/components/schemas/ObservabilityPipelineConfigDestinationItem'
35102
35531
  type: array
35103
35532
  processors:
35104
- description: A list of processors that transform or enrich log data.
35533
+ description: A list of processor groups that transform or enrich log data.
35105
35534
  example:
35106
- - id: filter-processor
35535
+ - enabled: true
35536
+ id: my-processor-group
35107
35537
  include: service:my-service
35108
35538
  inputs:
35109
35539
  - datadog-agent-source
35110
- type: filter
35540
+ processors:
35541
+ - enabled: true
35542
+ id: filter-processor
35543
+ include: status:error
35544
+ type: filter
35545
+ - enabled: true
35546
+ field: message
35547
+ id: json-processor
35548
+ include: '*'
35549
+ type: parse_json
35111
35550
  items:
35112
- $ref: '#/components/schemas/ObservabilityPipelineConfigProcessorItem'
35551
+ $ref: '#/components/schemas/ObservabilityPipelineConfigProcessorGroup'
35113
35552
  type: array
35114
35553
  sources:
35115
35554
  description: A list of configured data sources for the pipeline.
@@ -35145,6 +35584,73 @@ components:
35145
35584
  - $ref: '#/components/schemas/ObservabilityPipelineAmazonSecurityLakeDestination'
35146
35585
  - $ref: '#/components/schemas/ObservabilityPipelineCrowdStrikeNextGenSiemDestination'
35147
35586
  - $ref: '#/components/schemas/ObservabilityPipelineGooglePubSubDestination'
35587
+ ObservabilityPipelineConfigProcessorGroup:
35588
+ description: A group of processors.
35589
+ example:
35590
+ enabled: true
35591
+ id: my-processor-group
35592
+ include: service:my-service
35593
+ inputs:
35594
+ - datadog-agent-source
35595
+ processors:
35596
+ - enabled: true
35597
+ fields:
35598
+ - name: env
35599
+ value: prod
35600
+ id: add-fields-processor
35601
+ include: '*'
35602
+ type: add_fields
35603
+ - enabled: true
35604
+ id: filter-processor
35605
+ include: status:error
35606
+ type: filter
35607
+ properties:
35608
+ enabled:
35609
+ description: Whether this processor group is enabled.
35610
+ example: true
35611
+ type: boolean
35612
+ id:
35613
+ description: The unique identifier for the processor group.
35614
+ example: grouped-processors
35615
+ type: string
35616
+ include:
35617
+ description: Conditional expression for when this processor group should
35618
+ execute.
35619
+ example: service:my-service
35620
+ type: string
35621
+ inputs:
35622
+ description: A list of IDs for components whose output is used as the input
35623
+ for this processor group.
35624
+ example:
35625
+ - datadog-agent-source
35626
+ items:
35627
+ type: string
35628
+ type: array
35629
+ processors:
35630
+ description: Processors applied sequentially within this group. Events flow
35631
+ through each processor in order.
35632
+ example:
35633
+ - enabled: true
35634
+ fields:
35635
+ - name: env
35636
+ value: prod
35637
+ id: add-fields-processor
35638
+ include: '*'
35639
+ type: add_fields
35640
+ - enabled: true
35641
+ id: filter-processor
35642
+ include: status:error
35643
+ type: filter
35644
+ items:
35645
+ $ref: '#/components/schemas/ObservabilityPipelineConfigProcessorItem'
35646
+ type: array
35647
+ required:
35648
+ - id
35649
+ - include
35650
+ - inputs
35651
+ - processors
35652
+ - enabled
35653
+ type: object
35148
35654
  ObservabilityPipelineConfigProcessorItem:
35149
35655
  description: A processor for the pipeline.
35150
35656
  oneOf:
@@ -35262,6 +35768,10 @@ components:
35262
35768
  Remap Language (VRL)](https://vector.dev/docs/reference/vrl/) scripts with
35263
35769
  advanced filtering capabilities.
35264
35770
  properties:
35771
+ enabled:
35772
+ description: Whether this processor is enabled.
35773
+ example: true
35774
+ type: boolean
35265
35775
  id:
35266
35776
  description: The unique identifier for this processor.
35267
35777
  example: remap-vrl-processor
@@ -35273,14 +35783,6 @@ components:
35273
35783
  processor.
35274
35784
  example: '*'
35275
35785
  type: string
35276
- inputs:
35277
- description: A list of component IDs whose output is used as the input for
35278
- this processor.
35279
- example:
35280
- - datadog-agent-source
35281
- items:
35282
- type: string
35283
- type: array
35284
35786
  remaps:
35285
35787
  description: Array of VRL remap rules.
35286
35788
  items:
@@ -35294,7 +35796,7 @@ components:
35294
35796
  - type
35295
35797
  - include
35296
35798
  - remaps
35297
- - inputs
35799
+ - enabled
35298
35800
  type: object
35299
35801
  ObservabilityPipelineCustomProcessorRemap:
35300
35802
  description: Defines a single VRL remap rule with its own filtering and transformation
@@ -35325,7 +35827,6 @@ components:
35325
35827
  - include
35326
35828
  - name
35327
35829
  - source
35328
- - enabled
35329
35830
  - drop_on_error
35330
35831
  type: object
35331
35832
  ObservabilityPipelineCustomProcessorType:
@@ -35434,6 +35935,10 @@ components:
35434
35935
  properties:
35435
35936
  action:
35436
35937
  $ref: '#/components/schemas/ObservabilityPipelineDatadogTagsProcessorAction'
35938
+ enabled:
35939
+ description: Whether this processor is enabled.
35940
+ example: true
35941
+ type: boolean
35437
35942
  id:
35438
35943
  description: The unique identifier for this component. Used to reference
35439
35944
  this component in other parts of the pipeline (for example, as the `input`
@@ -35445,14 +35950,6 @@ components:
35445
35950
  targets.
35446
35951
  example: service:my-service
35447
35952
  type: string
35448
- inputs:
35449
- description: A list of component IDs whose output is used as the `input`
35450
- for this component.
35451
- example:
35452
- - datadog-agent-source
35453
- items:
35454
- type: string
35455
- type: array
35456
35953
  keys:
35457
35954
  description: A list of tag keys.
35458
35955
  example:
@@ -35473,7 +35970,7 @@ components:
35473
35970
  - mode
35474
35971
  - action
35475
35972
  - keys
35476
- - inputs
35973
+ - enabled
35477
35974
  type: object
35478
35975
  ObservabilityPipelineDatadogTagsProcessorAction:
35479
35976
  description: The action to take on tags with matching keys.
@@ -35519,6 +36016,10 @@ components:
35519
36016
  ObservabilityPipelineDedupeProcessor:
35520
36017
  description: The `dedupe` processor removes duplicate fields in log events.
35521
36018
  properties:
36019
+ enabled:
36020
+ description: Whether this processor is enabled.
36021
+ example: true
36022
+ type: boolean
35522
36023
  fields:
35523
36024
  description: A list of log field paths to check for duplicates.
35524
36025
  example:
@@ -35536,14 +36037,6 @@ components:
35536
36037
  targets.
35537
36038
  example: service:my-service
35538
36039
  type: string
35539
- inputs:
35540
- description: A list of component IDs whose output is used as the input for
35541
- this processor.
35542
- example:
35543
- - parse-json-processor
35544
- items:
35545
- type: string
35546
- type: array
35547
36040
  mode:
35548
36041
  $ref: '#/components/schemas/ObservabilityPipelineDedupeProcessorMode'
35549
36042
  type:
@@ -35552,9 +36045,9 @@ components:
35552
36045
  - id
35553
36046
  - type
35554
36047
  - include
35555
- - inputs
35556
36048
  - fields
35557
36049
  - mode
36050
+ - enabled
35558
36051
  type: object
35559
36052
  ObservabilityPipelineDedupeProcessorMode:
35560
36053
  description: The deduplication mode to apply to the fields.
@@ -35760,6 +36253,10 @@ components:
35760
36253
  description: The `enrichment_table` processor enriches logs using a static CSV
35761
36254
  file or GeoIP database.
35762
36255
  properties:
36256
+ enabled:
36257
+ description: Whether this processor is enabled.
36258
+ example: true
36259
+ type: boolean
35763
36260
  file:
35764
36261
  $ref: '#/components/schemas/ObservabilityPipelineEnrichmentTableFile'
35765
36262
  geoip:
@@ -35773,14 +36270,6 @@ components:
35773
36270
  targets.
35774
36271
  example: source:my-source
35775
36272
  type: string
35776
- inputs:
35777
- description: A list of component IDs whose output is used as the input for
35778
- this processor.
35779
- example:
35780
- - add-fields-processor
35781
- items:
35782
- type: string
35783
- type: array
35784
36273
  target:
35785
36274
  description: Path where enrichment results should be stored in the log.
35786
36275
  example: enriched.geoip
@@ -35791,8 +36280,8 @@ components:
35791
36280
  - id
35792
36281
  - type
35793
36282
  - include
35794
- - inputs
35795
36283
  - target
36284
+ - enabled
35796
36285
  type: object
35797
36286
  ObservabilityPipelineEnrichmentTableProcessorType:
35798
36287
  default: enrichment_table
@@ -35823,6 +36312,10 @@ components:
35823
36312
  on a Datadog search query. Logs that match the `include` query are passed
35824
36313
  through; others are discarded.
35825
36314
  properties:
36315
+ enabled:
36316
+ description: Whether this processor is enabled.
36317
+ example: true
36318
+ type: boolean
35826
36319
  id:
35827
36320
  description: The unique identifier for this component. Used to reference
35828
36321
  this component in other parts of the pipeline (for example, as the `input`
@@ -35835,21 +36328,13 @@ components:
35835
36328
  components; others are dropped.
35836
36329
  example: service:my-service
35837
36330
  type: string
35838
- inputs:
35839
- description: A list of component IDs whose output is used as the `input`
35840
- for this component.
35841
- example:
35842
- - datadog-agent-source
35843
- items:
35844
- type: string
35845
- type: array
35846
36331
  type:
35847
36332
  $ref: '#/components/schemas/ObservabilityPipelineFilterProcessorType'
35848
36333
  required:
35849
36334
  - id
35850
36335
  - type
35851
36336
  - include
35852
- - inputs
36337
+ - enabled
35853
36338
  type: object
35854
36339
  ObservabilityPipelineFilterProcessorType:
35855
36340
  default: filter
@@ -35929,6 +36414,10 @@ components:
35929
36414
  Metrics can be counters, gauges, or distributions and optionally grouped by
35930
36415
  log fields.'
35931
36416
  properties:
36417
+ enabled:
36418
+ description: Whether this processor is enabled.
36419
+ example: true
36420
+ type: boolean
35932
36421
  id:
35933
36422
  description: The unique identifier for this component. Used to reference
35934
36423
  this component in other parts of the pipeline.
@@ -35939,14 +36428,6 @@ components:
35939
36428
  targets.
35940
36429
  example: service:my-service
35941
36430
  type: string
35942
- inputs:
35943
- description: A list of component IDs whose output is used as the `input`
35944
- for this processor.
35945
- example:
35946
- - source-id
35947
- items:
35948
- type: string
35949
- type: array
35950
36431
  metrics:
35951
36432
  description: Configuration for generating individual metrics.
35952
36433
  items:
@@ -35957,9 +36438,7 @@ components:
35957
36438
  required:
35958
36439
  - id
35959
36440
  - type
35960
- - inputs
35961
- - include
35962
- - metrics
36441
+ - enabled
35963
36442
  type: object
35964
36443
  ObservabilityPipelineGenerateMetricsProcessorType:
35965
36444
  default: generate_datadog_metrics
@@ -36556,6 +37035,10 @@ components:
36556
37035
  description: The `ocsf_mapper` processor transforms logs into the OCSF schema
36557
37036
  using a predefined mapping configuration.
36558
37037
  properties:
37038
+ enabled:
37039
+ description: Whether this processor is enabled.
37040
+ example: true
37041
+ type: boolean
36559
37042
  id:
36560
37043
  description: The unique identifier for this component. Used to reference
36561
37044
  this component in other parts of the pipeline.
@@ -36566,14 +37049,6 @@ components:
36566
37049
  targets.
36567
37050
  example: service:my-service
36568
37051
  type: string
36569
- inputs:
36570
- description: A list of component IDs whose output is used as the `input`
36571
- for this processor.
36572
- example:
36573
- - filter-processor
36574
- items:
36575
- type: string
36576
- type: array
36577
37052
  mappings:
36578
37053
  description: A list of mapping rules to convert events to the OCSF format.
36579
37054
  items:
@@ -36585,8 +37060,8 @@ components:
36585
37060
  - id
36586
37061
  - type
36587
37062
  - include
36588
- - inputs
36589
37063
  - mappings
37064
+ - enabled
36590
37065
  type: object
36591
37066
  ObservabilityPipelineOcsfMapperProcessorMapping:
36592
37067
  description: Defines how specific events are transformed to OCSF using a mapping
@@ -36691,6 +37166,10 @@ components:
36691
37166
  by Datadog.
36692
37167
  example: true
36693
37168
  type: boolean
37169
+ enabled:
37170
+ description: Whether this processor is enabled.
37171
+ example: true
37172
+ type: boolean
36694
37173
  id:
36695
37174
  description: A unique identifier for this processor.
36696
37175
  example: parse-grok-processor
@@ -36700,14 +37179,6 @@ components:
36700
37179
  targets.
36701
37180
  example: service:my-service
36702
37181
  type: string
36703
- inputs:
36704
- description: A list of component IDs whose output is used as the `input`
36705
- for this component.
36706
- example:
36707
- - datadog-agent-source
36708
- items:
36709
- type: string
36710
- type: array
36711
37182
  rules:
36712
37183
  description: The list of Grok parsing rules. If multiple matching rules
36713
37184
  are provided, they are evaluated in order. The first successful match
@@ -36721,8 +37192,8 @@ components:
36721
37192
  - id
36722
37193
  - type
36723
37194
  - include
36724
- - inputs
36725
37195
  - rules
37196
+ - enabled
36726
37197
  type: object
36727
37198
  ObservabilityPipelineParseGrokProcessorRule:
36728
37199
  description: 'A Grok parsing rule used in the `parse_grok` processor. Each rule
@@ -36807,6 +37278,10 @@ components:
36807
37278
  and flattens it into the event. This is useful when logs contain embedded
36808
37279
  JSON as a string.
36809
37280
  properties:
37281
+ enabled:
37282
+ description: Whether this processor is enabled.
37283
+ example: true
37284
+ type: boolean
36810
37285
  field:
36811
37286
  description: The name of the log field that contains a JSON string.
36812
37287
  example: message
@@ -36822,14 +37297,6 @@ components:
36822
37297
  targets.
36823
37298
  example: service:my-service
36824
37299
  type: string
36825
- inputs:
36826
- description: A list of component IDs whose output is used as the `input`
36827
- for this component.
36828
- example:
36829
- - datadog-agent-source
36830
- items:
36831
- type: string
36832
- type: array
36833
37300
  type:
36834
37301
  $ref: '#/components/schemas/ObservabilityPipelineParseJSONProcessorType'
36835
37302
  required:
@@ -36837,7 +37304,7 @@ components:
36837
37304
  - type
36838
37305
  - include
36839
37306
  - field
36840
- - inputs
37307
+ - enabled
36841
37308
  type: object
36842
37309
  ObservabilityPipelineParseJSONProcessorType:
36843
37310
  default: parse_json
@@ -36870,6 +37337,10 @@ components:
36870
37337
  the filter query continue through the pipeline.
36871
37338
  example: false
36872
37339
  type: boolean
37340
+ enabled:
37341
+ description: Whether this processor is enabled.
37342
+ example: true
37343
+ type: boolean
36873
37344
  id:
36874
37345
  description: The unique identifier for this component. Used to reference
36875
37346
  this component in other parts of the pipeline (for example, as the `input`
@@ -36885,14 +37356,6 @@ components:
36885
37356
  targets.
36886
37357
  example: service:my-service
36887
37358
  type: string
36888
- inputs:
36889
- description: A list of component IDs whose output is used as the `input`
36890
- for this component.
36891
- example:
36892
- - datadog-agent-source
36893
- items:
36894
- type: string
36895
- type: array
36896
37359
  limit:
36897
37360
  $ref: '#/components/schemas/ObservabilityPipelineQuotaProcessorLimit'
36898
37361
  name:
@@ -36922,9 +37385,8 @@ components:
36922
37385
  - type
36923
37386
  - include
36924
37387
  - name
36925
- - drop_events
36926
37388
  - limit
36927
- - inputs
37389
+ - enabled
36928
37390
  type: object
36929
37391
  ObservabilityPipelineQuotaProcessorLimit:
36930
37392
  description: The maximum amount of data or number of events allowed before the
@@ -37000,6 +37462,10 @@ components:
37000
37462
  description: The `reduce` processor aggregates and merges logs based on matching
37001
37463
  keys and merge strategies.
37002
37464
  properties:
37465
+ enabled:
37466
+ description: Whether this processor is enabled.
37467
+ example: true
37468
+ type: boolean
37003
37469
  group_by:
37004
37470
  description: A list of fields used to group log events for merging.
37005
37471
  example:
@@ -37017,14 +37483,6 @@ components:
37017
37483
  targets.
37018
37484
  example: env:prod
37019
37485
  type: string
37020
- inputs:
37021
- description: A list of component IDs whose output is used as the input for
37022
- this processor.
37023
- example:
37024
- - parse-json-processor
37025
- items:
37026
- type: string
37027
- type: array
37028
37486
  merge_strategies:
37029
37487
  description: List of merge strategies defining how values from grouped events
37030
37488
  should be combined.
@@ -37037,9 +37495,9 @@ components:
37037
37495
  - id
37038
37496
  - type
37039
37497
  - include
37040
- - inputs
37041
37498
  - group_by
37042
37499
  - merge_strategies
37500
+ - enabled
37043
37501
  type: object
37044
37502
  ObservabilityPipelineReduceProcessorMergeStrategy:
37045
37503
  description: Defines how a specific field should be merged across grouped events.
@@ -37096,6 +37554,10 @@ components:
37096
37554
  ObservabilityPipelineRemoveFieldsProcessor:
37097
37555
  description: The `remove_fields` processor deletes specified fields from logs.
37098
37556
  properties:
37557
+ enabled:
37558
+ description: Whether this processor is enabled.
37559
+ example: true
37560
+ type: boolean
37099
37561
  fields:
37100
37562
  description: A list of field names to be removed from each log event.
37101
37563
  example:
@@ -37115,13 +37577,6 @@ components:
37115
37577
  targets.
37116
37578
  example: service:my-service
37117
37579
  type: string
37118
- inputs:
37119
- description: The `PipelineRemoveFieldsProcessor` `inputs`.
37120
- example:
37121
- - datadog-agent-source
37122
- items:
37123
- type: string
37124
- type: array
37125
37580
  type:
37126
37581
  $ref: '#/components/schemas/ObservabilityPipelineRemoveFieldsProcessorType'
37127
37582
  required:
@@ -37129,7 +37584,7 @@ components:
37129
37584
  - type
37130
37585
  - include
37131
37586
  - fields
37132
- - inputs
37587
+ - enabled
37133
37588
  type: object
37134
37589
  ObservabilityPipelineRemoveFieldsProcessorType:
37135
37590
  default: remove_fields
@@ -37143,6 +37598,10 @@ components:
37143
37598
  ObservabilityPipelineRenameFieldsProcessor:
37144
37599
  description: The `rename_fields` processor changes field names.
37145
37600
  properties:
37601
+ enabled:
37602
+ description: Whether this processor is enabled.
37603
+ example: true
37604
+ type: boolean
37146
37605
  fields:
37147
37606
  description: A list of rename rules specifying which fields to rename in
37148
37607
  the event, what to rename them to, and whether to preserve the original
@@ -37161,14 +37620,6 @@ components:
37161
37620
  targets.
37162
37621
  example: service:my-service
37163
37622
  type: string
37164
- inputs:
37165
- description: A list of component IDs whose output is used as the `input`
37166
- for this component.
37167
- example:
37168
- - datadog-agent-source
37169
- items:
37170
- type: string
37171
- type: array
37172
37623
  type:
37173
37624
  $ref: '#/components/schemas/ObservabilityPipelineRenameFieldsProcessorType'
37174
37625
  required:
@@ -37176,7 +37627,7 @@ components:
37176
37627
  - type
37177
37628
  - include
37178
37629
  - fields
37179
- - inputs
37630
+ - enabled
37180
37631
  type: object
37181
37632
  ObservabilityPipelineRenameFieldsProcessorField:
37182
37633
  description: Defines how to rename a field in log events.
@@ -37282,6 +37733,10 @@ components:
37282
37733
  description: The `sample` processor allows probabilistic sampling of logs at
37283
37734
  a fixed rate.
37284
37735
  properties:
37736
+ enabled:
37737
+ description: Whether this processor is enabled.
37738
+ example: true
37739
+ type: boolean
37285
37740
  id:
37286
37741
  description: The unique identifier for this component. Used to reference
37287
37742
  this component in other parts of the pipeline (for example, as the `input`
@@ -37293,14 +37748,6 @@ components:
37293
37748
  targets.
37294
37749
  example: service:my-service
37295
37750
  type: string
37296
- inputs:
37297
- description: A list of component IDs whose output is used as the `input`
37298
- for this component.
37299
- example:
37300
- - datadog-agent-source
37301
- items:
37302
- type: string
37303
- type: array
37304
37751
  percentage:
37305
37752
  description: The percentage of logs to sample.
37306
37753
  example: 10.0
@@ -37318,7 +37765,7 @@ components:
37318
37765
  - id
37319
37766
  - type
37320
37767
  - include
37321
- - inputs
37768
+ - enabled
37322
37769
  type: object
37323
37770
  ObservabilityPipelineSampleProcessorType:
37324
37771
  default: sample
@@ -37333,6 +37780,10 @@ components:
37333
37780
  description: The `sensitive_data_scanner` processor detects and optionally redacts
37334
37781
  sensitive data in log events.
37335
37782
  properties:
37783
+ enabled:
37784
+ description: Whether this processor is enabled.
37785
+ example: true
37786
+ type: boolean
37336
37787
  id:
37337
37788
  description: The unique identifier for this component. Used to reference
37338
37789
  this component in other parts of the pipeline (e.g., as input to downstream
@@ -37344,14 +37795,6 @@ components:
37344
37795
  targets.
37345
37796
  example: source:prod
37346
37797
  type: string
37347
- inputs:
37348
- description: A list of component IDs whose output is used as the `input`
37349
- for this component.
37350
- example:
37351
- - parse-json-processor
37352
- items:
37353
- type: string
37354
- type: array
37355
37798
  rules:
37356
37799
  description: A list of rules for identifying and acting on sensitive data
37357
37800
  patterns.
@@ -37364,8 +37807,8 @@ components:
37364
37807
  - id
37365
37808
  - type
37366
37809
  - include
37367
- - inputs
37368
37810
  - rules
37811
+ - enabled
37369
37812
  type: object
37370
37813
  ObservabilityPipelineSensitiveDataScannerProcessorAction:
37371
37814
  description: Defines what action to take when sensitive data is matched.
@@ -38326,6 +38769,10 @@ components:
38326
38769
  description: The `throttle` processor limits the number of events that pass
38327
38770
  through over a given time window.
38328
38771
  properties:
38772
+ enabled:
38773
+ description: Whether this processor is enabled.
38774
+ example: true
38775
+ type: boolean
38329
38776
  group_by:
38330
38777
  description: Optional list of fields used to group events before the threshold
38331
38778
  has been reached.
@@ -38343,14 +38790,6 @@ components:
38343
38790
  targets.
38344
38791
  example: env:prod
38345
38792
  type: string
38346
- inputs:
38347
- description: A list of component IDs whose output is used as the input for
38348
- this processor.
38349
- example:
38350
- - datadog-agent-source
38351
- items:
38352
- type: string
38353
- type: array
38354
38793
  threshold:
38355
38794
  description: the number of events allowed in a given time window. Events
38356
38795
  sent after the threshold has been reached, are dropped.
@@ -38368,9 +38807,9 @@ components:
38368
38807
  - id
38369
38808
  - type
38370
38809
  - include
38371
- - inputs
38372
38810
  - threshold
38373
38811
  - window
38812
+ - enabled
38374
38813
  type: object
38375
38814
  ObservabilityPipelineThrottleProcessorType:
38376
38815
  default: throttle
@@ -44089,38 +44528,13 @@ components:
44089
44528
  description: The `RuleVersionHistory` `data`.
44090
44529
  type: object
44091
44530
  type: object
44092
- RuleVersionUpdate:
44093
- description: A change in a rule version.
44094
- properties:
44095
- change:
44096
- description: The new value of the field.
44097
- example: cloud_provider:aws
44098
- type: string
44099
- field:
44100
- description: The field that was changed.
44101
- example: Tags
44102
- type: string
44103
- type:
44104
- $ref: '#/components/schemas/RuleVersionUpdateType'
44105
- type: object
44106
- RuleVersionUpdateType:
44107
- description: The type of change.
44108
- enum:
44109
- - create
44110
- - update
44111
- - delete
44112
- type: string
44113
- x-enum-varnames:
44114
- - CREATE
44115
- - UPDATE
44116
- - DELETE
44117
44531
  RuleVersions:
44118
44532
  description: A rule version with a list of updates.
44119
44533
  properties:
44120
44534
  changes:
44121
44535
  description: A list of changes.
44122
44536
  items:
44123
- $ref: '#/components/schemas/RuleVersionUpdate'
44537
+ $ref: '#/components/schemas/VersionHistoryUpdate'
44124
44538
  type: array
44125
44539
  rule:
44126
44540
  $ref: '#/components/schemas/SecurityMonitoringRuleResponse'
@@ -47194,6 +47608,8 @@ components:
47194
47608
  properties:
47195
47609
  forgetAfter:
47196
47610
  $ref: '#/components/schemas/SecurityMonitoringRuleNewValueOptionsForgetAfter'
47611
+ instantaneousBaseline:
47612
+ $ref: '#/components/schemas/SecurityMonitoringRuleNewValueOptionsInstantaneousBaseline'
47197
47613
  learningDuration:
47198
47614
  $ref: '#/components/schemas/SecurityMonitoringRuleNewValueOptionsLearningDuration'
47199
47615
  learningMethod:
@@ -47219,6 +47635,13 @@ components:
47219
47635
  - TWO_WEEKS
47220
47636
  - THREE_WEEKS
47221
47637
  - FOUR_WEEKS
47638
+ SecurityMonitoringRuleNewValueOptionsInstantaneousBaseline:
47639
+ description: When set to true, Datadog uses previous values that fall within
47640
+ the defined learning window to construct the baseline, enabling the system
47641
+ to establish an accurate baseline more rapidly rather than relying solely
47642
+ on gradual learning over time.
47643
+ example: false
47644
+ type: boolean
47222
47645
  SecurityMonitoringRuleNewValueOptionsLearningDuration:
47223
47646
  default: 0
47224
47647
  description: 'The duration in days during which values are learned, and after
@@ -50937,6 +51360,49 @@ components:
50937
51360
  $ref: '#/components/schemas/ServiceDefinitionData'
50938
51361
  type: array
50939
51362
  type: object
51363
+ ServiceList:
51364
+ properties:
51365
+ data:
51366
+ $ref: '#/components/schemas/ServiceListData'
51367
+ type: object
51368
+ ServiceListData:
51369
+ properties:
51370
+ attributes:
51371
+ $ref: '#/components/schemas/ServiceListDataAttributes'
51372
+ id:
51373
+ type: string
51374
+ type:
51375
+ $ref: '#/components/schemas/ServiceListDataType'
51376
+ required:
51377
+ - type
51378
+ type: object
51379
+ ServiceListDataAttributes:
51380
+ properties:
51381
+ metadata:
51382
+ items:
51383
+ $ref: '#/components/schemas/ServiceListDataAttributesMetadataItems'
51384
+ type: array
51385
+ services:
51386
+ items:
51387
+ type: string
51388
+ type: array
51389
+ type: object
51390
+ ServiceListDataAttributesMetadataItems:
51391
+ properties:
51392
+ isTraced:
51393
+ type: boolean
51394
+ isUsm:
51395
+ type: boolean
51396
+ type: object
51397
+ ServiceListDataType:
51398
+ default: services_list
51399
+ description: Services list resource type.
51400
+ enum:
51401
+ - services_list
51402
+ example: services_list
51403
+ type: string
51404
+ x-enum-varnames:
51405
+ - SERVICES_LIST
50940
51406
  ServiceNowBasicAuth:
50941
51407
  description: The definition of the `ServiceNowBasicAuth` object.
50942
51408
  properties:
@@ -52680,6 +53146,32 @@ components:
52680
53146
  format: double
52681
53147
  type: number
52682
53148
  type: object
53149
+ SuppressionVersionHistory:
53150
+ description: Response object containing the version history of a suppression.
53151
+ properties:
53152
+ count:
53153
+ description: The number of suppression versions.
53154
+ format: int32
53155
+ maximum: 2147483647
53156
+ type: integer
53157
+ data:
53158
+ additionalProperties:
53159
+ $ref: '#/components/schemas/SuppressionVersions'
53160
+ description: A suppression version with a list of updates.
53161
+ description: The version history of a suppression.
53162
+ type: object
53163
+ type: object
53164
+ SuppressionVersions:
53165
+ description: A suppression version with a list of updates.
53166
+ properties:
53167
+ changes:
53168
+ description: A list of changes.
53169
+ items:
53170
+ $ref: '#/components/schemas/VersionHistoryUpdate'
53171
+ type: array
53172
+ suppression:
53173
+ $ref: '#/components/schemas/SecurityMonitoringSuppressionAttributes'
53174
+ type: object
52683
53175
  TableResultV2:
52684
53176
  description: A reference table resource containing its full configuration and
52685
53177
  state.
@@ -57010,6 +57502,31 @@ components:
57010
57502
  example: 1
57011
57503
  format: int64
57012
57504
  type: integer
57505
+ VersionHistoryUpdate:
57506
+ description: A change in a rule version.
57507
+ properties:
57508
+ change:
57509
+ description: The new value of the field.
57510
+ example: cloud_provider:aws
57511
+ type: string
57512
+ field:
57513
+ description: The field that was changed.
57514
+ example: Tags
57515
+ type: string
57516
+ type:
57517
+ $ref: '#/components/schemas/VersionHistoryUpdateType'
57518
+ type: object
57519
+ VersionHistoryUpdateType:
57520
+ description: The type of change.
57521
+ enum:
57522
+ - create
57523
+ - update
57524
+ - delete
57525
+ type: string
57526
+ x-enum-varnames:
57527
+ - CREATE
57528
+ - UPDATE
57529
+ - DELETE
57013
57530
  VirusTotalAPIKey:
57014
57531
  description: The definition of the `VirusTotalAPIKey` object.
57015
57532
  properties:
@@ -57207,6 +57724,12 @@ components:
57207
57724
  type: array
57208
57725
  risks:
57209
57726
  $ref: '#/components/schemas/VulnerabilityRisks'
57727
+ running_kernel:
57728
+ description: "True if the vulnerability affects a package in the host\u2019s
57729
+ running kernel, false if it affects a non-running kernel, and omit if
57730
+ it is not kernel-related."
57731
+ example: true
57732
+ type: boolean
57210
57733
  status:
57211
57734
  $ref: '#/components/schemas/VulnerabilityStatus'
57212
57735
  title:
@@ -57267,10 +57790,15 @@ components:
57267
57790
  - RubyGems
57268
57791
  - Go
57269
57792
  - Packagist
57270
- - Ddeb
57793
+ - Deb
57271
57794
  - Rpm
57272
57795
  - Apk
57273
57796
  - Windows
57797
+ - Generic
57798
+ - MacOs
57799
+ - Oci
57800
+ - BottleRocket
57801
+ - None
57274
57802
  type: string
57275
57803
  x-enum-varnames:
57276
57804
  - PYPI
@@ -57280,10 +57808,15 @@ components:
57280
57808
  - RUBY_GEMS
57281
57809
  - GO
57282
57810
  - PACKAGIST
57283
- - D_DEB
57811
+ - DEB
57284
57812
  - RPM
57285
57813
  - APK
57286
57814
  - WINDOWS
57815
+ - GENERIC
57816
+ - MAC_OS
57817
+ - OCI
57818
+ - BOTTLE_ROCKET
57819
+ - NONE
57287
57820
  VulnerabilityRelationships:
57288
57821
  description: Related entities object.
57289
57822
  properties:
@@ -57384,12 +57917,14 @@ components:
57384
57917
  - IAST
57385
57918
  - SCA
57386
57919
  - Infra
57920
+ - SAST
57387
57921
  example: SCA
57388
57922
  type: string
57389
57923
  x-enum-varnames:
57390
57924
  - IAST
57391
57925
  - SCA
57392
57926
  - INFRA
57927
+ - SAST
57393
57928
  VulnerabilityType:
57394
57929
  description: The vulnerability type.
57395
57930
  enum:
@@ -61130,6 +61665,26 @@ paths:
61130
61665
  permissions:
61131
61666
  - apm_retention_filter_write
61132
61667
  - apm_pipelines_write
61668
+ /api/v2/apm/services:
61669
+ get:
61670
+ operationId: GetServiceList
61671
+ responses:
61672
+ '200':
61673
+ content:
61674
+ application/json:
61675
+ schema:
61676
+ $ref: '#/components/schemas/ServiceList'
61677
+ description: OK
61678
+ '429':
61679
+ $ref: '#/components/responses/TooManyRequestsResponse'
61680
+ security:
61681
+ - apiKeyAuth: []
61682
+ appKeyAuth: []
61683
+ - AuthZ:
61684
+ - apm_read
61685
+ summary: Get service list
61686
+ tags:
61687
+ - APM
61133
61688
  /api/v2/app-builder/apps:
61134
61689
  delete:
61135
61690
  description: Delete multiple apps in a single request from a list of app IDs.
@@ -66236,6 +66791,50 @@ paths:
66236
66791
 
66237
66792
  If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).'
66238
66793
  /api/v2/deployment_gates/{gate_id}/rules:
66794
+ get:
66795
+ description: Endpoint to get rules for a deployment gate.
66796
+ operationId: GetDeploymentGateRules
66797
+ parameters:
66798
+ - description: The ID of the deployment gate.
66799
+ in: path
66800
+ name: gate_id
66801
+ required: true
66802
+ schema:
66803
+ type: string
66804
+ responses:
66805
+ '200':
66806
+ content:
66807
+ application/json:
66808
+ schema:
66809
+ $ref: '#/components/schemas/DeploymentGateRulesResponse'
66810
+ description: OK
66811
+ '400':
66812
+ $ref: '#/components/responses/HTTPCDGatesBadRequestResponse'
66813
+ '401':
66814
+ $ref: '#/components/responses/UnauthorizedResponse'
66815
+ '403':
66816
+ $ref: '#/components/responses/ForbiddenResponse'
66817
+ '429':
66818
+ $ref: '#/components/responses/TooManyRequestsResponse'
66819
+ '500':
66820
+ content:
66821
+ application/json:
66822
+ schema:
66823
+ $ref: '#/components/schemas/HTTPCIAppErrors'
66824
+ description: Internal Server Error
66825
+ security:
66826
+ - apiKeyAuth: []
66827
+ appKeyAuth: []
66828
+ summary: Get rules for a deployment gate
66829
+ tags:
66830
+ - Deployment Gates
66831
+ x-permission:
66832
+ operator: OR
66833
+ permissions:
66834
+ - deployment_gates_read
66835
+ x-unstable: '**Note**: This endpoint is in preview and may be subject to change.
66836
+
66837
+ If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).'
66239
66838
  post:
66240
66839
  description: Endpoint to create a deployment rule. A gate for the rule must
66241
66840
  already exist.
@@ -66790,6 +67389,24 @@ paths:
66790
67389
  '200':
66791
67390
  content:
66792
67391
  application/json:
67392
+ example:
67393
+ data:
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
66793
67410
  schema:
66794
67411
  $ref: '#/components/schemas/DORAFetchResponse'
66795
67412
  description: OK
@@ -66908,6 +67525,64 @@ paths:
66908
67525
  '200':
66909
67526
  content:
66910
67527
  application/json:
67528
+ example:
67529
+ data:
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
66911
67586
  schema:
66912
67587
  $ref: '#/components/schemas/DORAListResponse'
66913
67588
  description: OK
@@ -66947,6 +67622,26 @@ paths:
66947
67622
  '200':
66948
67623
  content:
66949
67624
  application/json:
67625
+ example:
67626
+ data:
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
66950
67645
  schema:
66951
67646
  $ref: '#/components/schemas/DORAFetchResponse'
66952
67647
  description: OK
@@ -67608,6 +68303,7 @@ paths:
67608
68303
  rule:
67609
68304
  datacenter: devcycle.us1.prod
67610
68305
  category: change
68306
+ host: hostname
67611
68307
  integration_id: custom-events
67612
68308
  message: payment_processed feature flag has been enabled
67613
68309
  tags:
@@ -67654,6 +68350,7 @@ paths:
67654
68350
  - us3.datadoghq.com
67655
68351
  - us5.datadoghq.com
67656
68352
  - ap1.datadoghq.com
68353
+ - ap2.datadoghq.com
67657
68354
  - datadoghq.eu
67658
68355
  - ddog-gov.com
67659
68356
  subdomain:
@@ -68721,9 +69418,6 @@ paths:
68721
69418
  operator: OR
68722
69419
  permissions:
68723
69420
  - incident_read
68724
- x-unstable: '**Note**: This endpoint is in Preview.
68725
-
68726
- If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).'
68727
69421
  post:
68728
69422
  description: Create an impact for an incident.
68729
69423
  operationId: CreateIncidentImpact
@@ -68767,9 +69461,6 @@ paths:
68767
69461
  operator: OR
68768
69462
  permissions:
68769
69463
  - incident_write
68770
- x-unstable: '**Note**: This endpoint is in Preview.
68771
-
68772
- If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).'
68773
69464
  /api/v2/incidents/{incident_id}/impacts/{impact_id}:
68774
69465
  delete:
68775
69466
  description: Delete an incident impact.
@@ -68800,9 +69491,6 @@ paths:
68800
69491
  operator: OR
68801
69492
  permissions:
68802
69493
  - incident_write
68803
- x-unstable: '**Note**: This endpoint is in Preview.
68804
-
68805
- If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).'
68806
69494
  /api/v2/incidents/{incident_id}/relationships/integrations:
68807
69495
  get:
68808
69496
  description: Get all integration metadata for an incident.
@@ -75378,6 +76066,184 @@ paths:
75378
76066
  operator: AND
75379
76067
  permissions:
75380
76068
  - on_call_write
76069
+ /api/v2/on-call/users/{user_id}/notification-channels:
76070
+ get:
76071
+ description: List the notification channels for a user. The authenticated user
76072
+ must be the target user or have the `on_call_admin` permission
76073
+ operationId: ListUserNotificationChannels
76074
+ parameters:
76075
+ - description: The user ID
76076
+ in: path
76077
+ name: user_id
76078
+ required: true
76079
+ schema:
76080
+ example: 00000000-0000-0000-0000-000000000000
76081
+ type: string
76082
+ responses:
76083
+ '200':
76084
+ content:
76085
+ application/json:
76086
+ schema:
76087
+ $ref: '#/components/schemas/ListNotificationChannelsResponse'
76088
+ description: OK
76089
+ '400':
76090
+ $ref: '#/components/responses/BadRequestResponse'
76091
+ '401':
76092
+ $ref: '#/components/responses/UnauthorizedResponse'
76093
+ '403':
76094
+ $ref: '#/components/responses/ForbiddenResponse'
76095
+ '404':
76096
+ $ref: '#/components/responses/NotFoundResponse'
76097
+ '429':
76098
+ $ref: '#/components/responses/TooManyRequestsResponse'
76099
+ security:
76100
+ - apiKeyAuth: []
76101
+ appKeyAuth: []
76102
+ - AuthZ: []
76103
+ summary: List On-Call notification channels for a user
76104
+ tags:
76105
+ - On-Call
76106
+ x-permission:
76107
+ operator: AND
76108
+ permissions:
76109
+ - on_call_read
76110
+ post:
76111
+ description: Create a new notification channel for a user. The authenticated
76112
+ user must be the target user or have the `on_call_admin` permission
76113
+ operationId: CreateUserNotificationChannel
76114
+ parameters:
76115
+ - description: The user ID
76116
+ in: path
76117
+ name: user_id
76118
+ required: true
76119
+ schema:
76120
+ example: 00000000-0000-0000-0000-000000000000
76121
+ type: string
76122
+ requestBody:
76123
+ content:
76124
+ application/json:
76125
+ schema:
76126
+ $ref: '#/components/schemas/CreateUserNotificationChannelRequest'
76127
+ required: true
76128
+ responses:
76129
+ '201':
76130
+ content:
76131
+ application/json:
76132
+ schema:
76133
+ $ref: '#/components/schemas/NotificationChannel'
76134
+ description: Created
76135
+ '400':
76136
+ $ref: '#/components/responses/BadRequestResponse'
76137
+ '401':
76138
+ $ref: '#/components/responses/UnauthorizedResponse'
76139
+ '403':
76140
+ $ref: '#/components/responses/ForbiddenResponse'
76141
+ '404':
76142
+ $ref: '#/components/responses/NotFoundResponse'
76143
+ '429':
76144
+ $ref: '#/components/responses/TooManyRequestsResponse'
76145
+ security:
76146
+ - apiKeyAuth: []
76147
+ appKeyAuth: []
76148
+ - AuthZ: []
76149
+ summary: Create an On-Call notification channel for a user
76150
+ tags:
76151
+ - On-Call
76152
+ x-permission:
76153
+ operator: AND
76154
+ permissions:
76155
+ - on_call_respond
76156
+ /api/v2/on-call/users/{user_id}/notification-channels/{channel_id}:
76157
+ delete:
76158
+ description: Delete a notification channel for a user. The authenticated user
76159
+ must be the target user or have the `on_call_admin` permission
76160
+ operationId: DeleteUserNotificationChannel
76161
+ parameters:
76162
+ - description: The user ID
76163
+ in: path
76164
+ name: user_id
76165
+ required: true
76166
+ schema:
76167
+ example: 00000000-0000-0000-0000-000000000000
76168
+ type: string
76169
+ - description: The channel ID
76170
+ in: path
76171
+ name: channel_id
76172
+ required: true
76173
+ schema:
76174
+ example: 00000000-0000-0000-0000-000000000000
76175
+ type: string
76176
+ responses:
76177
+ '204':
76178
+ description: No Content
76179
+ '400':
76180
+ $ref: '#/components/responses/BadRequestResponse'
76181
+ '401':
76182
+ $ref: '#/components/responses/UnauthorizedResponse'
76183
+ '403':
76184
+ $ref: '#/components/responses/ForbiddenResponse'
76185
+ '404':
76186
+ $ref: '#/components/responses/NotFoundResponse'
76187
+ '429':
76188
+ $ref: '#/components/responses/TooManyRequestsResponse'
76189
+ security:
76190
+ - apiKeyAuth: []
76191
+ appKeyAuth: []
76192
+ - AuthZ: []
76193
+ summary: Delete an On-Call notification channel for a user
76194
+ tags:
76195
+ - On-Call
76196
+ x-permission:
76197
+ operator: AND
76198
+ permissions:
76199
+ - on_call_respond
76200
+ get:
76201
+ description: Get a notification channel for a user. The authenticated user must
76202
+ be the target user or have the `on_call_admin` permission
76203
+ operationId: GetUserNotificationChannel
76204
+ parameters:
76205
+ - description: The user ID
76206
+ in: path
76207
+ name: user_id
76208
+ required: true
76209
+ schema:
76210
+ example: 00000000-0000-0000-0000-000000000000
76211
+ type: string
76212
+ - description: The channel ID
76213
+ in: path
76214
+ name: channel_id
76215
+ required: true
76216
+ schema:
76217
+ example: 00000000-0000-0000-0000-000000000000
76218
+ type: string
76219
+ responses:
76220
+ '200':
76221
+ content:
76222
+ application/json:
76223
+ schema:
76224
+ $ref: '#/components/schemas/NotificationChannel'
76225
+ description: OK
76226
+ '400':
76227
+ $ref: '#/components/responses/BadRequestResponse'
76228
+ '401':
76229
+ $ref: '#/components/responses/UnauthorizedResponse'
76230
+ '403':
76231
+ $ref: '#/components/responses/ForbiddenResponse'
76232
+ '404':
76233
+ $ref: '#/components/responses/NotFoundResponse'
76234
+ '429':
76235
+ $ref: '#/components/responses/TooManyRequestsResponse'
76236
+ security:
76237
+ - apiKeyAuth: []
76238
+ appKeyAuth: []
76239
+ - AuthZ: []
76240
+ summary: Get an On-Call notification channel for a user
76241
+ tags:
76242
+ - On-Call
76243
+ x-permission:
76244
+ operator: AND
76245
+ permissions:
76246
+ - on_call_read
75381
76247
  /api/v2/org_configs:
75382
76248
  get:
75383
76249
  description: Returns all Org Configs (name, description, and value).
@@ -79678,11 +80544,13 @@ paths:
79678
80544
  - security_monitoring_cws_agent_rules_read
79679
80545
  /api/v2/security/findings/cases:
79680
80546
  delete:
79681
- description: Detach security findings from their case. This operation dissociates
79682
- security findings from their associated cases without deleting the cases themselves.
79683
- You can detach security findings from multiple different cases in a single
79684
- request, with a limit of 50 security findings per request. Security findings
79685
- that are not currently attached to any case will be ignored.
80547
+ description: 'Detach security findings from their case.
80548
+
80549
+ This operation dissociates security findings from their associated cases without
80550
+ deleting the cases themselves. You can detach security findings from multiple
80551
+ different cases in a single request, with a limit of 50 security findings
80552
+ per request. Security findings that are not currently attached to any case
80553
+ will be ignored.'
79686
80554
  operationId: DetachCase
79687
80555
  requestBody:
79688
80556
  content:
@@ -79713,10 +80581,12 @@ paths:
79713
80581
  - security_monitoring_findings_write
79714
80582
  - appsec_vm_write
79715
80583
  post:
79716
- description: Create cases for security findings. You can create up to 50 cases
79717
- per request and associate up to 50 security findings per case. Security findings
79718
- that are already attached to another case will be detached from their previous
79719
- case and attached to the newly created case.
80584
+ description: 'Create cases for security findings.
80585
+
80586
+ You can create up to 50 cases per request and associate up to 50 security
80587
+ findings per case. Security findings that are already attached to another
80588
+ case will be detached from their previous case and attached to the newly created
80589
+ case.'
79720
80590
  operationId: CreateCases
79721
80591
  requestBody:
79722
80592
  content:
@@ -79752,14 +80622,14 @@ paths:
79752
80622
  - appsec_vm_write
79753
80623
  /api/v2/security/findings/cases/{case_id}:
79754
80624
  patch:
79755
- description: Attach security findings to a case. You can attach up to 50 security
79756
- findings per case. Security findings that are already attached to another
79757
- case will be detached from their previous case and attached to the specified
79758
- case.
80625
+ description: 'Attach security findings to a case.
80626
+
80627
+ You can attach up to 50 security findings per case. Security findings that
80628
+ are already attached to another case will be detached from their previous
80629
+ case and attached to the specified case.'
79759
80630
  operationId: AttachCase
79760
80631
  parameters:
79761
- - description: The unique identifier of the case to attach security findings
79762
- to
80632
+ - description: Unique identifier of the case to attach security findings to
79763
80633
  in: path
79764
80634
  name: case_id
79765
80635
  required: true
@@ -79799,12 +80669,16 @@ paths:
79799
80669
  - appsec_vm_write
79800
80670
  /api/v2/security/findings/jira_issues:
79801
80671
  patch:
79802
- description: Attach security findings to a Jira issue by providing the Jira
79803
- issue URL. You can attach up to 50 security findings per Jira issue. If the
79804
- Jira issue is not linked to any case, this operation will create a case for
79805
- the security findings and link the Jira issue to the newly created case. Security
79806
- findings that are already attached to another Jira issue will be detached
79807
- from their previous Jira issue and attached to the specified Jira issue.
80672
+ description: 'Attach security findings to a Jira issue by providing the Jira
80673
+ issue URL.
80674
+
80675
+ You can attach up to 50 security findings per Jira issue. If the Jira issue
80676
+ is not linked to any case, this operation will create a case for the security
80677
+ findings and link the Jira issue to the newly created case. To configure the
80678
+ Jira integration, see [Bidirectional ticket syncing with Jira](https://docs.datadoghq.com/security/ticketing_integrations/#bidirectional-ticket-syncing-with-jira).
80679
+ Security findings that are already attached to another Jira issue will be
80680
+ detached from their previous Jira issue and attached to the specified Jira
80681
+ issue.'
79808
80682
  operationId: AttachJiraIssue
79809
80683
  requestBody:
79810
80684
  content:
@@ -79838,13 +80712,19 @@ paths:
79838
80712
  permissions:
79839
80713
  - security_monitoring_findings_write
79840
80714
  - appsec_vm_write
80715
+ x-unstable: '**Note**: This endpoint is in beta and is subject to change.
80716
+
80717
+ Please check the documentation regularly for updates.'
79841
80718
  post:
79842
- description: Create Jira issues for security findings. This operation creates
79843
- a case in Datadog and a Jira issue linked to that case for bidirectional sync
79844
- between Datadog and Jira. You can create up to 50 Jira issues per request
79845
- and associate up to 50 security findings per Jira issue. Security findings
79846
- that are already attached to another Jira issue will be detached from their
79847
- previous Jira issue and attached to the newly created Jira issue.
80719
+ description: 'Create Jira issues for security findings.
80720
+
80721
+ This operation creates a case in Datadog and a Jira issue linked to that case
80722
+ for bidirectional sync between Datadog and Jira. To configure the Jira integration,
80723
+ see [Bidirectional ticket syncing with Jira](https://docs.datadoghq.com/security/ticketing_integrations/#bidirectional-ticket-syncing-with-jira).
80724
+ You can create up to 50 Jira issues per request and associate up to 50 security
80725
+ findings per Jira issue. Security findings that are already attached to another
80726
+ Jira issue will be detached from their previous Jira issue and attached to
80727
+ the newly created Jira issue.'
79848
80728
  operationId: CreateJiraIssues
79849
80729
  requestBody:
79850
80730
  content:
@@ -79878,6 +80758,9 @@ paths:
79878
80758
  permissions:
79879
80759
  - security_monitoring_findings_write
79880
80760
  - appsec_vm_write
80761
+ x-unstable: '**Note**: This endpoint is in beta and is subject to change.
80762
+
80763
+ Please check the documentation regularly for updates.'
79881
80764
  /api/v2/security/sboms:
79882
80765
  get:
79883
80766
  description: 'Get a list of assets SBOMs for an organization.
@@ -80000,6 +80883,10 @@ paths:
80000
80883
  summary: List assets SBOMs
80001
80884
  tags:
80002
80885
  - Security Monitoring
80886
+ x-permission:
80887
+ operator: OR
80888
+ permissions:
80889
+ - appsec_vm_read
80003
80890
  x-unstable: '**Note**: This endpoint is a private preview.
80004
80891
 
80005
80892
  If you are interested in accessing this API, [fill out this form](https://forms.gle/kMYC1sDr6WDUBDsx9).'
@@ -80071,6 +80958,10 @@ paths:
80071
80958
  summary: Get SBOM
80072
80959
  tags:
80073
80960
  - Security Monitoring
80961
+ x-permission:
80962
+ operator: OR
80963
+ permissions:
80964
+ - appsec_vm_read
80074
80965
  x-unstable: '**Note**: This endpoint is a private preview.
80075
80966
 
80076
80967
  If you are interested in accessing this API, [fill out this form](https://forms.gle/kMYC1sDr6WDUBDsx9).'
@@ -80185,6 +81076,10 @@ paths:
80185
81076
  summary: List scanned assets metadata
80186
81077
  tags:
80187
81078
  - Security Monitoring
81079
+ x-permission:
81080
+ operator: OR
81081
+ permissions:
81082
+ - appsec_vm_read
80188
81083
  x-unstable: '**Note**: This endpoint is a private preview.
80189
81084
 
80190
81085
  If you are interested in accessing this API, [fill out this form](https://forms.gle/kMYC1sDr6WDUBDsx9).'
@@ -80613,6 +81508,14 @@ paths:
80613
81508
  required: false
80614
81509
  schema:
80615
81510
  type: string
81511
+ - description: Filter for whether the vulnerability affects a running kernel
81512
+ (for vulnerabilities related to a `Host` asset).
81513
+ example: true
81514
+ in: query
81515
+ name: filter[running_kernel]
81516
+ required: false
81517
+ schema:
81518
+ type: boolean
80616
81519
  - description: Filter by asset name. This field supports the usage of wildcards
80617
81520
  (*).
80618
81521
  example: datadog-agent
@@ -80756,6 +81659,10 @@ paths:
80756
81659
  summary: List vulnerabilities
80757
81660
  tags:
80758
81661
  - Security Monitoring
81662
+ x-permission:
81663
+ operator: OR
81664
+ permissions:
81665
+ - appsec_vm_read
80759
81666
  x-unstable: '**Note**: This endpoint is a private preview.
80760
81667
 
80761
81668
  If you are interested in accessing this API, [fill out this form](https://forms.gle/kMYC1sDr6WDUBDsx9).'
@@ -81114,6 +82021,10 @@ paths:
81114
82021
  summary: List vulnerable assets
81115
82022
  tags:
81116
82023
  - Security Monitoring
82024
+ x-permission:
82025
+ operator: OR
82026
+ permissions:
82027
+ - appsec_vm_read
81117
82028
  x-unstable: '**Note**: This endpoint is a private preview.
81118
82029
 
81119
82030
  If you are interested in accessing this API, [fill out this form](https://forms.gle/kMYC1sDr6WDUBDsx9).'
@@ -81690,6 +82601,35 @@ paths:
81690
82601
  summary: Update a suppression rule
81691
82602
  tags:
81692
82603
  - Security Monitoring
82604
+ /api/v2/security_monitoring/configuration/suppressions/{suppression_id}/version_history:
82605
+ get:
82606
+ description: Get a suppression's version history.
82607
+ operationId: GetSuppressionVersionHistory
82608
+ parameters:
82609
+ - $ref: '#/components/parameters/SecurityMonitoringSuppressionID'
82610
+ - $ref: '#/components/parameters/PageSize'
82611
+ - $ref: '#/components/parameters/PageNumber'
82612
+ responses:
82613
+ '200':
82614
+ content:
82615
+ application/json:
82616
+ schema:
82617
+ $ref: '#/components/schemas/GetSuppressionVersionHistoryResponse'
82618
+ description: OK
82619
+ '403':
82620
+ $ref: '#/components/responses/NotAuthorizedResponse'
82621
+ '404':
82622
+ $ref: '#/components/responses/NotFoundResponse'
82623
+ '429':
82624
+ $ref: '#/components/responses/TooManyRequestsResponse'
82625
+ security:
82626
+ - apiKeyAuth: []
82627
+ appKeyAuth: []
82628
+ - AuthZ:
82629
+ - security_monitoring_suppressions_read
82630
+ summary: Get a suppression's version history
82631
+ tags:
82632
+ - Security Monitoring
81693
82633
  /api/v2/security_monitoring/rules:
81694
82634
  get:
81695
82635
  description: List rules.
@@ -84251,8 +85191,8 @@ paths:
84251
85191
  x-unstable: '**Note**: This endpoint may be subject to changes.'
84252
85192
  /api/v2/static-analysis/secrets/rules:
84253
85193
  get:
84254
- description: Returns list of Secrets rules with ID, Pattern, Description, Priority,
84255
- and SDS ID
85194
+ description: Returns a list of Secrets rules with ID, Pattern, Description,
85195
+ Priority, and SDS ID.
84256
85196
  operationId: GetSecretsRules
84257
85197
  responses:
84258
85198
  '200':
@@ -84268,7 +85208,7 @@ paths:
84268
85208
  appKeyAuth: []
84269
85209
  - AuthZ:
84270
85210
  - code_analysis_read
84271
- summary: Returns list of Secrets rules
85211
+ summary: Returns a list of Secrets rules
84272
85212
  tags:
84273
85213
  - Security Monitoring
84274
85214
  x-unstable: '**Note**: This endpoint may be subject to changes.'
@@ -85658,7 +86598,13 @@ paths:
85658
86598
  permissions:
85659
86599
  - teams_read
85660
86600
  post:
85661
- description: Add a user to a team.
86601
+ description: 'Add a user to a team.
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).'
85662
86608
  operationId: CreateTeamMembership
85663
86609
  parameters:
85664
86610
  - description: None
@@ -85711,7 +86657,13 @@ paths:
85711
86657
  - teams_read
85712
86658
  /api/v2/team/{team_id}/memberships/{user_id}:
85713
86659
  delete:
85714
- description: Remove a user from a team.
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).'
85715
86667
  operationId: DeleteTeamMembership
85716
86668
  parameters:
85717
86669
  - description: None
@@ -85752,7 +86704,13 @@ paths:
85752
86704
  permissions:
85753
86705
  - teams_read
85754
86706
  patch:
85755
- description: Update a user's membership attributes on a team.
86707
+ description: 'Update a user''s membership attributes on a team.
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).'
85756
86714
  operationId: UpdateTeamMembership
85757
86715
  parameters:
85758
86716
  - description: None
@@ -87703,6 +88661,9 @@ servers:
87703
88661
  tags:
87704
88662
  - description: Configure your API endpoints through the Datadog API.
87705
88663
  name: API Management
88664
+ - description: Observe, troubleshoot, and improve cloud-scale applications with all
88665
+ telemetry in context
88666
+ name: APM
87706
88667
  - description: Manage configuration of [APM retention filters](https://app.datadoghq.com/apm/traces/retention-filters)
87707
88668
  for your organization. You need an API and application key with Admin rights to
87708
88669
  interact with this endpoint. See [retention filters](https://docs.datadoghq.com/tracing/trace_pipeline/trace_retention/#retention-filters)