datadog_api_client 2.31.0 → 2.32.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 (213) hide show
  1. checksums.yaml +4 -4
  2. data/.apigentools-info +4 -4
  3. data/.generator/schemas/v1/openapi.yaml +80 -4
  4. data/.generator/schemas/v2/openapi.yaml +2417 -93
  5. data/.generator/src/generator/cli.py +1 -1
  6. data/.generator/src/generator/formatter.py +3 -0
  7. data/.generator/src/generator/templates/api.j2 +1 -1
  8. data/.generator/src/generator/templates/inflector.j2 +1 -1
  9. data/CHANGELOG.md +35 -0
  10. data/examples/v1/slack-integration/CreateSlackIntegrationChannel.rb +1 -0
  11. data/examples/v1/slack-integration/UpdateSlackIntegrationChannel.rb +1 -0
  12. data/examples/v2/action-connection/CreateActionConnection.rb +1 -1
  13. data/examples/v2/action-connection/DeleteActionConnection.rb +4 -1
  14. data/examples/v2/apm-retention-filters/CreateApmRetentionFilter_3853850379.rb +21 -0
  15. data/examples/v2/apm-retention-filters/UpdateApmRetentionFilter_3916044058.rb +25 -0
  16. data/examples/v2/cloud-network-monitoring/GetAggregatedConnections.rb +8 -0
  17. data/examples/v2/cloud-network-monitoring/GetAggregatedConnections_3059356111.rb +8 -0
  18. data/examples/v2/observability-pipelines/CreatePipeline.rb +44 -0
  19. data/examples/v2/observability-pipelines/DeletePipeline.rb +11 -0
  20. data/examples/v2/observability-pipelines/GetPipeline.rb +11 -0
  21. data/examples/v2/observability-pipelines/UpdatePipeline.rb +48 -0
  22. data/examples/v2/on-call/CreateOnCallSchedule.rb +61 -0
  23. data/examples/v2/on-call/DeleteOnCallSchedule.rb +8 -0
  24. data/examples/v2/on-call/GetOnCallSchedule.rb +8 -0
  25. data/examples/v2/on-call/UpdateOnCallSchedule.rb +68 -0
  26. data/examples/v2/rum-retention-filters/CreateRetentionFilter.rb +0 -3
  27. data/examples/v2/security-monitoring/CreateSecurityMonitoringRule_1965169892.rb +6 -0
  28. data/examples/v2/service-definition/CreateOrUpdateServiceDefinitions.rb +1 -1
  29. data/examples/v2/software-catalog/UpsertCatalogEntity.rb +1 -0
  30. data/lib/datadog_api_client/configuration.rb +5 -0
  31. data/lib/datadog_api_client/inflector.rb +122 -3
  32. data/lib/datadog_api_client/v1/api/monitors_api.rb +1 -1
  33. data/lib/datadog_api_client/v1/models/formula_and_function_slo_query_type.rb +1 -0
  34. data/lib/datadog_api_client/v1/models/slack_integration_channel_display.rb +11 -1
  35. data/lib/datadog_api_client/v1/models/synthetics_step_type.rb +1 -0
  36. data/lib/datadog_api_client/v1/models/usage_summary_date.rb +41 -1
  37. data/lib/datadog_api_client/v1/models/usage_summary_date_org.rb +41 -1
  38. data/lib/datadog_api_client/v1/models/usage_summary_response.rb +41 -1
  39. data/lib/datadog_api_client/v2/api/cloud_network_monitoring_api.rb +108 -0
  40. data/lib/datadog_api_client/v2/api/downtimes_api.rb +2 -0
  41. data/lib/datadog_api_client/v2/api/observability_pipelines_api.rb +319 -0
  42. data/lib/datadog_api_client/v2/api/on_call_api.rb +301 -0
  43. data/lib/datadog_api_client/v2/api/restriction_policies_api.rb +7 -3
  44. data/lib/datadog_api_client/v2/api/rum_retention_filters_api.rb +13 -13
  45. data/lib/datadog_api_client/v2/models/api_trigger.rb +1 -1
  46. data/lib/datadog_api_client/v2/models/api_trigger_wrapper.rb +1 -1
  47. data/lib/datadog_api_client/v2/models/app_trigger_wrapper.rb +1 -1
  48. data/lib/datadog_api_client/v2/models/application_security_waf_custom_rule_tags_category.rb +1 -1
  49. data/lib/datadog_api_client/v2/models/case_trigger.rb +1 -1
  50. data/lib/datadog_api_client/v2/models/case_trigger_wrapper.rb +1 -1
  51. data/lib/datadog_api_client/v2/models/change_event_trigger_wrapper.rb +1 -1
  52. data/lib/datadog_api_client/v2/models/dashboard_trigger_wrapper.rb +1 -1
  53. data/lib/datadog_api_client/v2/models/database_monitoring_trigger_wrapper.rb +135 -0
  54. data/lib/datadog_api_client/v2/models/entity_response_included_incident.rb +1 -1
  55. data/lib/datadog_api_client/v2/models/{rum_retention_filter_source.rb → entity_response_included_incident_type.rb} +3 -6
  56. data/lib/datadog_api_client/v2/models/entity_response_included_oncall.rb +1 -1
  57. data/lib/datadog_api_client/v2/models/{service_definition_v2_dot2_type.rb → entity_response_included_oncall_type.rb} +3 -9
  58. data/lib/datadog_api_client/v2/models/entity_response_included_raw_schema.rb +1 -1
  59. data/lib/datadog_api_client/v2/models/entity_response_included_raw_schema_type.rb +26 -0
  60. data/lib/datadog_api_client/v2/models/entity_response_included_related_entity.rb +1 -1
  61. data/lib/datadog_api_client/v2/models/entity_response_included_related_entity_type.rb +26 -0
  62. data/lib/datadog_api_client/v2/models/entity_response_included_schema.rb +1 -1
  63. data/lib/datadog_api_client/v2/models/entity_response_included_schema_type.rb +26 -0
  64. data/lib/datadog_api_client/v2/models/entity_v3_datastore_spec.rb +13 -1
  65. data/lib/datadog_api_client/v2/models/entity_v3_queue_spec.rb +13 -1
  66. data/lib/datadog_api_client/v2/models/entity_v3_service_spec.rb +13 -1
  67. data/lib/datadog_api_client/v2/models/github_webhook_trigger.rb +1 -1
  68. data/lib/datadog_api_client/v2/models/github_webhook_trigger_wrapper.rb +1 -1
  69. data/lib/datadog_api_client/v2/models/historical_job_query.rb +11 -1
  70. data/lib/datadog_api_client/v2/models/incident_trigger.rb +1 -1
  71. data/lib/datadog_api_client/v2/models/incident_trigger_wrapper.rb +1 -1
  72. data/lib/datadog_api_client/v2/models/interface_attributes.rb +13 -1
  73. data/lib/datadog_api_client/v2/models/layer.rb +135 -0
  74. data/lib/datadog_api_client/v2/models/layer_attributes.rb +157 -0
  75. data/lib/datadog_api_client/v2/models/layer_attributes_interval.rb +144 -0
  76. data/lib/datadog_api_client/v2/models/layer_attributes_restrictions_items.rb +136 -0
  77. data/lib/datadog_api_client/v2/models/layer_attributes_restrictions_items_end_day.rb +32 -0
  78. data/lib/datadog_api_client/v2/models/layer_attributes_restrictions_items_start_day.rb +32 -0
  79. data/lib/datadog_api_client/v2/models/layer_relationships.rb +105 -0
  80. data/lib/datadog_api_client/v2/models/layer_relationships_members.rb +107 -0
  81. data/lib/datadog_api_client/v2/models/layer_relationships_members_data_items.rb +116 -0
  82. data/lib/datadog_api_client/v2/models/layer_relationships_members_data_items_type.rb +26 -0
  83. data/lib/datadog_api_client/v2/models/layer_type.rb +26 -0
  84. data/lib/datadog_api_client/v2/models/logs_aggregate_request.rb +1 -1
  85. data/lib/datadog_api_client/v2/models/logs_list_request.rb +1 -1
  86. data/lib/datadog_api_client/v2/models/logs_query_options.rb +4 -1
  87. data/lib/datadog_api_client/v2/models/monitor_trigger.rb +1 -1
  88. data/lib/datadog_api_client/v2/models/monitor_trigger_wrapper.rb +1 -1
  89. data/lib/datadog_api_client/v2/models/notebook_trigger_wrapper.rb +135 -0
  90. data/lib/datadog_api_client/v2/models/observability_pipeline.rb +123 -0
  91. data/lib/datadog_api_client/v2/models/observability_pipeline_add_fields_processor.rb +211 -0
  92. data/lib/datadog_api_client/v2/models/observability_pipeline_add_fields_processor_type.rb +26 -0
  93. data/lib/datadog_api_client/v2/models/observability_pipeline_config.rb +171 -0
  94. data/lib/datadog_api_client/v2/models/observability_pipeline_config_destination_item.rb +62 -0
  95. data/lib/datadog_api_client/v2/models/observability_pipeline_config_processor_item.rb +67 -0
  96. data/lib/datadog_api_client/v2/models/observability_pipeline_config_source_item.rb +63 -0
  97. data/lib/datadog_api_client/v2/models/observability_pipeline_create_request.rb +123 -0
  98. data/lib/datadog_api_client/v2/models/observability_pipeline_create_request_data.rb +144 -0
  99. data/lib/datadog_api_client/v2/models/observability_pipeline_data.rb +165 -0
  100. data/lib/datadog_api_client/v2/models/observability_pipeline_data_attributes.rb +144 -0
  101. data/lib/datadog_api_client/v2/models/observability_pipeline_datadog_agent_source.rb +154 -0
  102. data/lib/datadog_api_client/v2/models/observability_pipeline_datadog_agent_source_type.rb +26 -0
  103. data/lib/datadog_api_client/v2/models/observability_pipeline_datadog_logs_destination.rb +167 -0
  104. data/lib/datadog_api_client/v2/models/observability_pipeline_datadog_logs_destination_type.rb +26 -0
  105. data/lib/datadog_api_client/v2/models/observability_pipeline_field_value.rb +144 -0
  106. data/lib/datadog_api_client/v2/models/observability_pipeline_filter_processor.rb +188 -0
  107. data/lib/datadog_api_client/v2/models/observability_pipeline_filter_processor_type.rb +26 -0
  108. data/lib/datadog_api_client/v2/models/observability_pipeline_kafka_source.rb +220 -0
  109. data/lib/datadog_api_client/v2/models/observability_pipeline_kafka_source_librdkafka_option.rb +144 -0
  110. data/lib/datadog_api_client/v2/models/observability_pipeline_kafka_source_sasl.rb +105 -0
  111. data/lib/datadog_api_client/v2/models/observability_pipeline_kafka_source_type.rb +26 -0
  112. data/lib/datadog_api_client/v2/models/observability_pipeline_parse_json_processor.rb +209 -0
  113. data/lib/datadog_api_client/v2/models/observability_pipeline_parse_json_processor_type.rb +26 -0
  114. data/lib/datadog_api_client/v2/models/observability_pipeline_pipeline_kafka_source_sasl_mechanism.rb +28 -0
  115. data/lib/datadog_api_client/v2/models/observability_pipeline_quota_processor.rb +285 -0
  116. data/lib/datadog_api_client/v2/models/observability_pipeline_quota_processor_limit.rb +144 -0
  117. data/lib/datadog_api_client/v2/models/observability_pipeline_quota_processor_limit_enforce_type.rb +27 -0
  118. data/lib/datadog_api_client/v2/models/observability_pipeline_quota_processor_override.rb +146 -0
  119. data/lib/datadog_api_client/v2/models/observability_pipeline_quota_processor_type.rb +26 -0
  120. data/lib/datadog_api_client/v2/models/observability_pipeline_remove_fields_processor.rb +211 -0
  121. data/lib/datadog_api_client/v2/models/observability_pipeline_remove_fields_processor_type.rb +26 -0
  122. data/lib/datadog_api_client/v2/models/observability_pipeline_rename_fields_processor.rb +211 -0
  123. data/lib/datadog_api_client/v2/models/observability_pipeline_rename_fields_processor_field.rb +165 -0
  124. data/lib/datadog_api_client/v2/models/observability_pipeline_rename_fields_processor_type.rb +26 -0
  125. data/lib/datadog_api_client/v2/models/observability_pipeline_tls.rb +143 -0
  126. data/lib/datadog_api_client/v2/models/retention_filter_all_attributes.rb +16 -5
  127. data/lib/datadog_api_client/v2/models/retention_filter_attributes.rb +16 -5
  128. data/lib/datadog_api_client/v2/models/retention_filter_create_attributes.rb +16 -5
  129. data/lib/datadog_api_client/v2/models/retention_filter_update_attributes.rb +16 -5
  130. data/lib/datadog_api_client/v2/models/rum_retention_filter_create_data.rb +1 -11
  131. data/lib/datadog_api_client/v2/models/rum_retention_filter_data.rb +1 -11
  132. data/lib/datadog_api_client/v2/models/rum_retention_filter_update_data.rb +1 -11
  133. data/lib/datadog_api_client/v2/models/rum_retention_filters_order_request.rb +1 -1
  134. data/lib/datadog_api_client/v2/models/rum_retention_filters_response.rb +1 -1
  135. data/lib/datadog_api_client/v2/models/schedule.rb +117 -0
  136. data/lib/datadog_api_client/v2/models/schedule_create_request.rb +123 -0
  137. data/lib/datadog_api_client/v2/models/schedule_create_request_data.rb +154 -0
  138. data/lib/datadog_api_client/v2/models/schedule_create_request_data_attributes.rb +179 -0
  139. data/lib/datadog_api_client/v2/models/schedule_create_request_data_attributes_layers_items.rb +231 -0
  140. data/lib/datadog_api_client/v2/models/schedule_create_request_data_attributes_layers_items_interval.rb +144 -0
  141. data/lib/datadog_api_client/v2/models/schedule_create_request_data_attributes_layers_items_members_items.rb +105 -0
  142. data/lib/datadog_api_client/v2/models/{rum_retention_filter_meta.rb → schedule_create_request_data_attributes_layers_items_members_items_user.rb} +11 -11
  143. data/lib/datadog_api_client/v2/models/schedule_create_request_data_attributes_layers_items_restrictions_items.rb +136 -0
  144. data/lib/datadog_api_client/v2/models/schedule_create_request_data_attributes_layers_items_restrictions_items_end_day.rb +32 -0
  145. data/lib/datadog_api_client/v2/models/schedule_create_request_data_attributes_layers_items_restrictions_items_start_day.rb +32 -0
  146. data/lib/datadog_api_client/v2/models/schedule_create_request_data_relationships.rb +105 -0
  147. data/lib/datadog_api_client/v2/models/schedule_create_request_data_relationships_teams.rb +107 -0
  148. data/lib/datadog_api_client/v2/models/schedule_create_request_data_relationships_teams_data_items.rb +116 -0
  149. data/lib/datadog_api_client/v2/models/schedule_create_request_data_relationships_teams_data_items_type.rb +26 -0
  150. data/lib/datadog_api_client/v2/models/schedule_create_request_data_type.rb +26 -0
  151. data/lib/datadog_api_client/v2/models/schedule_data.rb +135 -0
  152. data/lib/datadog_api_client/v2/models/schedule_data_attributes.rb +127 -0
  153. data/lib/datadog_api_client/v2/models/schedule_data_included_item.rb +65 -0
  154. data/lib/datadog_api_client/v2/models/schedule_data_relationships.rb +115 -0
  155. data/lib/datadog_api_client/v2/models/schedule_data_relationships_layers.rb +107 -0
  156. data/lib/datadog_api_client/v2/models/schedule_data_relationships_layers_data_items.rb +115 -0
  157. data/lib/datadog_api_client/v2/models/schedule_data_relationships_layers_data_items_type.rb +26 -0
  158. data/lib/datadog_api_client/v2/models/schedule_data_relationships_teams.rb +107 -0
  159. data/lib/datadog_api_client/v2/models/schedule_data_relationships_teams_data_items.rb +115 -0
  160. data/lib/datadog_api_client/v2/models/schedule_data_relationships_teams_data_items_type.rb +26 -0
  161. data/lib/datadog_api_client/v2/models/schedule_data_type.rb +26 -0
  162. data/lib/datadog_api_client/v2/models/schedule_member.rb +125 -0
  163. data/lib/datadog_api_client/v2/models/schedule_member_relationships.rb +105 -0
  164. data/lib/datadog_api_client/v2/models/schedule_member_relationships_user.rb +105 -0
  165. data/lib/datadog_api_client/v2/models/schedule_member_relationships_user_data.rb +115 -0
  166. data/lib/datadog_api_client/v2/models/schedule_member_relationships_user_data_type.rb +26 -0
  167. data/lib/datadog_api_client/v2/models/schedule_member_type.rb +26 -0
  168. data/lib/datadog_api_client/v2/models/schedule_trigger.rb +1 -1
  169. data/lib/datadog_api_client/v2/models/schedule_trigger_wrapper.rb +1 -1
  170. data/lib/datadog_api_client/v2/models/schedule_update_request.rb +123 -0
  171. data/lib/datadog_api_client/v2/models/schedule_update_request_data.rb +175 -0
  172. data/lib/datadog_api_client/v2/models/schedule_update_request_data_attributes.rb +179 -0
  173. data/lib/datadog_api_client/v2/models/schedule_update_request_data_attributes_layers_items.rb +180 -0
  174. data/lib/datadog_api_client/v2/models/schedule_update_request_data_attributes_layers_items_interval.rb +144 -0
  175. data/lib/datadog_api_client/v2/models/schedule_update_request_data_attributes_layers_items_members_items.rb +106 -0
  176. data/lib/datadog_api_client/v2/models/schedule_update_request_data_attributes_layers_items_members_items_user.rb +105 -0
  177. data/lib/datadog_api_client/v2/models/schedule_update_request_data_attributes_layers_items_restrictions_items.rb +136 -0
  178. data/lib/datadog_api_client/v2/models/schedule_update_request_data_attributes_layers_items_restrictions_items_end_day.rb +32 -0
  179. data/lib/datadog_api_client/v2/models/schedule_update_request_data_attributes_layers_items_restrictions_items_start_day.rb +32 -0
  180. data/lib/datadog_api_client/v2/models/schedule_update_request_data_relationships.rb +105 -0
  181. data/lib/datadog_api_client/v2/models/schedule_update_request_data_relationships_teams.rb +107 -0
  182. data/lib/datadog_api_client/v2/models/schedule_update_request_data_relationships_teams_data_items.rb +115 -0
  183. data/lib/datadog_api_client/v2/models/schedule_update_request_data_relationships_teams_data_items_type.rb +26 -0
  184. data/lib/datadog_api_client/v2/models/schedule_update_request_data_type.rb +26 -0
  185. data/lib/datadog_api_client/v2/models/schedule_user.rb +125 -0
  186. data/lib/datadog_api_client/v2/models/schedule_user_attributes.rb +115 -0
  187. data/lib/datadog_api_client/v2/models/schedule_user_type.rb +26 -0
  188. data/lib/datadog_api_client/v2/models/security_monitoring_rule_case_action_options.rb +13 -3
  189. data/lib/datadog_api_client/v2/models/security_monitoring_rule_case_action_type.rb +1 -0
  190. data/lib/datadog_api_client/v2/models/security_monitoring_standard_data_source.rb +31 -0
  191. data/lib/datadog_api_client/v2/models/security_monitoring_standard_rule_query.rb +11 -1
  192. data/lib/datadog_api_client/v2/models/security_trigger.rb +1 -1
  193. data/lib/datadog_api_client/v2/models/security_trigger_wrapper.rb +1 -1
  194. data/lib/datadog_api_client/v2/models/self_service_trigger_wrapper.rb +135 -0
  195. data/lib/datadog_api_client/v2/models/service_definition_v2_dot2.rb +1 -1
  196. data/lib/datadog_api_client/v2/models/single_aggregated_connection_response_array.rb +107 -0
  197. data/lib/datadog_api_client/v2/models/single_aggregated_connection_response_data.rb +125 -0
  198. data/lib/datadog_api_client/v2/models/single_aggregated_connection_response_data_attributes.rb +215 -0
  199. data/lib/datadog_api_client/v2/models/single_aggregated_connection_response_data_type.rb +26 -0
  200. data/lib/datadog_api_client/v2/models/slack_trigger_wrapper.rb +1 -1
  201. data/lib/datadog_api_client/v2/models/software_catalog_trigger_wrapper.rb +135 -0
  202. data/lib/datadog_api_client/v2/models/team_reference.rb +135 -0
  203. data/lib/datadog_api_client/v2/models/team_reference_attributes.rb +135 -0
  204. data/lib/datadog_api_client/v2/models/team_reference_relationships.rb +105 -0
  205. data/lib/datadog_api_client/v2/models/team_reference_relationships_oncall_users.rb +107 -0
  206. data/lib/datadog_api_client/v2/models/team_reference_relationships_oncall_users_data_items.rb +115 -0
  207. data/lib/datadog_api_client/v2/models/team_reference_relationships_oncall_users_data_items_type.rb +26 -0
  208. data/lib/datadog_api_client/v2/models/team_reference_type.rb +26 -0
  209. data/lib/datadog_api_client/v2/models/trigger.rb +4 -0
  210. data/lib/datadog_api_client/v2/models/workflow_trigger_wrapper.rb +1 -1
  211. data/lib/datadog_api_client/version.rb +1 -1
  212. metadata +136 -6
  213. data/examples/v2/action-connection/DeleteActionConnection_2142905164.rb +0 -8
@@ -654,8 +654,8 @@ components:
654
654
  type: string
655
655
  ResourceID:
656
656
  description: 'Identifier, formatted as `type:id`. Supported types: `connection`,
657
- `dashboard`, `notebook`, `reference-table`, `security-rule`, `slo`, `workflow`,
658
- `app-builder-app`, `connection`, `connection-group`.'
657
+ `dashboard`, `integration-account`, `integration-webhook`, `notebook`, `reference-table`,
658
+ `security-rule`, `slo`, `workflow`, `app-builder-app`, `connection`, `connection-group`.'
659
659
  example: dashboard:abc-def-ghi
660
660
  in: path
661
661
  name: resource_id
@@ -684,7 +684,7 @@ components:
684
684
  schema:
685
685
  type: string
686
686
  RumApplicationIDParameter:
687
- description: Application ID.
687
+ description: RUM application ID.
688
688
  in: path
689
689
  name: app_id
690
690
  required: true
@@ -1095,7 +1095,7 @@ components:
1095
1095
  x-enum-varnames:
1096
1096
  - API_KEYS
1097
1097
  APITrigger:
1098
- description: Trigger a workflow VIA an API. The workflow must be published.
1098
+ description: Trigger a workflow from an API request. The workflow must be published.
1099
1099
  properties:
1100
1100
  rateLimit:
1101
1101
  $ref: '#/components/schemas/TriggerRateLimit'
@@ -2313,7 +2313,7 @@ components:
2313
2313
  description: Schema for an App-based trigger.
2314
2314
  properties:
2315
2315
  appTrigger:
2316
- description: Trigger a workflow VIA an App.
2316
+ description: Trigger a workflow from an App.
2317
2317
  type: object
2318
2318
  startStepNames:
2319
2319
  $ref: '#/components/schemas/StartStepNames'
@@ -2864,13 +2864,13 @@ components:
2864
2864
  enum:
2865
2865
  - attack_attempt
2866
2866
  - business_logic
2867
- - security_responses
2867
+ - security_response
2868
2868
  example: business_logic
2869
2869
  type: string
2870
2870
  x-enum-varnames:
2871
2871
  - ATTACK_ATTEMPT
2872
2872
  - BUSINESS_LOGIC
2873
- - SECURITY_RESPONSES
2873
+ - SECURITY_RESPONSE
2874
2874
  ApplicationSecurityWafCustomRuleType:
2875
2875
  default: custom_rule
2876
2876
  description: The type of the resource. The value should always be `custom_rule`.
@@ -6525,7 +6525,7 @@ components:
6525
6525
  - IN_PROGRESS
6526
6526
  - CLOSED
6527
6527
  CaseTrigger:
6528
- description: Trigger a workflow VIA a Case. For automatic triggering a handle
6528
+ description: Trigger a workflow from a Case. For automatic triggering a handle
6529
6529
  must be configured and the workflow must be published.
6530
6530
  properties:
6531
6531
  rateLimit:
@@ -6762,7 +6762,7 @@ components:
6762
6762
  description: Schema for a Change Event-based trigger.
6763
6763
  properties:
6764
6764
  changeEventTrigger:
6765
- description: Trigger a workflow VIA a Change Event.
6765
+ description: Trigger a workflow from a Change Event.
6766
6766
  type: object
6767
6767
  startStepNames:
6768
6768
  $ref: '#/components/schemas/StartStepNames'
@@ -10589,7 +10589,7 @@ components:
10589
10589
  description: Schema for a Dashboard-based trigger.
10590
10590
  properties:
10591
10591
  dashboardTrigger:
10592
- description: Trigger a workflow VIA a Dashboard.
10592
+ description: Trigger a workflow from a Dashboard.
10593
10593
  type: object
10594
10594
  startStepNames:
10595
10595
  $ref: '#/components/schemas/StartStepNames'
@@ -10813,6 +10813,17 @@ components:
10813
10813
  type: string
10814
10814
  x-enum-varnames:
10815
10815
  - DATATRANSFORM
10816
+ DatabaseMonitoringTriggerWrapper:
10817
+ description: Schema for a Database Monitoring-based trigger.
10818
+ properties:
10819
+ databaseMonitoringTrigger:
10820
+ description: Trigger a workflow from Database Monitoring.
10821
+ type: object
10822
+ startStepNames:
10823
+ $ref: '#/components/schemas/StartStepNames'
10824
+ required:
10825
+ - databaseMonitoringTrigger
10826
+ type: object
10816
10827
  Date:
10817
10828
  description: Date as Unix timestamp in milliseconds.
10818
10829
  example: 1722439510282
@@ -11936,9 +11947,15 @@ components:
11936
11947
  description: Incident ID.
11937
11948
  type: string
11938
11949
  type:
11939
- description: Incident description.
11940
- type: string
11950
+ $ref: '#/components/schemas/EntityResponseIncludedIncidentType'
11941
11951
  type: object
11952
+ EntityResponseIncludedIncidentType:
11953
+ description: Incident description.
11954
+ enum:
11955
+ - incident
11956
+ type: string
11957
+ x-enum-varnames:
11958
+ - INCIDENT
11942
11959
  EntityResponseIncludedOncall:
11943
11960
  description: Included oncall.
11944
11961
  properties:
@@ -11948,9 +11965,15 @@ components:
11948
11965
  description: Oncall ID.
11949
11966
  type: string
11950
11967
  type:
11951
- description: Oncall type.
11952
- type: string
11968
+ $ref: '#/components/schemas/EntityResponseIncludedOncallType'
11953
11969
  type: object
11970
+ EntityResponseIncludedOncallType:
11971
+ description: Oncall type.
11972
+ enum:
11973
+ - oncall
11974
+ type: string
11975
+ x-enum-varnames:
11976
+ - ONCALL
11954
11977
  EntityResponseIncludedRawSchema:
11955
11978
  description: Included raw schema.
11956
11979
  properties:
@@ -11960,8 +11983,7 @@ components:
11960
11983
  description: Raw schema ID.
11961
11984
  type: string
11962
11985
  type:
11963
- description: Raw schema type.
11964
- type: string
11986
+ $ref: '#/components/schemas/EntityResponseIncludedRawSchemaType'
11965
11987
  type: object
11966
11988
  EntityResponseIncludedRawSchemaAttributes:
11967
11989
  description: Included raw schema attributes.
@@ -11970,6 +11992,13 @@ components:
11970
11992
  description: Schema from user input in base64 encoding.
11971
11993
  type: string
11972
11994
  type: object
11995
+ EntityResponseIncludedRawSchemaType:
11996
+ description: Raw schema type.
11997
+ enum:
11998
+ - rawSchema
11999
+ type: string
12000
+ x-enum-varnames:
12001
+ - RAW_SCHEMA
11973
12002
  EntityResponseIncludedRelatedEntity:
11974
12003
  description: Included related entity.
11975
12004
  properties:
@@ -11981,8 +12010,7 @@ components:
11981
12010
  meta:
11982
12011
  $ref: '#/components/schemas/EntityResponseIncludedRelatedEntityMeta'
11983
12012
  type:
11984
- description: Related entity.
11985
- type: string
12013
+ $ref: '#/components/schemas/EntityResponseIncludedRelatedEntityType'
11986
12014
  type: object
11987
12015
  EntityResponseIncludedRelatedEntityAttributes:
11988
12016
  description: Related entity attributes.
@@ -12018,6 +12046,13 @@ components:
12018
12046
  description: Entity relation source.
12019
12047
  type: string
12020
12048
  type: object
12049
+ EntityResponseIncludedRelatedEntityType:
12050
+ description: Related entity.
12051
+ enum:
12052
+ - relatedEntity
12053
+ type: string
12054
+ x-enum-varnames:
12055
+ - RELATED_ENTITY
12021
12056
  EntityResponseIncludedRelatedIncidentAttributes:
12022
12057
  description: Incident attributes.
12023
12058
  properties:
@@ -12075,8 +12110,7 @@ components:
12075
12110
  description: Entity ID.
12076
12111
  type: string
12077
12112
  type:
12078
- description: Schema type.
12079
- type: string
12113
+ $ref: '#/components/schemas/EntityResponseIncludedSchemaType'
12080
12114
  type: object
12081
12115
  EntityResponseIncludedSchemaAttributes:
12082
12116
  description: Included schema.
@@ -12084,6 +12118,13 @@ components:
12084
12118
  schema:
12085
12119
  $ref: '#/components/schemas/EntityV3'
12086
12120
  type: object
12121
+ EntityResponseIncludedSchemaType:
12122
+ description: Schema type.
12123
+ enum:
12124
+ - schema
12125
+ type: string
12126
+ x-enum-varnames:
12127
+ - SCHEMA
12087
12128
  EntityResponseMeta:
12088
12129
  description: Entity metadata.
12089
12130
  properties:
@@ -12390,6 +12431,11 @@ components:
12390
12431
  additionalProperties: false
12391
12432
  description: The definition of Entity V3 Datastore Spec object.
12392
12433
  properties:
12434
+ componentOf:
12435
+ description: A list of components the datastore is a part of
12436
+ items:
12437
+ type: string
12438
+ type: array
12393
12439
  lifecycle:
12394
12440
  description: The lifecycle state of the datastore.
12395
12441
  minLength: 1
@@ -12588,6 +12634,11 @@ components:
12588
12634
  additionalProperties: false
12589
12635
  description: The definition of Entity V3 Queue Spec object.
12590
12636
  properties:
12637
+ componentOf:
12638
+ description: A list of components the queue is a part of
12639
+ items:
12640
+ type: string
12641
+ type: array
12591
12642
  lifecycle:
12592
12643
  description: The lifecycle state of the queue.
12593
12644
  minLength: 1
@@ -12653,6 +12704,11 @@ components:
12653
12704
  additionalProperties: false
12654
12705
  description: The definition of Entity V3 Service Spec object.
12655
12706
  properties:
12707
+ componentOf:
12708
+ description: A list of components the service is a part of
12709
+ items:
12710
+ type: string
12711
+ type: array
12656
12712
  dependsOn:
12657
12713
  description: A list of components the service depends on.
12658
12714
  items:
@@ -14363,9 +14419,9 @@ components:
14363
14419
  example: https://github.com/organization/example-repository
14364
14420
  type: string
14365
14421
  GithubWebhookTrigger:
14366
- description: Trigger a workflow VIA GitHub webhook. To trigger a workflow from
14367
- GitHub, you must set a `webhookSecret`. In your GitHub Webhook Settings, set
14368
- the Payload URL to "base_url"/api/v2/workflows/"workflow_id"/webhook?orgId="org_id",
14422
+ description: Trigger a workflow from a GitHub webhook. To trigger a workflow
14423
+ from GitHub, you must set a `webhookSecret`. In your GitHub Webhook Settings,
14424
+ set the Payload URL to "base_url"/api/v2/workflows/"workflow_id"/webhook?orgId="org_id",
14369
14425
  select application/json for the content type, and be highly recommend enabling
14370
14426
  SSL verification for security. The workflow must be published.
14371
14427
  properties:
@@ -14746,6 +14802,8 @@ components:
14746
14802
  properties:
14747
14803
  aggregation:
14748
14804
  $ref: '#/components/schemas/SecurityMonitoringRuleQueryAggregation'
14805
+ dataSource:
14806
+ $ref: '#/components/schemas/SecurityMonitoringStandardDataSource'
14749
14807
  distinctFields:
14750
14808
  description: Field for which the cardinality is measured. Sent as an array.
14751
14809
  items:
@@ -16674,7 +16732,7 @@ components:
16674
16732
  x-enum-varnames:
16675
16733
  - INCIDENT_TODOS
16676
16734
  IncidentTrigger:
16677
- description: Trigger a workflow VIA an Incident. For automatic triggering a
16735
+ description: Trigger a workflow from an Incident. For automatic triggering a
16678
16736
  handle must be configured and the workflow must be published.
16679
16737
  properties:
16680
16738
  rateLimit:
@@ -17213,6 +17271,14 @@ components:
17213
17271
  example: 0
17214
17272
  format: int64
17215
17273
  type: integer
17274
+ ip_addresses:
17275
+ description: The interface IP addresses
17276
+ example:
17277
+ - 1.1.1.1
17278
+ - 1.1.1.2
17279
+ items:
17280
+ type: string
17281
+ type: array
17216
17282
  mac_address:
17217
17283
  description: The interface MAC address
17218
17284
  example: 00:00:00:00:00:00
@@ -17491,6 +17557,164 @@ components:
17491
17557
  - index
17492
17558
  - caseIndex
17493
17559
  type: object
17560
+ Layer:
17561
+ description: Encapsulates a layer resource, holding attributes like rotation
17562
+ details, plus relationships to the members covering that layer.
17563
+ properties:
17564
+ attributes:
17565
+ $ref: '#/components/schemas/LayerAttributes'
17566
+ id:
17567
+ description: A unique identifier for this layer.
17568
+ type: string
17569
+ relationships:
17570
+ $ref: '#/components/schemas/LayerRelationships'
17571
+ type:
17572
+ $ref: '#/components/schemas/LayerType'
17573
+ type: object
17574
+ LayerAttributes:
17575
+ description: Describes key properties of a Layer, including rotation details,
17576
+ name, start/end times, and any restrictions.
17577
+ properties:
17578
+ effective_date:
17579
+ description: When the layer becomes active (ISO 8601).
17580
+ format: date-time
17581
+ type: string
17582
+ end_date:
17583
+ description: When the layer ceases to be active (ISO 8601).
17584
+ format: date-time
17585
+ type: string
17586
+ interval:
17587
+ $ref: '#/components/schemas/LayerAttributesInterval'
17588
+ name:
17589
+ description: The name of this layer.
17590
+ example: Weekend Layer
17591
+ type: string
17592
+ restrictions:
17593
+ description: An optional list of time restrictions for when this layer is
17594
+ in effect.
17595
+ items:
17596
+ $ref: '#/components/schemas/LayerAttributesRestrictionsItems'
17597
+ type: array
17598
+ rotation_start:
17599
+ description: The date/time when the rotation starts (ISO 8601).
17600
+ format: date-time
17601
+ type: string
17602
+ type: object
17603
+ LayerAttributesInterval:
17604
+ description: Defines how often the rotation repeats, using a combination of
17605
+ days and optional seconds.
17606
+ properties:
17607
+ days:
17608
+ description: The number of days in each rotation cycle.
17609
+ format: int32
17610
+ maximum: 400
17611
+ type: integer
17612
+ seconds:
17613
+ description: Any additional seconds for the rotation cycle (up to 30 days).
17614
+ format: int64
17615
+ maximum: 2592000
17616
+ type: integer
17617
+ type: object
17618
+ LayerAttributesRestrictionsItems:
17619
+ description: 'Represents a time restriction within a layer, specifying the days
17620
+ and times
17621
+
17622
+ when this layer is active or inactive.'
17623
+ properties:
17624
+ end_day:
17625
+ $ref: '#/components/schemas/LayerAttributesRestrictionsItemsEndDay'
17626
+ end_time:
17627
+ description: The time of day the restriction ends (hh:mm:ss).
17628
+ type: string
17629
+ start_day:
17630
+ $ref: '#/components/schemas/LayerAttributesRestrictionsItemsStartDay'
17631
+ start_time:
17632
+ description: The time of day the restriction begins (hh:mm:ss).
17633
+ type: string
17634
+ type: object
17635
+ LayerAttributesRestrictionsItemsEndDay:
17636
+ description: Defines the end day of the restriction within a Layer.
17637
+ enum:
17638
+ - monday
17639
+ - tuesday
17640
+ - wednesday
17641
+ - thursday
17642
+ - friday
17643
+ - saturday
17644
+ - sunday
17645
+ type: string
17646
+ x-enum-varnames:
17647
+ - MONDAY
17648
+ - TUESDAY
17649
+ - WEDNESDAY
17650
+ - THURSDAY
17651
+ - FRIDAY
17652
+ - SATURDAY
17653
+ - SUNDAY
17654
+ LayerAttributesRestrictionsItemsStartDay:
17655
+ description: Defines the start day of the restriction within a Layer.
17656
+ enum:
17657
+ - monday
17658
+ - tuesday
17659
+ - wednesday
17660
+ - thursday
17661
+ - friday
17662
+ - saturday
17663
+ - sunday
17664
+ type: string
17665
+ x-enum-varnames:
17666
+ - MONDAY
17667
+ - TUESDAY
17668
+ - WEDNESDAY
17669
+ - THURSDAY
17670
+ - FRIDAY
17671
+ - SATURDAY
17672
+ - SUNDAY
17673
+ LayerRelationships:
17674
+ description: Holds references to objects related to the Layer entity, such as
17675
+ its members.
17676
+ properties:
17677
+ members:
17678
+ $ref: '#/components/schemas/LayerRelationshipsMembers'
17679
+ type: object
17680
+ LayerRelationshipsMembers:
17681
+ description: Holds an array of references to the members of a Layer, each containing
17682
+ member IDs.
17683
+ properties:
17684
+ data:
17685
+ description: The list of members who belong to this layer.
17686
+ items:
17687
+ $ref: '#/components/schemas/LayerRelationshipsMembersDataItems'
17688
+ type: array
17689
+ type: object
17690
+ LayerRelationshipsMembersDataItems:
17691
+ description: 'Represents a single member object in a layer''s `members` array,
17692
+ referencing
17693
+
17694
+ a unique Datadog user ID.'
17695
+ properties:
17696
+ id:
17697
+ description: The unique user ID of the layer member.
17698
+ type: string
17699
+ type:
17700
+ $ref: '#/components/schemas/LayerRelationshipsMembersDataItemsType'
17701
+ type: object
17702
+ LayerRelationshipsMembersDataItemsType:
17703
+ default: members
17704
+ description: Members resource type.
17705
+ enum:
17706
+ - members
17707
+ type: string
17708
+ x-enum-varnames:
17709
+ - MEMBERS
17710
+ LayerType:
17711
+ default: layers
17712
+ description: Layers resource type.
17713
+ enum:
17714
+ - layers
17715
+ type: string
17716
+ x-enum-varnames:
17717
+ - LAYERS
17494
17718
  LeakedKey:
17495
17719
  description: The definition of LeakedKey object.
17496
17720
  properties:
@@ -19066,10 +19290,10 @@ components:
19066
19290
  type: string
19067
19291
  type: object
19068
19292
  LogsQueryOptions:
19293
+ deprecated: true
19069
19294
  description: 'Global query options that are used during the query.
19070
19295
 
19071
- Note: you should supply either timezone or time offset, but not both. Otherwise,
19072
- the query will fail.'
19296
+ Note: These fields are currently deprecated and do not affect the query results.'
19073
19297
  properties:
19074
19298
  timeOffset:
19075
19299
  description: The time offset (in seconds) to apply to the query.
@@ -21147,7 +21371,7 @@ components:
21147
21371
  $ref: '#/components/schemas/MonitorDowntimeMatchResourceType'
21148
21372
  type: object
21149
21373
  MonitorTrigger:
21150
- description: Trigger a workflow VIA a Monitor. For automatic triggering a handle
21374
+ description: Trigger a workflow from a Monitor. For automatic triggering a handle
21151
21375
  must be configured and the workflow must be published.
21152
21376
  properties:
21153
21377
  rateLimit:
@@ -21285,6 +21509,17 @@ components:
21285
21509
  meta:
21286
21510
  $ref: '#/components/schemas/MonthlyCostAttributionMeta'
21287
21511
  type: object
21512
+ NotebookTriggerWrapper:
21513
+ description: Schema for a Notebook-based trigger.
21514
+ properties:
21515
+ notebookTrigger:
21516
+ description: Trigger a workflow from a Notebook.
21517
+ type: object
21518
+ startStepNames:
21519
+ $ref: '#/components/schemas/StartStepNames'
21520
+ required:
21521
+ - notebookTrigger
21522
+ type: object
21288
21523
  NotificationRule:
21289
21524
  description: 'Notification rules allow full control over notifications generated
21290
21525
  by the various Datadog security products.
@@ -21409,6 +21644,668 @@ components:
21409
21644
  - id
21410
21645
  - type
21411
21646
  type: object
21647
+ ObservabilityPipeline:
21648
+ description: Top-level schema representing a pipeline.
21649
+ properties:
21650
+ data:
21651
+ $ref: '#/components/schemas/ObservabilityPipelineData'
21652
+ required:
21653
+ - data
21654
+ type: object
21655
+ ObservabilityPipelineAddFieldsProcessor:
21656
+ description: The `add_fields` processor adds static key-value fields to logs.
21657
+ properties:
21658
+ fields:
21659
+ description: A list of static fields (key-value pairs) that is added to
21660
+ each log event processed by this component.
21661
+ items:
21662
+ $ref: '#/components/schemas/ObservabilityPipelineFieldValue'
21663
+ type: array
21664
+ id:
21665
+ description: The unique identifier for this component. Used to reference
21666
+ this component in other parts of the pipeline (for example, as the `input`
21667
+ to downstream components).
21668
+ example: add-fields-processor
21669
+ type: string
21670
+ include:
21671
+ description: A Datadog search query used to determine which logs this processor
21672
+ targets.
21673
+ example: service:my-service
21674
+ type: string
21675
+ inputs:
21676
+ description: A list of component IDs whose output is used as the `input`
21677
+ for this component.
21678
+ example:
21679
+ - datadog-agent-source
21680
+ items:
21681
+ type: string
21682
+ type: array
21683
+ type:
21684
+ $ref: '#/components/schemas/ObservabilityPipelineAddFieldsProcessorType'
21685
+ required:
21686
+ - id
21687
+ - type
21688
+ - include
21689
+ - fields
21690
+ - inputs
21691
+ type: object
21692
+ ObservabilityPipelineAddFieldsProcessorType:
21693
+ default: add_fields
21694
+ description: The processor type. The value should always be `add_fields`.
21695
+ enum:
21696
+ - add_fields
21697
+ example: add_fields
21698
+ type: string
21699
+ x-enum-varnames:
21700
+ - ADD_FIELDS
21701
+ ObservabilityPipelineConfig:
21702
+ description: Specifies the pipeline's configuration, including its sources,
21703
+ processors, and destinations.
21704
+ properties:
21705
+ destinations:
21706
+ description: A list of destination components where processed logs are sent.
21707
+ example:
21708
+ - id: datadog-logs-destination
21709
+ inputs:
21710
+ - filter-processor
21711
+ type: datadog_logs
21712
+ items:
21713
+ $ref: '#/components/schemas/ObservabilityPipelineConfigDestinationItem'
21714
+ type: array
21715
+ processors:
21716
+ description: A list of processors that transform or enrich log data.
21717
+ example:
21718
+ - id: filter-processor
21719
+ include: service:my-service
21720
+ inputs:
21721
+ - datadog-agent-source
21722
+ type: filter
21723
+ items:
21724
+ $ref: '#/components/schemas/ObservabilityPipelineConfigProcessorItem'
21725
+ type: array
21726
+ sources:
21727
+ description: A list of configured data sources for the pipeline.
21728
+ example:
21729
+ - id: datadog-agent-source
21730
+ type: datadog_agent
21731
+ items:
21732
+ $ref: '#/components/schemas/ObservabilityPipelineConfigSourceItem'
21733
+ type: array
21734
+ required:
21735
+ - sources
21736
+ - processors
21737
+ - destinations
21738
+ type: object
21739
+ ObservabilityPipelineConfigDestinationItem:
21740
+ description: A destination for the pipeline.
21741
+ oneOf:
21742
+ - $ref: '#/components/schemas/ObservabilityPipelineDatadogLogsDestination'
21743
+ ObservabilityPipelineConfigProcessorItem:
21744
+ description: A processor for the pipeline.
21745
+ oneOf:
21746
+ - $ref: '#/components/schemas/ObservabilityPipelineFilterProcessor'
21747
+ - $ref: '#/components/schemas/ObservabilityPipelineParseJSONProcessor'
21748
+ - $ref: '#/components/schemas/ObservabilityPipelineQuotaProcessor'
21749
+ - $ref: '#/components/schemas/ObservabilityPipelineAddFieldsProcessor'
21750
+ - $ref: '#/components/schemas/ObservabilityPipelineRemoveFieldsProcessor'
21751
+ - $ref: '#/components/schemas/ObservabilityPipelineRenameFieldsProcessor'
21752
+ ObservabilityPipelineConfigSourceItem:
21753
+ description: A data source for the pipeline.
21754
+ oneOf:
21755
+ - $ref: '#/components/schemas/ObservabilityPipelineKafkaSource'
21756
+ - $ref: '#/components/schemas/ObservabilityPipelineDatadogAgentSource'
21757
+ ObservabilityPipelineCreateRequest:
21758
+ description: Top-level schema representing a pipeline.
21759
+ properties:
21760
+ data:
21761
+ $ref: '#/components/schemas/ObservabilityPipelineCreateRequestData'
21762
+ required:
21763
+ - data
21764
+ type: object
21765
+ ObservabilityPipelineCreateRequestData:
21766
+ description: "Contains the pipeline\u2019s ID, type, and configuration attributes."
21767
+ properties:
21768
+ attributes:
21769
+ $ref: '#/components/schemas/ObservabilityPipelineDataAttributes'
21770
+ type:
21771
+ default: pipelines
21772
+ description: The resource type identifier. For pipeline resources, this
21773
+ should always be set to `pipelines`.
21774
+ example: pipelines
21775
+ type: string
21776
+ required:
21777
+ - type
21778
+ - attributes
21779
+ type: object
21780
+ ObservabilityPipelineData:
21781
+ description: "Contains the pipeline\u2019s ID, type, and configuration attributes."
21782
+ properties:
21783
+ attributes:
21784
+ $ref: '#/components/schemas/ObservabilityPipelineDataAttributes'
21785
+ id:
21786
+ description: Unique identifier for the pipeline.
21787
+ example: 3fa85f64-5717-4562-b3fc-2c963f66afa6
21788
+ type: string
21789
+ type:
21790
+ default: pipelines
21791
+ description: The resource type identifier. For pipeline resources, this
21792
+ should always be set to `pipelines`.
21793
+ example: pipelines
21794
+ type: string
21795
+ required:
21796
+ - id
21797
+ - type
21798
+ - attributes
21799
+ type: object
21800
+ ObservabilityPipelineDataAttributes:
21801
+ description: "Defines the pipeline\u2019s name and its components (sources,
21802
+ processors, and destinations)."
21803
+ properties:
21804
+ config:
21805
+ $ref: '#/components/schemas/ObservabilityPipelineConfig'
21806
+ name:
21807
+ description: Name of the pipeline.
21808
+ example: Main Observability Pipeline
21809
+ type: string
21810
+ required:
21811
+ - name
21812
+ - config
21813
+ type: object
21814
+ ObservabilityPipelineDatadogAgentSource:
21815
+ description: The `datadog_agent` source collects logs from the Datadog Agent.
21816
+ properties:
21817
+ id:
21818
+ description: The unique identifier for this component. Used to reference
21819
+ this component in other parts of the pipeline (e.g., as input to downstream
21820
+ components).
21821
+ example: datadog-agent-source
21822
+ type: string
21823
+ tls:
21824
+ $ref: '#/components/schemas/ObservabilityPipelineTls'
21825
+ type:
21826
+ $ref: '#/components/schemas/ObservabilityPipelineDatadogAgentSourceType'
21827
+ required:
21828
+ - id
21829
+ - type
21830
+ type: object
21831
+ ObservabilityPipelineDatadogAgentSourceType:
21832
+ default: datadog_agent
21833
+ description: The source type. The value should always be `datadog_agent`.
21834
+ enum:
21835
+ - datadog_agent
21836
+ example: datadog_agent
21837
+ type: string
21838
+ x-enum-varnames:
21839
+ - DATADOG_AGENT
21840
+ ObservabilityPipelineDatadogLogsDestination:
21841
+ description: The `datadog_logs` destination forwards logs to Datadog Log Management.
21842
+ properties:
21843
+ id:
21844
+ description: The unique identifier for this component.
21845
+ example: datadog-logs-destination
21846
+ type: string
21847
+ inputs:
21848
+ description: A list of component IDs whose output is used as the `input`
21849
+ for this component.
21850
+ example:
21851
+ - filter-processor
21852
+ items:
21853
+ type: string
21854
+ type: array
21855
+ type:
21856
+ $ref: '#/components/schemas/ObservabilityPipelineDatadogLogsDestinationType'
21857
+ required:
21858
+ - id
21859
+ - type
21860
+ - inputs
21861
+ type: object
21862
+ ObservabilityPipelineDatadogLogsDestinationType:
21863
+ default: datadog_logs
21864
+ description: The destination type. The value should always be `datadog_logs`.
21865
+ enum:
21866
+ - datadog_logs
21867
+ example: datadog_logs
21868
+ type: string
21869
+ x-enum-varnames:
21870
+ - DATADOG_LOGS
21871
+ ObservabilityPipelineFieldValue:
21872
+ description: Represents a static key-value pair used in various processors.
21873
+ properties:
21874
+ name:
21875
+ description: The field name.
21876
+ example: field_name
21877
+ type: string
21878
+ value:
21879
+ description: The field value.
21880
+ example: field_value
21881
+ type: string
21882
+ required:
21883
+ - name
21884
+ - value
21885
+ type: object
21886
+ ObservabilityPipelineFilterProcessor:
21887
+ description: The `filter` processor allows conditional processing of logs based
21888
+ on a Datadog search query. Logs that match the `include` query are passed
21889
+ through; others are discarded.
21890
+ properties:
21891
+ id:
21892
+ description: The unique identifier for this component. Used to reference
21893
+ this component in other parts of the pipeline (for example, as the `input`
21894
+ to downstream components).
21895
+ example: filter-processor
21896
+ type: string
21897
+ include:
21898
+ description: A Datadog search query used to determine which logs should
21899
+ pass through the filter. Logs that match this query continue to downstream
21900
+ components; others are dropped.
21901
+ example: service:my-service
21902
+ type: string
21903
+ inputs:
21904
+ description: A list of component IDs whose output is used as the `input`
21905
+ for this component.
21906
+ example:
21907
+ - datadog-agent-source
21908
+ items:
21909
+ type: string
21910
+ type: array
21911
+ type:
21912
+ $ref: '#/components/schemas/ObservabilityPipelineFilterProcessorType'
21913
+ required:
21914
+ - id
21915
+ - type
21916
+ - include
21917
+ - inputs
21918
+ type: object
21919
+ ObservabilityPipelineFilterProcessorType:
21920
+ default: filter
21921
+ description: The processor type. The value should always be `filter`.
21922
+ enum:
21923
+ - filter
21924
+ example: filter
21925
+ type: string
21926
+ x-enum-varnames:
21927
+ - FILTER
21928
+ ObservabilityPipelineKafkaSource:
21929
+ description: The `kafka` source ingests data from Apache Kafka topics.
21930
+ properties:
21931
+ group_id:
21932
+ description: Consumer group ID used by the Kafka client.
21933
+ example: consumer-group-0
21934
+ type: string
21935
+ id:
21936
+ description: The unique identifier for this component. Used to reference
21937
+ this component in other parts of the pipeline (e.g., as input to downstream
21938
+ components).
21939
+ example: kafka-source
21940
+ type: string
21941
+ librdkafka_options:
21942
+ description: Optional list of advanced Kafka client configuration options,
21943
+ defined as key-value pairs.
21944
+ items:
21945
+ $ref: '#/components/schemas/ObservabilityPipelineKafkaSourceLibrdkafkaOption'
21946
+ type: array
21947
+ sasl:
21948
+ $ref: '#/components/schemas/ObservabilityPipelineKafkaSourceSasl'
21949
+ tls:
21950
+ $ref: '#/components/schemas/ObservabilityPipelineTls'
21951
+ topics:
21952
+ description: A list of Kafka topic names to subscribe to. The source ingests
21953
+ messages from each topic specified.
21954
+ example:
21955
+ - topic1
21956
+ - topic2
21957
+ items:
21958
+ type: string
21959
+ type: array
21960
+ type:
21961
+ $ref: '#/components/schemas/ObservabilityPipelineKafkaSourceType'
21962
+ required:
21963
+ - id
21964
+ - type
21965
+ - group_id
21966
+ - topics
21967
+ type: object
21968
+ ObservabilityPipelineKafkaSourceLibrdkafkaOption:
21969
+ description: Represents a key-value pair used to configure low-level `librdkafka`
21970
+ client options for Kafka sources, such as timeouts, buffer sizes, and security
21971
+ settings.
21972
+ properties:
21973
+ name:
21974
+ description: The name of the `librdkafka` configuration option to set.
21975
+ example: fetch.message.max.bytes
21976
+ type: string
21977
+ value:
21978
+ description: The value assigned to the specified `librdkafka` configuration
21979
+ option.
21980
+ example: '1048576'
21981
+ type: string
21982
+ required:
21983
+ - name
21984
+ - value
21985
+ type: object
21986
+ ObservabilityPipelineKafkaSourceSasl:
21987
+ description: Specifies the SASL mechanism for authenticating with a Kafka cluster.
21988
+ properties:
21989
+ mechanism:
21990
+ $ref: '#/components/schemas/ObservabilityPipelinePipelineKafkaSourceSaslMechanism'
21991
+ type: object
21992
+ ObservabilityPipelineKafkaSourceType:
21993
+ default: kafka
21994
+ description: The source type. The value should always be `kafka`.
21995
+ enum:
21996
+ - kafka
21997
+ example: kafka
21998
+ type: string
21999
+ x-enum-varnames:
22000
+ - KAFKA
22001
+ ObservabilityPipelineParseJSONProcessor:
22002
+ description: The `parse_json` processor extracts JSON from a specified field
22003
+ and flattens it into the event. This is useful when logs contain embedded
22004
+ JSON as a string.
22005
+ properties:
22006
+ field:
22007
+ description: The name of the log field that contains a JSON string.
22008
+ example: message
22009
+ type: string
22010
+ id:
22011
+ description: A unique identifier for this component. Used to reference this
22012
+ component in other parts of the pipeline (e.g., as input to downstream
22013
+ components).
22014
+ example: parse-json-processor
22015
+ type: string
22016
+ include:
22017
+ description: A Datadog search query used to determine which logs this processor
22018
+ targets.
22019
+ example: service:my-service
22020
+ type: string
22021
+ inputs:
22022
+ description: A list of component IDs whose output is used as the `input`
22023
+ for this component.
22024
+ example:
22025
+ - datadog-agent-source
22026
+ items:
22027
+ type: string
22028
+ type: array
22029
+ type:
22030
+ $ref: '#/components/schemas/ObservabilityPipelineParseJSONProcessorType'
22031
+ required:
22032
+ - id
22033
+ - type
22034
+ - include
22035
+ - field
22036
+ - inputs
22037
+ type: object
22038
+ ObservabilityPipelineParseJSONProcessorType:
22039
+ default: parse_json
22040
+ description: The processor type. The value should always be `parse_json`.
22041
+ enum:
22042
+ - parse_json
22043
+ example: parse_json
22044
+ type: string
22045
+ x-enum-varnames:
22046
+ - PARSE_JSON
22047
+ ObservabilityPipelinePipelineKafkaSourceSaslMechanism:
22048
+ description: SASL mechanism used for Kafka authentication.
22049
+ enum:
22050
+ - PLAIN
22051
+ - SCRAM-SHA-256
22052
+ - SCRAM-SHA-512
22053
+ type: string
22054
+ x-enum-varnames:
22055
+ - PLAIN
22056
+ - SCRAMNOT_SHANOT_256
22057
+ - SCRAMNOT_SHANOT_512
22058
+ ObservabilityPipelineQuotaProcessor:
22059
+ description: The Quota Processor measures logging traffic for logs that match
22060
+ a specified filter. When the configured daily quota is met, the processor
22061
+ can drop or alert.
22062
+ properties:
22063
+ drop_events:
22064
+ description: If set to `true`, logs that matched the quota filter and sent
22065
+ after the quota has been met are dropped; only logs that did not match
22066
+ the filter query continue through the pipeline.
22067
+ example: false
22068
+ type: boolean
22069
+ id:
22070
+ description: The unique identifier for this component. Used to reference
22071
+ this component in other parts of the pipeline (for example, as the `input`
22072
+ to downstream components).
22073
+ example: quota-processor
22074
+ type: string
22075
+ ignore_when_missing_partitions:
22076
+ description: If `true`, the processor skips quota checks when partition
22077
+ fields are missing from the logs.
22078
+ type: boolean
22079
+ include:
22080
+ description: A Datadog search query used to determine which logs this processor
22081
+ targets.
22082
+ example: service:my-service
22083
+ type: string
22084
+ inputs:
22085
+ description: A list of component IDs whose output is used as the `input`
22086
+ for this component.
22087
+ example:
22088
+ - datadog-agent-source
22089
+ items:
22090
+ type: string
22091
+ type: array
22092
+ limit:
22093
+ $ref: '#/components/schemas/ObservabilityPipelineQuotaProcessorLimit'
22094
+ name:
22095
+ description: Name for identifying the processor.
22096
+ example: MyPipelineQuotaProcessor
22097
+ type: string
22098
+ overrides:
22099
+ description: A list of alternate quota rules that apply to specific sets
22100
+ of events, identified by matching field values. Each override can define
22101
+ a custom limit.
22102
+ items:
22103
+ $ref: '#/components/schemas/ObservabilityPipelineQuotaProcessorOverride'
22104
+ type: array
22105
+ partition_fields:
22106
+ description: A list of fields used to segment log traffic for quota enforcement.
22107
+ Quotas are tracked independently by unique combinations of these field
22108
+ values.
22109
+ items:
22110
+ type: string
22111
+ type: array
22112
+ type:
22113
+ $ref: '#/components/schemas/ObservabilityPipelineQuotaProcessorType'
22114
+ required:
22115
+ - id
22116
+ - type
22117
+ - include
22118
+ - name
22119
+ - drop_events
22120
+ - limit
22121
+ - inputs
22122
+ type: object
22123
+ ObservabilityPipelineQuotaProcessorLimit:
22124
+ description: The maximum amount of data or number of events allowed before the
22125
+ quota is enforced. Can be specified in bytes or events.
22126
+ properties:
22127
+ enforce:
22128
+ $ref: '#/components/schemas/ObservabilityPipelineQuotaProcessorLimitEnforceType'
22129
+ limit:
22130
+ description: The limit for quota enforcement.
22131
+ example: 1000
22132
+ format: int64
22133
+ type: integer
22134
+ required:
22135
+ - enforce
22136
+ - limit
22137
+ type: object
22138
+ ObservabilityPipelineQuotaProcessorLimitEnforceType:
22139
+ description: Unit for quota enforcement in bytes for data size or events for
22140
+ count.
22141
+ enum:
22142
+ - bytes
22143
+ - events
22144
+ example: bytes
22145
+ type: string
22146
+ x-enum-varnames:
22147
+ - BYTES
22148
+ - EVENTS
22149
+ ObservabilityPipelineQuotaProcessorOverride:
22150
+ description: Defines a custom quota limit that applies to specific log events
22151
+ based on matching field values.
22152
+ properties:
22153
+ fields:
22154
+ description: A list of field matchers used to apply a specific override.
22155
+ If an event matches all listed key-value pairs, the corresponding override
22156
+ limit is enforced.
22157
+ items:
22158
+ $ref: '#/components/schemas/ObservabilityPipelineFieldValue'
22159
+ type: array
22160
+ limit:
22161
+ $ref: '#/components/schemas/ObservabilityPipelineQuotaProcessorLimit'
22162
+ required:
22163
+ - fields
22164
+ - limit
22165
+ type: object
22166
+ ObservabilityPipelineQuotaProcessorType:
22167
+ default: quota
22168
+ description: The processor type. The value should always be `quota`.
22169
+ enum:
22170
+ - quota
22171
+ example: quota
22172
+ type: string
22173
+ x-enum-varnames:
22174
+ - QUOTA
22175
+ ObservabilityPipelineRemoveFieldsProcessor:
22176
+ description: The `remove_fields` processor deletes specified fields from logs.
22177
+ properties:
22178
+ fields:
22179
+ description: A list of field names to be removed from each log event.
22180
+ example:
22181
+ - field1
22182
+ - field2
22183
+ items:
22184
+ type: string
22185
+ type: array
22186
+ id:
22187
+ description: The unique identifier for this component. Used to reference
22188
+ this component in other parts of the pipeline (e.g., as input to downstream
22189
+ components).
22190
+ example: remove-fields-processor
22191
+ type: string
22192
+ include:
22193
+ description: A Datadog search query used to determine which logs this processor
22194
+ targets.
22195
+ example: service:my-service
22196
+ type: string
22197
+ inputs:
22198
+ description: The `PipelineRemoveFieldsProcessor` `inputs`.
22199
+ example:
22200
+ - datadog-agent-source
22201
+ items:
22202
+ type: string
22203
+ type: array
22204
+ type:
22205
+ $ref: '#/components/schemas/ObservabilityPipelineRemoveFieldsProcessorType'
22206
+ required:
22207
+ - id
22208
+ - type
22209
+ - include
22210
+ - fields
22211
+ - inputs
22212
+ type: object
22213
+ ObservabilityPipelineRemoveFieldsProcessorType:
22214
+ default: remove_fields
22215
+ description: The processor type. The value should always be `remove_fields`.
22216
+ enum:
22217
+ - remove_fields
22218
+ example: remove_fields
22219
+ type: string
22220
+ x-enum-varnames:
22221
+ - REMOVE_FIELDS
22222
+ ObservabilityPipelineRenameFieldsProcessor:
22223
+ description: The `rename_fields` processor changes field names.
22224
+ properties:
22225
+ fields:
22226
+ description: A list of rename rules specifying which fields to rename in
22227
+ the event, what to rename them to, and whether to preserve the original
22228
+ fields.
22229
+ items:
22230
+ $ref: '#/components/schemas/ObservabilityPipelineRenameFieldsProcessorField'
22231
+ type: array
22232
+ id:
22233
+ description: A unique identifier for this component. Used to reference this
22234
+ component in other parts of the pipeline (e.g., as input to downstream
22235
+ components).
22236
+ example: rename-fields-processor
22237
+ type: string
22238
+ include:
22239
+ description: A Datadog search query used to determine which logs this processor
22240
+ targets.
22241
+ example: service:my-service
22242
+ type: string
22243
+ inputs:
22244
+ description: A list of component IDs whose output is used as the `input`
22245
+ for this component.
22246
+ example:
22247
+ - datadog-agent-source
22248
+ items:
22249
+ type: string
22250
+ type: array
22251
+ type:
22252
+ $ref: '#/components/schemas/ObservabilityPipelineRenameFieldsProcessorType'
22253
+ required:
22254
+ - id
22255
+ - type
22256
+ - include
22257
+ - fields
22258
+ - inputs
22259
+ type: object
22260
+ ObservabilityPipelineRenameFieldsProcessorField:
22261
+ description: Defines how to rename a field in log events.
22262
+ properties:
22263
+ destination:
22264
+ description: The field name to assign the renamed value to.
22265
+ example: destination_field
22266
+ type: string
22267
+ preserve_source:
22268
+ description: Indicates whether the original field, that is received from
22269
+ the source, should be kept (`true`) or removed (`false`) after renaming.
22270
+ example: false
22271
+ type: boolean
22272
+ source:
22273
+ description: The original field name in the log event that should be renamed.
22274
+ example: source_field
22275
+ type: string
22276
+ required:
22277
+ - source
22278
+ - destination
22279
+ - preserve_source
22280
+ type: object
22281
+ ObservabilityPipelineRenameFieldsProcessorType:
22282
+ default: rename_fields
22283
+ description: The processor type. The value should always be `rename_fields`.
22284
+ enum:
22285
+ - rename_fields
22286
+ example: rename_fields
22287
+ type: string
22288
+ x-enum-varnames:
22289
+ - RENAME_FIELDS
22290
+ ObservabilityPipelineTls:
22291
+ description: Configuration for enabling TLS encryption.
22292
+ properties:
22293
+ ca_file:
22294
+ description: "Path to the Certificate Authority (CA) file used to validate
22295
+ the server\u2019s TLS certificate."
22296
+ type: string
22297
+ crt_file:
22298
+ description: Path to the TLS client certificate file used to authenticate
22299
+ the pipeline component with upstream or downstream services.
22300
+ example: /path/to/cert.crt
22301
+ type: string
22302
+ key_file:
22303
+ description: Path to the private key file associated with the TLS client
22304
+ certificate. Used for mutual TLS authentication.
22305
+ type: string
22306
+ required:
22307
+ - crt_file
22308
+ type: object
21412
22309
  OktaAccount:
21413
22310
  description: Schema for an Okta account.
21414
22311
  properties:
@@ -24501,9 +25398,17 @@ components:
24501
25398
  type: string
24502
25399
  rate:
24503
25400
  description: 'Sample rate to apply to spans going through this retention
24504
- filter,
25401
+ filter.
25402
+
25403
+ A value of 1.0 keeps all spans matching the query.'
25404
+ example: 1.0
25405
+ format: double
25406
+ type: number
25407
+ trace_rate:
25408
+ description: 'Sample rate to apply to traces containing spans going through
25409
+ this retention filter.
24505
25410
 
24506
- a value of 1.0 keeps all spans matching the query.'
25411
+ A value of 1.0 keeps all traces with spans matching the query.'
24507
25412
  example: 1.0
24508
25413
  format: double
24509
25414
  type: number
@@ -24560,9 +25465,17 @@ components:
24560
25465
  type: string
24561
25466
  rate:
24562
25467
  description: 'Sample rate to apply to spans going through this retention
24563
- filter,
25468
+ filter.
24564
25469
 
24565
- a value of 1.0 keeps all spans matching the query.'
25470
+ A value of 1.0 keeps all spans matching the query.'
25471
+ example: 1.0
25472
+ format: double
25473
+ type: number
25474
+ trace_rate:
25475
+ description: 'Sample rate to apply to traces containing spans going through
25476
+ this retention filter.
25477
+
25478
+ A value of 1.0 keeps all traces with spans matching the query.'
24566
25479
  example: 1.0
24567
25480
  format: double
24568
25481
  type: number
@@ -24585,9 +25498,17 @@ components:
24585
25498
  type: string
24586
25499
  rate:
24587
25500
  description: 'Sample rate to apply to spans going through this retention
24588
- filter,
25501
+ filter.
25502
+
25503
+ A value of 1.0 keeps all spans matching the query.'
25504
+ example: 1.0
25505
+ format: double
25506
+ type: number
25507
+ trace_rate:
25508
+ description: 'Sample rate to apply to traces containing spans going through
25509
+ this retention filter.
24589
25510
 
24590
- a value of 1.0 keeps all spans matching the query.'
25511
+ A value of 1.0 keeps all traces with spans matching the query.'
24591
25512
  example: 1.0
24592
25513
  format: double
24593
25514
  type: number
@@ -24656,9 +25577,17 @@ components:
24656
25577
  type: string
24657
25578
  rate:
24658
25579
  description: 'Sample rate to apply to spans going through this retention
24659
- filter,
25580
+ filter.
25581
+
25582
+ A value of 1.0 keeps all spans matching the query.'
25583
+ example: 1.0
25584
+ format: double
25585
+ type: number
25586
+ trace_rate:
25587
+ description: 'Sample rate to apply to traces containing spans going through
25588
+ this retention filter.
24660
25589
 
24661
- a value of 1.0 keeps all spans matching the query.'
25590
+ A value of 1.0 keeps all traces with spans matching the query.'
24662
25591
  example: 1.0
24663
25592
  format: double
24664
25593
  type: number
@@ -25518,8 +26447,6 @@ components:
25518
26447
  properties:
25519
26448
  attributes:
25520
26449
  $ref: '#/components/schemas/RumRetentionFilterCreateAttributes'
25521
- meta:
25522
- $ref: '#/components/schemas/RumRetentionFilterMeta'
25523
26450
  type:
25524
26451
  $ref: '#/components/schemas/RumRetentionFilterType'
25525
26452
  required:
@@ -25541,8 +26468,6 @@ components:
25541
26468
  $ref: '#/components/schemas/RumRetentionFilterAttributes'
25542
26469
  id:
25543
26470
  $ref: '#/components/schemas/RumRetentionFilterID'
25544
- meta:
25545
- $ref: '#/components/schemas/RumRetentionFilterMeta'
25546
26471
  type:
25547
26472
  $ref: '#/components/schemas/RumRetentionFilterType'
25548
26473
  type: object
@@ -25574,12 +26499,6 @@ components:
25574
26499
  description: ID of retention filter in UUID.
25575
26500
  example: 051601eb-54a0-abc0-03f9-cc02efa18892
25576
26501
  type: string
25577
- RumRetentionFilterMeta:
25578
- description: The object describing metadata of a RUM retention filter.
25579
- properties:
25580
- source:
25581
- $ref: '#/components/schemas/RumRetentionFilterSource'
25582
- type: object
25583
26502
  RumRetentionFilterQuery:
25584
26503
  description: The query string for a RUM retention filter.
25585
26504
  example: '@session.has_replay:true'
@@ -25597,20 +26516,6 @@ components:
25597
26516
  maximum: 100
25598
26517
  minimum: 0
25599
26518
  type: integer
25600
- RumRetentionFilterSource:
25601
- description: The type of RUM events to filter on.
25602
- enum:
25603
- - ui
25604
- - terraform
25605
- - default
25606
- - unknown
25607
- example: terraform
25608
- type: string
25609
- x-enum-varnames:
25610
- - UI
25611
- - TERRAFORM
25612
- - DEFAULT
25613
- - UNKNOWN
25614
26519
  RumRetentionFilterType:
25615
26520
  default: retention_filters
25616
26521
  description: The type of the resource. The value should always be retention_filters.
@@ -25641,8 +26546,6 @@ components:
25641
26546
  $ref: '#/components/schemas/RumRetentionFilterUpdateAttributes'
25642
26547
  id:
25643
26548
  $ref: '#/components/schemas/RumRetentionFilterID'
25644
- meta:
25645
- $ref: '#/components/schemas/RumRetentionFilterMeta'
25646
26549
  type:
25647
26550
  $ref: '#/components/schemas/RumRetentionFilterType'
25648
26551
  required:
@@ -25673,7 +26576,8 @@ components:
25673
26576
  description: 'The list of RUM retention filter IDs along with their corresponding
25674
26577
  type to reorder.
25675
26578
 
25676
- All retention filter IDs should be included in the list created for an application.'
26579
+ All retention filter IDs should be included in the list created for a RUM
26580
+ application.'
25677
26581
  properties:
25678
26582
  data:
25679
26583
  description: A list of RUM retention filter IDs along with type.
@@ -25691,7 +26595,7 @@ components:
25691
26595
  type: array
25692
26596
  type: object
25693
26597
  RumRetentionFiltersResponse:
25694
- description: All RUM retention filters for an application.
26598
+ description: All RUM retention filters for a RUM application.
25695
26599
  properties:
25696
26600
  data:
25697
26601
  description: A list of RUM retention filters.
@@ -26131,8 +27035,502 @@ components:
26131
27035
  type:
26132
27036
  $ref: '#/components/schemas/ScalarFormulaResponseType'
26133
27037
  type: object
27038
+ Schedule:
27039
+ description: Top-level container for a schedule object, including both the `data`
27040
+ payload and any related `included` resources (such as teams, layers, or members).
27041
+ example:
27042
+ data:
27043
+ attributes:
27044
+ name: On-Call Schedule
27045
+ tags:
27046
+ - tag1
27047
+ - tag2
27048
+ time_zone: America/New_York
27049
+ id: 3653d3c6-0c75-11ea-ad28-fb5701eabc7d
27050
+ relationships:
27051
+ layers:
27052
+ data:
27053
+ - id: 00000000-0000-0000-0000-000000000001
27054
+ type: layers
27055
+ teams:
27056
+ data:
27057
+ - id: 00000000-da3a-0000-0000-000000000000
27058
+ type: teams
27059
+ type: schedules
27060
+ included:
27061
+ - attributes:
27062
+ avatar: ''
27063
+ description: Team 1 description
27064
+ handle: team1
27065
+ name: Team 1
27066
+ id: 00000000-da3a-0000-0000-000000000000
27067
+ type: teams
27068
+ - attributes:
27069
+ effective_date: '2025-02-03T05:00:00Z'
27070
+ end_date: '2025-12-31T00:00:00Z'
27071
+ interval:
27072
+ days: 1
27073
+ name: Layer 1
27074
+ restrictions:
27075
+ - end_day: friday
27076
+ end_time: '17:00:00'
27077
+ start_day: monday
27078
+ start_time: 09:00:00
27079
+ rotation_start: '2025-02-01T00:00:00Z'
27080
+ id: 00000000-0000-0000-0000-000000000001
27081
+ relationships:
27082
+ members:
27083
+ data:
27084
+ - id: 00000000-0000-0000-0000-000000000002
27085
+ type: members
27086
+ type: layers
27087
+ - id: 00000000-0000-0000-0000-000000000002
27088
+ relationships:
27089
+ user:
27090
+ data:
27091
+ id: 00000000-aba1-0000-0000-000000000000
27092
+ type: users
27093
+ type: members
27094
+ - attributes:
27095
+ email: foo@bar.com
27096
+ name: User 1
27097
+ id: 00000000-aba1-0000-0000-000000000000
27098
+ type: users
27099
+ properties:
27100
+ data:
27101
+ $ref: '#/components/schemas/ScheduleData'
27102
+ included:
27103
+ description: Any additional resources related to this schedule, such as
27104
+ teams and layers.
27105
+ items:
27106
+ $ref: '#/components/schemas/ScheduleDataIncludedItem'
27107
+ type: array
27108
+ type: object
27109
+ ScheduleCreateRequest:
27110
+ description: The top-level request body for schedule creation, wrapping a `data`
27111
+ object.
27112
+ example:
27113
+ data:
27114
+ attributes:
27115
+ layers:
27116
+ - effective_date: '2025-02-03T05:00:00Z'
27117
+ end_date: '2025-12-31T00:00:00Z'
27118
+ interval:
27119
+ days: 1
27120
+ members:
27121
+ - user:
27122
+ id: 00000000-aba1-0000-0000-000000000000
27123
+ name: Layer 1
27124
+ restrictions:
27125
+ - end_day: friday
27126
+ end_time: '17:00:00'
27127
+ start_day: monday
27128
+ start_time: 09:00:00
27129
+ rotation_start: '2025-02-01T00:00:00Z'
27130
+ name: On-Call Schedule
27131
+ tags:
27132
+ - tag1
27133
+ - tag2
27134
+ time_zone: America/New_York
27135
+ relationships:
27136
+ teams:
27137
+ data:
27138
+ - id: 00000000-da3a-0000-0000-000000000000
27139
+ type: teams
27140
+ type: schedules
27141
+ properties:
27142
+ data:
27143
+ $ref: '#/components/schemas/ScheduleCreateRequestData'
27144
+ required:
27145
+ - data
27146
+ type: object
27147
+ ScheduleCreateRequestData:
27148
+ description: The core data wrapper for creating a schedule, encompassing attributes,
27149
+ relationships, and the resource type.
27150
+ properties:
27151
+ attributes:
27152
+ $ref: '#/components/schemas/ScheduleCreateRequestDataAttributes'
27153
+ relationships:
27154
+ $ref: '#/components/schemas/ScheduleCreateRequestDataRelationships'
27155
+ type:
27156
+ $ref: '#/components/schemas/ScheduleCreateRequestDataType'
27157
+ required:
27158
+ - attributes
27159
+ - type
27160
+ type: object
27161
+ ScheduleCreateRequestDataAttributes:
27162
+ description: Describes the main attributes for creating a new schedule, including
27163
+ name, layers, time zone, and tags.
27164
+ properties:
27165
+ layers:
27166
+ description: The layers of on-call coverage that define rotation intervals
27167
+ and restrictions.
27168
+ items:
27169
+ $ref: '#/components/schemas/ScheduleCreateRequestDataAttributesLayersItems'
27170
+ type: array
27171
+ name:
27172
+ description: A human-readable name for the new schedule.
27173
+ example: Team A On-Call
27174
+ type: string
27175
+ tags:
27176
+ description: A list of tags for categorizing or filtering the schedule.
27177
+ items:
27178
+ type: string
27179
+ type: array
27180
+ time_zone:
27181
+ description: The time zone in which the schedule is defined.
27182
+ example: America/New_York
27183
+ type: string
27184
+ required:
27185
+ - name
27186
+ - time_zone
27187
+ - layers
27188
+ type: object
27189
+ ScheduleCreateRequestDataAttributesLayersItems:
27190
+ description: Describes a schedule layer, including rotation intervals, members,
27191
+ restrictions, and timeline settings.
27192
+ properties:
27193
+ effective_date:
27194
+ description: The date/time when this layer becomes active (in ISO 8601).
27195
+ example: '2025-01-01T00:00:00Z'
27196
+ format: date-time
27197
+ type: string
27198
+ end_date:
27199
+ description: The date/time after which this layer no longer applies (in
27200
+ ISO 8601).
27201
+ format: date-time
27202
+ type: string
27203
+ interval:
27204
+ $ref: '#/components/schemas/ScheduleCreateRequestDataAttributesLayersItemsInterval'
27205
+ members:
27206
+ description: A list of members who participate in this layer's rotation.
27207
+ items:
27208
+ $ref: '#/components/schemas/ScheduleCreateRequestDataAttributesLayersItemsMembersItems'
27209
+ type: array
27210
+ name:
27211
+ description: The name of this layer.
27212
+ example: Primary On-Call Layer
27213
+ type: string
27214
+ restrictions:
27215
+ description: Zero or more time-based restrictions (for example, only weekdays,
27216
+ during business hours).
27217
+ items:
27218
+ $ref: '#/components/schemas/ScheduleCreateRequestDataAttributesLayersItemsRestrictionsItems'
27219
+ type: array
27220
+ rotation_start:
27221
+ description: The date/time when the rotation for this layer starts (in ISO
27222
+ 8601).
27223
+ example: '2025-01-01T00:00:00Z'
27224
+ format: date-time
27225
+ type: string
27226
+ required:
27227
+ - name
27228
+ - interval
27229
+ - rotation_start
27230
+ - effective_date
27231
+ - members
27232
+ type: object
27233
+ ScheduleCreateRequestDataAttributesLayersItemsInterval:
27234
+ description: Defines how frequently the rotation repeats, using days and/or
27235
+ seconds (up to certain limits).
27236
+ properties:
27237
+ days:
27238
+ description: The number of full days in each rotation period.
27239
+ format: int32
27240
+ maximum: 400
27241
+ type: integer
27242
+ seconds:
27243
+ description: Extra seconds that may be added to extend the rotation beyond
27244
+ whole days.
27245
+ format: int64
27246
+ maximum: 2592000
27247
+ type: integer
27248
+ type: object
27249
+ ScheduleCreateRequestDataAttributesLayersItemsMembersItems:
27250
+ description: Defines a single member within a schedule layer, including the
27251
+ reference to the underlying user.
27252
+ properties:
27253
+ user:
27254
+ $ref: '#/components/schemas/ScheduleCreateRequestDataAttributesLayersItemsMembersItemsUser'
27255
+ type: object
27256
+ ScheduleCreateRequestDataAttributesLayersItemsMembersItemsUser:
27257
+ description: Identifies the user participating in this layer as a single object
27258
+ with an `id`.
27259
+ properties:
27260
+ id:
27261
+ description: The user's ID.
27262
+ type: string
27263
+ type: object
27264
+ ScheduleCreateRequestDataAttributesLayersItemsRestrictionsItems:
27265
+ description: 'Defines a time restriction for a schedule layer, including which
27266
+ day of the week
27267
+
27268
+ it starts and ends, along with start/end times.'
27269
+ properties:
27270
+ end_day:
27271
+ $ref: '#/components/schemas/ScheduleCreateRequestDataAttributesLayersItemsRestrictionsItemsEndDay'
27272
+ end_time:
27273
+ description: The time of day when the restriction ends (hh:mm:ss).
27274
+ type: string
27275
+ start_day:
27276
+ $ref: '#/components/schemas/ScheduleCreateRequestDataAttributesLayersItemsRestrictionsItemsStartDay'
27277
+ start_time:
27278
+ description: The time of day when the restriction begins (hh:mm:ss).
27279
+ type: string
27280
+ type: object
27281
+ ScheduleCreateRequestDataAttributesLayersItemsRestrictionsItemsEndDay:
27282
+ description: The weekday when the restriction period ends (Monday through Sunday).
27283
+ enum:
27284
+ - monday
27285
+ - tuesday
27286
+ - wednesday
27287
+ - thursday
27288
+ - friday
27289
+ - saturday
27290
+ - sunday
27291
+ type: string
27292
+ x-enum-varnames:
27293
+ - MONDAY
27294
+ - TUESDAY
27295
+ - WEDNESDAY
27296
+ - THURSDAY
27297
+ - FRIDAY
27298
+ - SATURDAY
27299
+ - SUNDAY
27300
+ ScheduleCreateRequestDataAttributesLayersItemsRestrictionsItemsStartDay:
27301
+ description: The weekday when the restriction period starts (Monday through
27302
+ Sunday).
27303
+ enum:
27304
+ - monday
27305
+ - tuesday
27306
+ - wednesday
27307
+ - thursday
27308
+ - friday
27309
+ - saturday
27310
+ - sunday
27311
+ type: string
27312
+ x-enum-varnames:
27313
+ - MONDAY
27314
+ - TUESDAY
27315
+ - WEDNESDAY
27316
+ - THURSDAY
27317
+ - FRIDAY
27318
+ - SATURDAY
27319
+ - SUNDAY
27320
+ ScheduleCreateRequestDataRelationships:
27321
+ description: Gathers relationship objects for the schedule creation request,
27322
+ including the teams to associate.
27323
+ properties:
27324
+ teams:
27325
+ $ref: '#/components/schemas/ScheduleCreateRequestDataRelationshipsTeams'
27326
+ type: object
27327
+ ScheduleCreateRequestDataRelationshipsTeams:
27328
+ description: Associates the new schedule with one or more teams.
27329
+ properties:
27330
+ data:
27331
+ description: An array of team references for this schedule.
27332
+ items:
27333
+ $ref: '#/components/schemas/ScheduleCreateRequestDataRelationshipsTeamsDataItems'
27334
+ type: array
27335
+ type: object
27336
+ ScheduleCreateRequestDataRelationshipsTeamsDataItems:
27337
+ description: 'Holds the relationship data linking this schedule to a particular
27338
+ team,
27339
+
27340
+ identified by `id` and `type`.'
27341
+ properties:
27342
+ id:
27343
+ description: A unique identifier for the team.
27344
+ type: string
27345
+ type:
27346
+ $ref: '#/components/schemas/ScheduleCreateRequestDataRelationshipsTeamsDataItemsType'
27347
+ type: object
27348
+ ScheduleCreateRequestDataRelationshipsTeamsDataItemsType:
27349
+ default: teams
27350
+ description: Teams resource type.
27351
+ enum:
27352
+ - teams
27353
+ type: string
27354
+ x-enum-varnames:
27355
+ - TEAMS
27356
+ ScheduleCreateRequestDataType:
27357
+ default: schedules
27358
+ description: Schedules resource type.
27359
+ enum:
27360
+ - schedules
27361
+ example: schedules
27362
+ type: string
27363
+ x-enum-varnames:
27364
+ - SCHEDULES
27365
+ ScheduleData:
27366
+ description: Represents the primary data object for a schedule, linking attributes
27367
+ and relationships.
27368
+ properties:
27369
+ attributes:
27370
+ $ref: '#/components/schemas/ScheduleDataAttributes'
27371
+ id:
27372
+ description: The schedule's unique identifier.
27373
+ example: 3653d3c6-0c75-11ea-ad28-fb5701eabc7d
27374
+ type: string
27375
+ relationships:
27376
+ $ref: '#/components/schemas/ScheduleDataRelationships'
27377
+ type:
27378
+ $ref: '#/components/schemas/ScheduleDataType'
27379
+ type: object
27380
+ ScheduleDataAttributes:
27381
+ description: Provides core properties of a schedule object, such as its name,
27382
+ time zone, and tags.
27383
+ properties:
27384
+ name:
27385
+ description: A short name for the schedule.
27386
+ example: Primary On-Call
27387
+ type: string
27388
+ tags:
27389
+ description: A list of tags associated with this schedule.
27390
+ items:
27391
+ type: string
27392
+ type: array
27393
+ time_zone:
27394
+ description: The time zone in which this schedule operates.
27395
+ example: America/New_York
27396
+ type: string
27397
+ type: object
27398
+ ScheduleDataIncludedItem:
27399
+ description: Any additional resources related to this schedule, such as teams
27400
+ and layers.
27401
+ oneOf:
27402
+ - $ref: '#/components/schemas/TeamReference'
27403
+ - $ref: '#/components/schemas/Layer'
27404
+ - $ref: '#/components/schemas/ScheduleMember'
27405
+ - $ref: '#/components/schemas/ScheduleUser'
27406
+ ScheduleDataRelationships:
27407
+ description: Groups the relationships for a schedule object, referencing layers
27408
+ and teams.
27409
+ properties:
27410
+ layers:
27411
+ $ref: '#/components/schemas/ScheduleDataRelationshipsLayers'
27412
+ teams:
27413
+ $ref: '#/components/schemas/ScheduleDataRelationshipsTeams'
27414
+ type: object
27415
+ ScheduleDataRelationshipsLayers:
27416
+ description: Associates layers with this schedule in a data structure.
27417
+ properties:
27418
+ data:
27419
+ description: An array of layer references for this schedule.
27420
+ items:
27421
+ $ref: '#/components/schemas/ScheduleDataRelationshipsLayersDataItems'
27422
+ type: array
27423
+ type: object
27424
+ ScheduleDataRelationshipsLayersDataItems:
27425
+ description: Relates a layer to this schedule, identified by `id` and `type`
27426
+ (must be `layers`).
27427
+ properties:
27428
+ id:
27429
+ description: The unique identifier of the layer in this relationship.
27430
+ example: 67963b57-d67c-dfa7-b180-62ee9301d2f5
27431
+ type: string
27432
+ type:
27433
+ $ref: '#/components/schemas/ScheduleDataRelationshipsLayersDataItemsType'
27434
+ type: object
27435
+ ScheduleDataRelationshipsLayersDataItemsType:
27436
+ default: layers
27437
+ description: Layers resource type.
27438
+ enum:
27439
+ - layers
27440
+ example: layers
27441
+ type: string
27442
+ x-enum-varnames:
27443
+ - LAYERS
27444
+ ScheduleDataRelationshipsTeams:
27445
+ description: Associates teams with this schedule in a data structure.
27446
+ properties:
27447
+ data:
27448
+ description: An array of team references for this schedule.
27449
+ items:
27450
+ $ref: '#/components/schemas/ScheduleDataRelationshipsTeamsDataItems'
27451
+ type: array
27452
+ type: object
27453
+ ScheduleDataRelationshipsTeamsDataItems:
27454
+ description: Relates a team to this schedule, identified by `id` and `type`
27455
+ (must be `teams`).
27456
+ properties:
27457
+ id:
27458
+ description: The unique identifier of the team in this relationship.
27459
+ example: 00000000-da3a-0000-0000-000000000000
27460
+ type: string
27461
+ type:
27462
+ $ref: '#/components/schemas/ScheduleDataRelationshipsTeamsDataItemsType'
27463
+ type: object
27464
+ ScheduleDataRelationshipsTeamsDataItemsType:
27465
+ default: teams
27466
+ description: Teams resource type.
27467
+ enum:
27468
+ - teams
27469
+ example: teams
27470
+ type: string
27471
+ x-enum-varnames:
27472
+ - TEAMS
27473
+ ScheduleDataType:
27474
+ default: schedules
27475
+ description: Schedules resource type.
27476
+ enum:
27477
+ - schedules
27478
+ type: string
27479
+ x-enum-varnames:
27480
+ - SCHEDULES
27481
+ ScheduleMember:
27482
+ description: Represents a single member entry in a schedule, referencing a specific
27483
+ user.
27484
+ properties:
27485
+ id:
27486
+ description: The unique identifier for this schedule member.
27487
+ type: string
27488
+ relationships:
27489
+ $ref: '#/components/schemas/ScheduleMemberRelationships'
27490
+ type:
27491
+ $ref: '#/components/schemas/ScheduleMemberType'
27492
+ type: object
27493
+ ScheduleMemberRelationships:
27494
+ description: Defines relationships for a schedule member, primarily referencing
27495
+ a single user.
27496
+ properties:
27497
+ user:
27498
+ $ref: '#/components/schemas/ScheduleMemberRelationshipsUser'
27499
+ type: object
27500
+ ScheduleMemberRelationshipsUser:
27501
+ description: Wraps the user data reference for a schedule member.
27502
+ properties:
27503
+ data:
27504
+ $ref: '#/components/schemas/ScheduleMemberRelationshipsUserData'
27505
+ type: object
27506
+ ScheduleMemberRelationshipsUserData:
27507
+ description: Points to the user data associated with this schedule member, including
27508
+ an ID and type.
27509
+ properties:
27510
+ id:
27511
+ description: The user's unique identifier.
27512
+ type: string
27513
+ type:
27514
+ $ref: '#/components/schemas/ScheduleMemberRelationshipsUserDataType'
27515
+ type: object
27516
+ ScheduleMemberRelationshipsUserDataType:
27517
+ default: users
27518
+ description: Users resource type.
27519
+ enum:
27520
+ - users
27521
+ type: string
27522
+ x-enum-varnames:
27523
+ - USERS
27524
+ ScheduleMemberType:
27525
+ default: members
27526
+ description: Schedule Members resource type.
27527
+ enum:
27528
+ - members
27529
+ type: string
27530
+ x-enum-varnames:
27531
+ - MEMBERS
26134
27532
  ScheduleTrigger:
26135
- description: Trigger a workflow VIA a Schedule. The workflow must be published.
27533
+ description: Trigger a workflow from a Schedule. The workflow must be published.
26136
27534
  properties:
26137
27535
  rruleExpression:
26138
27536
  description: Recurrence rule expression for scheduling.
@@ -26151,6 +27549,296 @@ components:
26151
27549
  required:
26152
27550
  - scheduleTrigger
26153
27551
  type: object
27552
+ ScheduleUpdateRequest:
27553
+ description: A top-level wrapper for a schedule update request, referring to
27554
+ the `data` object with the new details.
27555
+ example:
27556
+ data:
27557
+ attributes:
27558
+ layers:
27559
+ - effective_date: '2025-02-03T05:00:00Z'
27560
+ end_date: '2025-12-31T00:00:00Z'
27561
+ interval:
27562
+ seconds: 300
27563
+ members:
27564
+ - user:
27565
+ id: 00000000-aba1-0000-0000-000000000000
27566
+ name: Layer 1
27567
+ restrictions:
27568
+ - end_day: friday
27569
+ end_time: '17:00:00'
27570
+ start_day: monday
27571
+ start_time: 09:00:00
27572
+ rotation_start: '2025-02-01T00:00:00Z'
27573
+ name: On-Call Schedule Updated
27574
+ tags:
27575
+ - tag1
27576
+ - tag2
27577
+ - tag3
27578
+ time_zone: America/New_York
27579
+ id: 3653d3c6-0c75-11ea-ad28-fb5701eabc7d
27580
+ relationships:
27581
+ teams:
27582
+ data:
27583
+ - id: 00000000-da3a-0000-0000-000000000000
27584
+ type: teams
27585
+ type: schedules
27586
+ properties:
27587
+ data:
27588
+ $ref: '#/components/schemas/ScheduleUpdateRequestData'
27589
+ required:
27590
+ - data
27591
+ type: object
27592
+ ScheduleUpdateRequestData:
27593
+ description: Contains all data needed to update an existing schedule, including
27594
+ its attributes (such as name, layers, or tags) and any relationships to teams.
27595
+ properties:
27596
+ attributes:
27597
+ $ref: '#/components/schemas/ScheduleUpdateRequestDataAttributes'
27598
+ id:
27599
+ description: The ID of the schedule to be updated.
27600
+ example: 3653d3c6-0c75-11ea-ad28-fb5701eabc7d
27601
+ type: string
27602
+ relationships:
27603
+ $ref: '#/components/schemas/ScheduleUpdateRequestDataRelationships'
27604
+ type:
27605
+ $ref: '#/components/schemas/ScheduleUpdateRequestDataType'
27606
+ required:
27607
+ - attributes
27608
+ - type
27609
+ - id
27610
+ type: object
27611
+ ScheduleUpdateRequestDataAttributes:
27612
+ description: Defines the updatable attributes for a schedule, such as name,
27613
+ time zone, tags, and layers.
27614
+ properties:
27615
+ layers:
27616
+ description: The updated list of layers (rotations) for this schedule.
27617
+ items:
27618
+ $ref: '#/components/schemas/ScheduleUpdateRequestDataAttributesLayersItems'
27619
+ type: array
27620
+ name:
27621
+ description: A short name for the schedule.
27622
+ example: Primary On-Call
27623
+ type: string
27624
+ tags:
27625
+ description: A list of tags that you can associate with this schedule.
27626
+ example:
27627
+ - front-end
27628
+ - team-a
27629
+ items:
27630
+ type: string
27631
+ type: array
27632
+ time_zone:
27633
+ description: The time zone used when interpreting rotation times.
27634
+ example: America/New_York
27635
+ type: string
27636
+ required:
27637
+ - name
27638
+ - time_zone
27639
+ - layers
27640
+ type: object
27641
+ ScheduleUpdateRequestDataAttributesLayersItems:
27642
+ description: 'Represents a layer within a schedule update, including rotation
27643
+ details, members,
27644
+
27645
+ and optional restrictions.'
27646
+ properties:
27647
+ effective_date:
27648
+ description: When this updated layer takes effect (ISO 8601 format).
27649
+ format: date-time
27650
+ type: string
27651
+ end_date:
27652
+ description: When this updated layer should stop being active (ISO 8601
27653
+ format).
27654
+ format: date-time
27655
+ type: string
27656
+ id:
27657
+ description: A unique identifier for the layer being updated.
27658
+ type: string
27659
+ interval:
27660
+ $ref: '#/components/schemas/ScheduleUpdateRequestDataAttributesLayersItemsInterval'
27661
+ members:
27662
+ description: The members assigned to this layer.
27663
+ items:
27664
+ $ref: '#/components/schemas/ScheduleUpdateRequestDataAttributesLayersItemsMembersItems'
27665
+ type: array
27666
+ name:
27667
+ description: "The name for this layer (for example, \u201CSecondary Coverage\u201D)."
27668
+ type: string
27669
+ restrictions:
27670
+ description: Any time restrictions that define when this layer is active.
27671
+ items:
27672
+ $ref: '#/components/schemas/ScheduleUpdateRequestDataAttributesLayersItemsRestrictionsItems'
27673
+ type: array
27674
+ rotation_start:
27675
+ description: The date/time at which the rotation begins (ISO 8601 format).
27676
+ format: date-time
27677
+ type: string
27678
+ type: object
27679
+ ScheduleUpdateRequestDataAttributesLayersItemsInterval:
27680
+ description: 'Specifies how the rotation repeats: number of days, plus optional
27681
+ seconds, up to the given maximums.'
27682
+ properties:
27683
+ days:
27684
+ description: How many days each rotation cycle should span.
27685
+ format: int32
27686
+ maximum: 400
27687
+ type: integer
27688
+ seconds:
27689
+ description: Additional seconds to add to the rotation cycle (for example,
27690
+ partial days).
27691
+ format: int64
27692
+ maximum: 2592000
27693
+ type: integer
27694
+ type: object
27695
+ ScheduleUpdateRequestDataAttributesLayersItemsMembersItems:
27696
+ description: 'Defines a single member within a layer during an update request,
27697
+ referring
27698
+
27699
+ to a specific user.'
27700
+ properties:
27701
+ user:
27702
+ $ref: '#/components/schemas/ScheduleUpdateRequestDataAttributesLayersItemsMembersItemsUser'
27703
+ type: object
27704
+ ScheduleUpdateRequestDataAttributesLayersItemsMembersItemsUser:
27705
+ description: Identifies the user who is assigned to this member object. Only
27706
+ `id` is required.
27707
+ properties:
27708
+ id:
27709
+ description: The user's ID.
27710
+ type: string
27711
+ type: object
27712
+ ScheduleUpdateRequestDataAttributesLayersItemsRestrictionsItems:
27713
+ description: 'Defines a time restriction object for a layer within a schedule
27714
+ update, including
27715
+
27716
+ start and end days, as well as times.'
27717
+ properties:
27718
+ end_day:
27719
+ $ref: '#/components/schemas/ScheduleUpdateRequestDataAttributesLayersItemsRestrictionsItemsEndDay'
27720
+ end_time:
27721
+ description: The time at which this restriction ends (hh:mm:ss).
27722
+ type: string
27723
+ start_day:
27724
+ $ref: '#/components/schemas/ScheduleUpdateRequestDataAttributesLayersItemsRestrictionsItemsStartDay'
27725
+ start_time:
27726
+ description: The time at which this restriction starts (hh:mm:ss).
27727
+ type: string
27728
+ type: object
27729
+ ScheduleUpdateRequestDataAttributesLayersItemsRestrictionsItemsEndDay:
27730
+ description: Defines the day of the week on which the time restriction ends.
27731
+ enum:
27732
+ - monday
27733
+ - tuesday
27734
+ - wednesday
27735
+ - thursday
27736
+ - friday
27737
+ - saturday
27738
+ - sunday
27739
+ type: string
27740
+ x-enum-varnames:
27741
+ - MONDAY
27742
+ - TUESDAY
27743
+ - WEDNESDAY
27744
+ - THURSDAY
27745
+ - FRIDAY
27746
+ - SATURDAY
27747
+ - SUNDAY
27748
+ ScheduleUpdateRequestDataAttributesLayersItemsRestrictionsItemsStartDay:
27749
+ description: Defines the day of the week on which the time restriction starts.
27750
+ enum:
27751
+ - monday
27752
+ - tuesday
27753
+ - wednesday
27754
+ - thursday
27755
+ - friday
27756
+ - saturday
27757
+ - sunday
27758
+ type: string
27759
+ x-enum-varnames:
27760
+ - MONDAY
27761
+ - TUESDAY
27762
+ - WEDNESDAY
27763
+ - THURSDAY
27764
+ - FRIDAY
27765
+ - SATURDAY
27766
+ - SUNDAY
27767
+ ScheduleUpdateRequestDataRelationships:
27768
+ description: Houses relationships for the schedule update, typically referencing
27769
+ teams.
27770
+ properties:
27771
+ teams:
27772
+ $ref: '#/components/schemas/ScheduleUpdateRequestDataRelationshipsTeams'
27773
+ type: object
27774
+ ScheduleUpdateRequestDataRelationshipsTeams:
27775
+ description: Defines the teams that this schedule update is associated with.
27776
+ properties:
27777
+ data:
27778
+ description: An array of team references.
27779
+ items:
27780
+ $ref: '#/components/schemas/ScheduleUpdateRequestDataRelationshipsTeamsDataItems'
27781
+ type: array
27782
+ type: object
27783
+ ScheduleUpdateRequestDataRelationshipsTeamsDataItems:
27784
+ description: Links the schedule to a team within an update request, identified
27785
+ by `id` and `type`.
27786
+ properties:
27787
+ id:
27788
+ description: The unique team identifier.
27789
+ type: string
27790
+ type:
27791
+ $ref: '#/components/schemas/ScheduleUpdateRequestDataRelationshipsTeamsDataItemsType'
27792
+ type: object
27793
+ ScheduleUpdateRequestDataRelationshipsTeamsDataItemsType:
27794
+ default: teams
27795
+ description: Teams resource type.
27796
+ enum:
27797
+ - teams
27798
+ type: string
27799
+ x-enum-varnames:
27800
+ - TEAMS
27801
+ ScheduleUpdateRequestDataType:
27802
+ default: schedules
27803
+ description: Schedules resource type.
27804
+ enum:
27805
+ - schedules
27806
+ example: schedules
27807
+ type: string
27808
+ x-enum-varnames:
27809
+ - SCHEDULES
27810
+ ScheduleUser:
27811
+ description: Represents a user object in the context of a schedule, including
27812
+ their `id`, type, and basic attributes.
27813
+ properties:
27814
+ attributes:
27815
+ $ref: '#/components/schemas/ScheduleUserAttributes'
27816
+ id:
27817
+ description: The unique user identifier.
27818
+ type: string
27819
+ type:
27820
+ $ref: '#/components/schemas/ScheduleUserType'
27821
+ type: object
27822
+ ScheduleUserAttributes:
27823
+ description: Provides basic user information for a schedule, including a name
27824
+ and email address.
27825
+ properties:
27826
+ email:
27827
+ description: The user's email address.
27828
+ type: string
27829
+ name:
27830
+ description: The user's name.
27831
+ example: Jane Doe
27832
+ type: string
27833
+ type: object
27834
+ ScheduleUserType:
27835
+ default: users
27836
+ description: Users resource type.
27837
+ enum:
27838
+ - users
27839
+ type: string
27840
+ x-enum-varnames:
27841
+ - USERS
26154
27842
  ScorecardType:
26155
27843
  default: scorecard
26156
27844
  description: The JSON:API type for scorecard.
@@ -26469,6 +28157,7 @@ components:
26469
28157
  $ref: '#/components/schemas/SecurityMonitoringRuleCaseActionType'
26470
28158
  type: object
26471
28159
  SecurityMonitoringRuleCaseActionOptions:
28160
+ additionalProperties: {}
26472
28161
  description: Options for the rule action
26473
28162
  properties:
26474
28163
  duration:
@@ -26477,16 +28166,24 @@ components:
26477
28166
  format: int64
26478
28167
  minimum: 0
26479
28168
  type: integer
28169
+ userBehaviorName:
28170
+ $ref: '#/components/schemas/SecurityMonitoringRuleCaseActionOptionsUserBehaviorName'
26480
28171
  type: object
28172
+ SecurityMonitoringRuleCaseActionOptionsUserBehaviorName:
28173
+ description: Used with the case action of type 'user_behavior'. The value specified
28174
+ in this field is applied as a risk tag to all users affected by the rule.
28175
+ type: string
26481
28176
  SecurityMonitoringRuleCaseActionType:
26482
28177
  description: The action type.
26483
28178
  enum:
26484
28179
  - block_ip
26485
28180
  - block_user
28181
+ - user_behavior
26486
28182
  type: string
26487
28183
  x-enum-varnames:
26488
28184
  - BLOCK_IP
26489
28185
  - BLOCK_USER
28186
+ - USER_BEHAVIOR
26490
28187
  SecurityMonitoringRuleCaseCreate:
26491
28188
  description: Case when signal is generated.
26492
28189
  properties:
@@ -27667,6 +29364,25 @@ components:
27667
29364
  x-enum-varnames:
27668
29365
  - TIMESTAMP_ASCENDING
27669
29366
  - TIMESTAMP_DESCENDING
29367
+ SecurityMonitoringStandardDataSource:
29368
+ default: logs
29369
+ description: Source of events, either logs or audit trail.
29370
+ enum:
29371
+ - logs
29372
+ - audit
29373
+ - app_sec_spans
29374
+ - spans
29375
+ - security_runtime
29376
+ - network
29377
+ example: logs
29378
+ type: string
29379
+ x-enum-varnames:
29380
+ - LOGS
29381
+ - AUDIT
29382
+ - APP_SEC_SPANS
29383
+ - SPANS
29384
+ - SECURITY_RUNTIME
29385
+ - NETWORK
27670
29386
  SecurityMonitoringStandardRuleCreatePayload:
27671
29387
  description: Create a new rule.
27672
29388
  properties:
@@ -27834,6 +29550,8 @@ components:
27834
29550
  properties:
27835
29551
  aggregation:
27836
29552
  $ref: '#/components/schemas/SecurityMonitoringRuleQueryAggregation'
29553
+ dataSource:
29554
+ $ref: '#/components/schemas/SecurityMonitoringStandardDataSource'
27837
29555
  distinctFields:
27838
29556
  description: Field for which the cardinality is measured. Sent as an array.
27839
29557
  items:
@@ -28416,7 +30134,7 @@ components:
28416
30134
  type: string
28417
30135
  type: object
28418
30136
  SecurityTrigger:
28419
- description: Trigger a workflow VIA a Security Signal or Finding. For automatic
30137
+ description: Trigger a workflow from a Security Signal or Finding. For automatic
28420
30138
  triggering a handle must be configured and the workflow must be published.
28421
30139
  properties:
28422
30140
  rateLimit:
@@ -28455,6 +30173,17 @@ components:
28455
30173
  required:
28456
30174
  - trigger_source
28457
30175
  type: object
30176
+ SelfServiceTriggerWrapper:
30177
+ description: Schema for a Self Service-based trigger.
30178
+ properties:
30179
+ selfServiceTrigger:
30180
+ description: Trigger a workflow from Self Service.
30181
+ type: object
30182
+ startStepNames:
30183
+ $ref: '#/components/schemas/StartStepNames'
30184
+ required:
30185
+ - selfServiceTrigger
30186
+ type: object
28458
30187
  SensitiveDataScannerConfigRequest:
28459
30188
  description: Group reorder request.
28460
30189
  properties:
@@ -29912,24 +31641,8 @@ components:
29912
31641
  type: object
29913
31642
  ServiceDefinitionV2Dot2Type:
29914
31643
  description: The type of service.
29915
- enum:
29916
- - web
29917
- - db
29918
- - cache
29919
- - function
29920
- - browser
29921
- - mobile
29922
- - custom
29923
31644
  example: web
29924
31645
  type: string
29925
- x-enum-varnames:
29926
- - WEB
29927
- - DB
29928
- - CACHE
29929
- - FUNCTION
29930
- - BROSWER
29931
- - MOBILE
29932
- - CUSTOM
29933
31646
  ServiceDefinitionV2Dot2Version:
29934
31647
  default: v2.2
29935
31648
  description: Schema version being used.
@@ -30151,6 +31864,124 @@ components:
30151
31864
  description: Link to the Incident created on ServiceNow
30152
31865
  type: string
30153
31866
  type: object
31867
+ SingleAggregatedConnectionResponseArray:
31868
+ description: List of aggregated connections.
31869
+ example:
31870
+ data:
31871
+ - attributes:
31872
+ bytes_sent_by_client: 100
31873
+ bytes_sent_by_server: 200
31874
+ group_bys:
31875
+ client_team:
31876
+ - networks
31877
+ server_service:
31878
+ - hucklebuck
31879
+ packets_sent_by_client: 10
31880
+ packets_sent_by_server: 20
31881
+ rtt_micro_seconds: 800
31882
+ tcp_closed_connections: 30
31883
+ tcp_established_connections: 40
31884
+ tcp_refusals: 7
31885
+ tcp_resets: 5
31886
+ tcp_retransmits: 30
31887
+ tcp_timeouts: 6
31888
+ id: client_team:networks, server_service:hucklebuck
31889
+ type: aggregated_connection
31890
+ properties:
31891
+ data:
31892
+ description: Array of aggregated connection objects.
31893
+ items:
31894
+ $ref: '#/components/schemas/SingleAggregatedConnectionResponseData'
31895
+ type: array
31896
+ type: object
31897
+ SingleAggregatedConnectionResponseData:
31898
+ description: Object describing an aggregated connection.
31899
+ properties:
31900
+ attributes:
31901
+ $ref: '#/components/schemas/SingleAggregatedConnectionResponseDataAttributes'
31902
+ id:
31903
+ description: A unique identifier for the aggregated connection based on
31904
+ the group by values.
31905
+ type: string
31906
+ type:
31907
+ $ref: '#/components/schemas/SingleAggregatedConnectionResponseDataType'
31908
+ type: object
31909
+ SingleAggregatedConnectionResponseDataAttributes:
31910
+ description: Attributes for an aggregated connection.
31911
+ properties:
31912
+ bytes_sent_by_client:
31913
+ description: The total number of bytes sent by the client over the given
31914
+ period.
31915
+ format: int64
31916
+ type: integer
31917
+ bytes_sent_by_server:
31918
+ description: The total number of bytes sent by the server over the given
31919
+ period.
31920
+ format: int64
31921
+ type: integer
31922
+ group_bys:
31923
+ additionalProperties:
31924
+ description: The values for each group by.
31925
+ items:
31926
+ type: string
31927
+ type: array
31928
+ description: The key, value pairs for each group by.
31929
+ type: object
31930
+ packets_sent_by_client:
31931
+ description: The total number of packets sent by the client over the given
31932
+ period.
31933
+ format: int64
31934
+ type: integer
31935
+ packets_sent_by_server:
31936
+ description: The total number of packets sent by the server over the given
31937
+ period.
31938
+ format: int64
31939
+ type: integer
31940
+ rtt_micro_seconds:
31941
+ description: Measured as TCP smoothed round trip time in microseconds (the
31942
+ time between a TCP frame being sent and acknowledged).
31943
+ format: int64
31944
+ type: integer
31945
+ tcp_closed_connections:
31946
+ description: The number of TCP connections in a closed state. Measured in
31947
+ connections per second from the client.
31948
+ format: int64
31949
+ type: integer
31950
+ tcp_established_connections:
31951
+ description: The number of TCP connections in an established state. Measured
31952
+ in connections per second from the client.
31953
+ format: int64
31954
+ type: integer
31955
+ tcp_refusals:
31956
+ description: The number of TCP connections that were refused by the server.
31957
+ Typically this indicates an attempt to connect to an IP/port that is not
31958
+ receiving connections, or a firewall/security misconfiguration.
31959
+ format: int64
31960
+ type: integer
31961
+ tcp_resets:
31962
+ description: The number of TCP connections that were reset by the server.
31963
+ format: int64
31964
+ type: integer
31965
+ tcp_retransmits:
31966
+ description: TCP Retransmits represent detected failures that are retransmitted
31967
+ to ensure delivery. Measured in count of retransmits from the client.
31968
+ format: int64
31969
+ type: integer
31970
+ tcp_timeouts:
31971
+ description: The number of TCP connections that timed out from the perspective
31972
+ of the operating system. This can indicate general connectivity and latency
31973
+ issues.
31974
+ format: int64
31975
+ type: integer
31976
+ type: object
31977
+ SingleAggregatedConnectionResponseDataType:
31978
+ default: aggregated_connection
31979
+ description: Aggregated connection resource type.
31980
+ enum:
31981
+ - aggregated_connection
31982
+ type: string
31983
+ x-enum-varnames:
31984
+ - AGGREGATED_CONNECTION
30154
31985
  SlackIntegrationMetadata:
30155
31986
  description: Incident integration metadata for the Slack integration.
30156
31987
  properties:
@@ -30191,7 +32022,7 @@ components:
30191
32022
  description: Schema for a Slack-based trigger.
30192
32023
  properties:
30193
32024
  slackTrigger:
30194
- description: Trigger a workflow VIA Slack. The workflow must be published.
32025
+ description: Trigger a workflow from Slack. The workflow must be published.
30195
32026
  type: object
30196
32027
  startStepNames:
30197
32028
  $ref: '#/components/schemas/StartStepNames'
@@ -30245,6 +32076,17 @@ components:
30245
32076
  required:
30246
32077
  - attributes
30247
32078
  type: object
32079
+ SoftwareCatalogTriggerWrapper:
32080
+ description: Schema for a Software Catalog-based trigger.
32081
+ properties:
32082
+ softwareCatalogTrigger:
32083
+ description: Trigger a workflow from Software Catalog.
32084
+ type: object
32085
+ startStepNames:
32086
+ $ref: '#/components/schemas/StartStepNames'
32087
+ required:
32088
+ - softwareCatalogTrigger
32089
+ type: object
30248
32090
  SortDirection:
30249
32091
  default: desc
30250
32092
  description: The direction to sort by.
@@ -31673,6 +33515,79 @@ components:
31673
33515
  $ref: '#/components/schemas/TeamPermissionSetting'
31674
33516
  type: array
31675
33517
  type: object
33518
+ TeamReference:
33519
+ description: Provides a reference to a team, including ID, type, and basic attributes/relationships.
33520
+ properties:
33521
+ attributes:
33522
+ $ref: '#/components/schemas/TeamReferenceAttributes'
33523
+ id:
33524
+ description: The team's unique identifier.
33525
+ type: string
33526
+ relationships:
33527
+ $ref: '#/components/schemas/TeamReferenceRelationships'
33528
+ type:
33529
+ $ref: '#/components/schemas/TeamReferenceType'
33530
+ type: object
33531
+ TeamReferenceAttributes:
33532
+ description: Encapsulates the basic attributes of a Team reference, such as
33533
+ name, handle, and an optional avatar or description.
33534
+ properties:
33535
+ avatar:
33536
+ description: URL or reference for the team's avatar (if available).
33537
+ type: string
33538
+ description:
33539
+ description: A short text describing the team.
33540
+ type: string
33541
+ handle:
33542
+ description: A unique handle/slug for the team.
33543
+ type: string
33544
+ name:
33545
+ description: The full, human-readable name of the team.
33546
+ type: string
33547
+ type: object
33548
+ TeamReferenceRelationships:
33549
+ description: Collects the key relationship fields for a team reference, specifically
33550
+ on-call users.
33551
+ properties:
33552
+ oncall_users:
33553
+ $ref: '#/components/schemas/TeamReferenceRelationshipsOncallUsers'
33554
+ type: object
33555
+ TeamReferenceRelationshipsOncallUsers:
33556
+ description: Defines which users are on-call within a team, stored as an array
33557
+ of references.
33558
+ properties:
33559
+ data:
33560
+ description: The list of user references who are on-call for this team.
33561
+ items:
33562
+ $ref: '#/components/schemas/TeamReferenceRelationshipsOncallUsersDataItems'
33563
+ type: array
33564
+ type: object
33565
+ TeamReferenceRelationshipsOncallUsersDataItems:
33566
+ description: References a user who is on-call within this team, identified by
33567
+ `id` and `type`.
33568
+ properties:
33569
+ id:
33570
+ description: The unique identifier of the user.
33571
+ type: string
33572
+ type:
33573
+ $ref: '#/components/schemas/TeamReferenceRelationshipsOncallUsersDataItemsType'
33574
+ type: object
33575
+ TeamReferenceRelationshipsOncallUsersDataItemsType:
33576
+ default: users
33577
+ description: Users resource type.
33578
+ enum:
33579
+ - users
33580
+ type: string
33581
+ x-enum-varnames:
33582
+ - USERS
33583
+ TeamReferenceType:
33584
+ default: teams
33585
+ description: Teams resource type.
33586
+ enum:
33587
+ - teams
33588
+ type: string
33589
+ x-enum-varnames:
33590
+ - TEAMS
31676
33591
  TeamRelationships:
31677
33592
  description: Resources related to a team
31678
33593
  properties:
@@ -32104,13 +34019,17 @@ components:
32104
34019
  - $ref: '#/components/schemas/AppTriggerWrapper'
32105
34020
  - $ref: '#/components/schemas/CaseTriggerWrapper'
32106
34021
  - $ref: '#/components/schemas/ChangeEventTriggerWrapper'
34022
+ - $ref: '#/components/schemas/DatabaseMonitoringTriggerWrapper'
32107
34023
  - $ref: '#/components/schemas/DashboardTriggerWrapper'
32108
34024
  - $ref: '#/components/schemas/GithubWebhookTriggerWrapper'
32109
34025
  - $ref: '#/components/schemas/IncidentTriggerWrapper'
32110
34026
  - $ref: '#/components/schemas/MonitorTriggerWrapper'
34027
+ - $ref: '#/components/schemas/NotebookTriggerWrapper'
32111
34028
  - $ref: '#/components/schemas/ScheduleTriggerWrapper'
32112
34029
  - $ref: '#/components/schemas/SecurityTriggerWrapper'
34030
+ - $ref: '#/components/schemas/SelfServiceTriggerWrapper'
32113
34031
  - $ref: '#/components/schemas/SlackTriggerWrapper'
34032
+ - $ref: '#/components/schemas/SoftwareCatalogTriggerWrapper'
32114
34033
  - $ref: '#/components/schemas/WorkflowTriggerWrapper'
32115
34034
  TriggerRateLimit:
32116
34035
  description: Defines a rate limit for a trigger.
@@ -33739,7 +35658,7 @@ components:
33739
35658
  startStepNames:
33740
35659
  $ref: '#/components/schemas/StartStepNames'
33741
35660
  workflowTrigger:
33742
- description: Trigger a workflow VIA the Datadog UI. Only required if no
35661
+ description: Trigger a workflow from the Datadog UI. Only required if no
33743
35662
  other trigger exists.
33744
35663
  type: object
33745
35664
  required:
@@ -38789,7 +40708,12 @@ paths:
38789
40708
  - monitors_downtime
38790
40709
  /api/v2/downtime/{downtime_id}:
38791
40710
  delete:
38792
- description: Cancel a downtime.
40711
+ description: 'Cancel a downtime.
40712
+
40713
+
40714
+ **Note**: Downtimes canceled through the API are no longer active, but are
40715
+ retained for approximately two days before being permanently removed. The
40716
+ downtime may still appear in search results until it is permanently removed.'
38793
40717
  operationId: CancelDowntime
38794
40718
  parameters:
38795
40719
  - description: ID of the downtime to cancel.
@@ -44225,6 +46149,221 @@ paths:
44225
46149
  summary: Update the tags for a device
44226
46150
  tags:
44227
46151
  - Network Device Monitoring
46152
+ /api/v2/network/connections/aggregate:
46153
+ get:
46154
+ description: Get all aggregated connections.
46155
+ operationId: GetAggregatedConnections
46156
+ parameters:
46157
+ - description: Unix timestamp (number of seconds since epoch) of the start of
46158
+ the query window. If not provided, the start of the query window is 15 minutes
46159
+ before the `to` timestamp. If neither `from` nor `to` are provided, the
46160
+ query window is `[now - 15m, now]`.
46161
+ in: query
46162
+ name: from
46163
+ schema:
46164
+ format: int64
46165
+ type: integer
46166
+ - description: Unix timestamp (number of seconds since epoch) of the end of
46167
+ the query window. If not provided, the end of the query window is the current
46168
+ time. If neither `from` nor `to` are provided, the query window is `[now
46169
+ - 15m, now]`.
46170
+ in: query
46171
+ name: to
46172
+ schema:
46173
+ format: int64
46174
+ type: integer
46175
+ - description: Comma-separated list of fields to group connections by.
46176
+ in: query
46177
+ name: group_by
46178
+ schema:
46179
+ type: string
46180
+ - description: Comma-separated list of tags to filter connections by.
46181
+ in: query
46182
+ name: tags
46183
+ schema:
46184
+ type: string
46185
+ - description: The number of connections to be returned. The maximum value is
46186
+ 5000.
46187
+ in: query
46188
+ name: limit
46189
+ schema:
46190
+ default: 100
46191
+ format: int32
46192
+ maximum: 5000
46193
+ minimum: 1
46194
+ type: integer
46195
+ responses:
46196
+ '200':
46197
+ content:
46198
+ application/json:
46199
+ schema:
46200
+ $ref: '#/components/schemas/SingleAggregatedConnectionResponseArray'
46201
+ description: OK
46202
+ '400':
46203
+ $ref: '#/components/responses/BadRequestResponse'
46204
+ '429':
46205
+ $ref: '#/components/responses/TooManyRequestsResponse'
46206
+ summary: Get all aggregated connections
46207
+ tags:
46208
+ - Cloud Network Monitoring
46209
+ x-unstable: '**Note**: This endpoint is in Preview. If you have any feedback,
46210
+
46211
+ contact [Datadog support](https://docs.datadoghq.com/help/).'
46212
+ /api/v2/on-call/schedules:
46213
+ post:
46214
+ description: Create a new on-call schedule
46215
+ operationId: CreateOnCallSchedule
46216
+ parameters:
46217
+ - description: 'Comma-separated list of included relationships to be returned.
46218
+ Allowed values: `teams`, `layers`, `layers.members`, `layers.members.user`.'
46219
+ in: query
46220
+ name: include
46221
+ schema:
46222
+ type: string
46223
+ requestBody:
46224
+ content:
46225
+ application/json:
46226
+ schema:
46227
+ $ref: '#/components/schemas/ScheduleCreateRequest'
46228
+ required: true
46229
+ responses:
46230
+ '201':
46231
+ content:
46232
+ application/json:
46233
+ schema:
46234
+ $ref: '#/components/schemas/Schedule'
46235
+ description: Created
46236
+ '400':
46237
+ $ref: '#/components/responses/BadRequestResponse'
46238
+ '401':
46239
+ $ref: '#/components/responses/UnauthorizedResponse'
46240
+ '403':
46241
+ $ref: '#/components/responses/ForbiddenResponse'
46242
+ '429':
46243
+ $ref: '#/components/responses/TooManyRequestsResponse'
46244
+ security:
46245
+ - apiKeyAuth: []
46246
+ appKeyAuth: []
46247
+ - AuthZ: []
46248
+ summary: Create on-call schedule
46249
+ tags:
46250
+ - On-Call
46251
+ /api/v2/on-call/schedules/{schedule_id}:
46252
+ delete:
46253
+ description: Delete an on-call schedule
46254
+ operationId: DeleteOnCallSchedule
46255
+ parameters:
46256
+ - description: The ID of the schedule
46257
+ in: path
46258
+ name: schedule_id
46259
+ required: true
46260
+ schema:
46261
+ example: 3653d3c6-0c75-11ea-ad28-fb5701eabc7d
46262
+ type: string
46263
+ responses:
46264
+ '204':
46265
+ description: No Content
46266
+ '401':
46267
+ $ref: '#/components/responses/UnauthorizedResponse'
46268
+ '403':
46269
+ $ref: '#/components/responses/ForbiddenResponse'
46270
+ '404':
46271
+ $ref: '#/components/responses/NotFoundResponse'
46272
+ '429':
46273
+ $ref: '#/components/responses/TooManyRequestsResponse'
46274
+ security:
46275
+ - apiKeyAuth: []
46276
+ appKeyAuth: []
46277
+ - AuthZ: []
46278
+ summary: Delete on-call schedule
46279
+ tags:
46280
+ - On-Call
46281
+ get:
46282
+ description: Get an on-call schedule
46283
+ operationId: GetOnCallSchedule
46284
+ parameters:
46285
+ - description: 'Comma-separated list of included relationships to be returned.
46286
+ Allowed values: `teams`, `layers`, `layers.members`, `layers.members.user`.'
46287
+ in: query
46288
+ name: include
46289
+ schema:
46290
+ type: string
46291
+ - description: The ID of the schedule
46292
+ in: path
46293
+ name: schedule_id
46294
+ required: true
46295
+ schema:
46296
+ example: 3653d3c6-0c75-11ea-ad28-fb5701eabc7d
46297
+ type: string
46298
+ responses:
46299
+ '200':
46300
+ content:
46301
+ application/json:
46302
+ schema:
46303
+ $ref: '#/components/schemas/Schedule'
46304
+ description: OK
46305
+ '401':
46306
+ $ref: '#/components/responses/UnauthorizedResponse'
46307
+ '403':
46308
+ $ref: '#/components/responses/ForbiddenResponse'
46309
+ '404':
46310
+ $ref: '#/components/responses/NotFoundResponse'
46311
+ '429':
46312
+ $ref: '#/components/responses/TooManyRequestsResponse'
46313
+ security:
46314
+ - apiKeyAuth: []
46315
+ appKeyAuth: []
46316
+ - AuthZ: []
46317
+ summary: Get on-call schedule
46318
+ tags:
46319
+ - On-Call
46320
+ put:
46321
+ description: Update a new on-call schedule
46322
+ operationId: UpdateOnCallSchedule
46323
+ parameters:
46324
+ - description: 'Comma-separated list of included relationships to be returned.
46325
+ Allowed values: `teams`, `layers`, `layers.members`, `layers.members.user`.'
46326
+ in: query
46327
+ name: include
46328
+ schema:
46329
+ type: string
46330
+ - description: The ID of the schedule
46331
+ in: path
46332
+ name: schedule_id
46333
+ required: true
46334
+ schema:
46335
+ example: 3653d3c6-0c75-11ea-ad28-fb5701eabc7d
46336
+ type: string
46337
+ requestBody:
46338
+ content:
46339
+ application/json:
46340
+ schema:
46341
+ $ref: '#/components/schemas/ScheduleUpdateRequest'
46342
+ required: true
46343
+ responses:
46344
+ '200':
46345
+ content:
46346
+ application/json:
46347
+ schema:
46348
+ $ref: '#/components/schemas/Schedule'
46349
+ description: OK
46350
+ '400':
46351
+ $ref: '#/components/responses/BadRequestResponse'
46352
+ '401':
46353
+ $ref: '#/components/responses/UnauthorizedResponse'
46354
+ '403':
46355
+ $ref: '#/components/responses/ForbiddenResponse'
46356
+ '404':
46357
+ $ref: '#/components/responses/NotFoundResponse'
46358
+ '429':
46359
+ $ref: '#/components/responses/TooManyRequestsResponse'
46360
+ security:
46361
+ - apiKeyAuth: []
46362
+ appKeyAuth: []
46363
+ - AuthZ: []
46364
+ summary: Update on-call schedule
46365
+ tags:
46366
+ - On-Call
44228
46367
  /api/v2/org_configs:
44229
46368
  get:
44230
46369
  description: Returns all Org Configs (name, description, and value).
@@ -45413,6 +47552,167 @@ paths:
45413
47552
  summary: Get the latest CSM Threats policy
45414
47553
  tags:
45415
47554
  - CSM Threats
47555
+ /api/v2/remote_config/products/obs_pipelines/pipelines:
47556
+ post:
47557
+ description: Create a new pipeline.
47558
+ operationId: CreatePipeline
47559
+ requestBody:
47560
+ content:
47561
+ application/json:
47562
+ schema:
47563
+ $ref: '#/components/schemas/ObservabilityPipelineCreateRequest'
47564
+ required: true
47565
+ responses:
47566
+ '201':
47567
+ content:
47568
+ application/json:
47569
+ schema:
47570
+ $ref: '#/components/schemas/ObservabilityPipeline'
47571
+ description: OK
47572
+ '400':
47573
+ content:
47574
+ application/json:
47575
+ schema:
47576
+ $ref: '#/components/schemas/APIErrorResponse'
47577
+ description: Bad Request
47578
+ '403':
47579
+ content:
47580
+ application/json:
47581
+ schema:
47582
+ $ref: '#/components/schemas/APIErrorResponse'
47583
+ description: Forbidden
47584
+ '409':
47585
+ content:
47586
+ application/json:
47587
+ schema:
47588
+ $ref: '#/components/schemas/APIErrorResponse'
47589
+ description: Conflict
47590
+ '429':
47591
+ $ref: '#/components/responses/TooManyRequestsResponse'
47592
+ summary: Create a new pipeline
47593
+ tags:
47594
+ - Observability Pipelines
47595
+ x-unstable: '**Note**: This endpoint is in Preview.'
47596
+ /api/v2/remote_config/products/obs_pipelines/pipelines/{pipeline_id}:
47597
+ delete:
47598
+ description: Delete a pipeline.
47599
+ operationId: DeletePipeline
47600
+ parameters:
47601
+ - description: The ID of the pipeline to delete.
47602
+ in: path
47603
+ name: pipeline_id
47604
+ required: true
47605
+ schema:
47606
+ type: string
47607
+ responses:
47608
+ '204':
47609
+ description: OK
47610
+ '403':
47611
+ content:
47612
+ application/json:
47613
+ schema:
47614
+ $ref: '#/components/schemas/APIErrorResponse'
47615
+ description: Forbidden
47616
+ '404':
47617
+ content:
47618
+ application/json:
47619
+ schema:
47620
+ $ref: '#/components/schemas/APIErrorResponse'
47621
+ description: Not Found
47622
+ '409':
47623
+ content:
47624
+ application/json:
47625
+ schema:
47626
+ $ref: '#/components/schemas/APIErrorResponse'
47627
+ description: Conflict
47628
+ '429':
47629
+ $ref: '#/components/responses/TooManyRequestsResponse'
47630
+ summary: Delete a pipeline
47631
+ tags:
47632
+ - Observability Pipelines
47633
+ x-unstable: '**Note**: This endpoint is in Preview.'
47634
+ get:
47635
+ description: Get a specific pipeline by its ID.
47636
+ operationId: GetPipeline
47637
+ parameters:
47638
+ - description: The ID of the pipeline to retrieve.
47639
+ in: path
47640
+ name: pipeline_id
47641
+ required: true
47642
+ schema:
47643
+ type: string
47644
+ responses:
47645
+ '200':
47646
+ content:
47647
+ application/json:
47648
+ schema:
47649
+ $ref: '#/components/schemas/ObservabilityPipeline'
47650
+ description: OK
47651
+ '403':
47652
+ content:
47653
+ application/json:
47654
+ schema:
47655
+ $ref: '#/components/schemas/APIErrorResponse'
47656
+ description: Forbidden
47657
+ '429':
47658
+ $ref: '#/components/responses/TooManyRequestsResponse'
47659
+ summary: Get a specific pipeline
47660
+ tags:
47661
+ - Observability Pipelines
47662
+ x-unstable: '**Note**: This endpoint is in Preview.'
47663
+ put:
47664
+ description: Update a pipeline.
47665
+ operationId: UpdatePipeline
47666
+ parameters:
47667
+ - description: The ID of the pipeline to update.
47668
+ in: path
47669
+ name: pipeline_id
47670
+ required: true
47671
+ schema:
47672
+ type: string
47673
+ requestBody:
47674
+ content:
47675
+ application/json:
47676
+ schema:
47677
+ $ref: '#/components/schemas/ObservabilityPipeline'
47678
+ required: true
47679
+ responses:
47680
+ '200':
47681
+ content:
47682
+ application/json:
47683
+ schema:
47684
+ $ref: '#/components/schemas/ObservabilityPipeline'
47685
+ description: OK
47686
+ '400':
47687
+ content:
47688
+ application/json:
47689
+ schema:
47690
+ $ref: '#/components/schemas/APIErrorResponse'
47691
+ description: Bad Request
47692
+ '403':
47693
+ content:
47694
+ application/json:
47695
+ schema:
47696
+ $ref: '#/components/schemas/APIErrorResponse'
47697
+ description: Forbidden
47698
+ '404':
47699
+ content:
47700
+ application/json:
47701
+ schema:
47702
+ $ref: '#/components/schemas/APIErrorResponse'
47703
+ description: Not Found
47704
+ '409':
47705
+ content:
47706
+ application/json:
47707
+ schema:
47708
+ $ref: '#/components/schemas/APIErrorResponse'
47709
+ description: Conflict
47710
+ '429':
47711
+ $ref: '#/components/responses/TooManyRequestsResponse'
47712
+ summary: Update a pipeline
47713
+ tags:
47714
+ - Observability Pipelines
47715
+ x-unstable: '**Note**: This endpoint is in Preview.'
45416
47716
  /api/v2/restriction_policy/{resource_id}:
45417
47717
  delete:
45418
47718
  description: Deletes the restriction policy associated with a specified resource.
@@ -45476,6 +47776,10 @@ paths:
45476
47776
 
45477
47777
  - Dashboards: `dashboard`
45478
47778
 
47779
+ - Integration Accounts: `integration-account`
47780
+
47781
+ - Integration Webhooks: `integration-webhook`
47782
+
45479
47783
  - Notebooks: `notebook`
45480
47784
 
45481
47785
  - Powerpacks: `powerpack`
@@ -45511,6 +47815,10 @@ paths:
45511
47815
 
45512
47816
  Dashboards | `viewer`, `editor`
45513
47817
 
47818
+ Integration Accounts | `viewer`, `editor`
47819
+
47820
+ Integration Webhooks | `viewer`, `editor`
47821
+
45514
47822
  Notebooks | `viewer`, `editor`
45515
47823
 
45516
47824
  Powerpacks | `viewer`, `editor`
@@ -46244,10 +48552,10 @@ paths:
46244
48552
  - rum_apps_write
46245
48553
  /api/v2/rum/applications/{app_id}/relationships/retention_filters:
46246
48554
  patch:
46247
- description: 'Order RUM retention filters for an application.
48555
+ description: 'Order RUM retention filters for a RUM application.
46248
48556
 
46249
- Returns RUM retention filter objects without attributes and meta from the
46250
- request body when the request is successful.'
48557
+ Returns RUM retention filter objects without attributes from the request body
48558
+ when the request is successful.'
46251
48559
  operationId: OrderRetentionFilters
46252
48560
  parameters:
46253
48561
  - $ref: '#/components/parameters/RumApplicationIDParameter'
@@ -46277,7 +48585,7 @@ paths:
46277
48585
  x-codegen-request-body-name: body
46278
48586
  /api/v2/rum/applications/{app_id}/retention_filters:
46279
48587
  get:
46280
- description: Get the list of RUM retention filters for an application.
48588
+ description: Get the list of RUM retention filters for a RUM application.
46281
48589
  operationId: ListRetentionFilters
46282
48590
  parameters:
46283
48591
  - $ref: '#/components/parameters/RumApplicationIDParameter'
@@ -46296,7 +48604,7 @@ paths:
46296
48604
  tags:
46297
48605
  - Rum Retention Filters
46298
48606
  post:
46299
- description: 'Create a RUM retention filter for an application.
48607
+ description: 'Create a RUM retention filter for a RUM application.
46300
48608
 
46301
48609
  Returns RUM retention filter objects from the request body when the request
46302
48610
  is successful.'
@@ -46329,7 +48637,7 @@ paths:
46329
48637
  x-codegen-request-body-name: body
46330
48638
  /api/v2/rum/applications/{app_id}/retention_filters/{rf_id}:
46331
48639
  delete:
46332
- description: Delete a RUM retention filter for an application.
48640
+ description: Delete a RUM retention filter for a RUM application.
46333
48641
  operationId: DeleteRetentionFilter
46334
48642
  parameters:
46335
48643
  - $ref: '#/components/parameters/RumApplicationIDParameter'
@@ -46347,7 +48655,7 @@ paths:
46347
48655
  tags:
46348
48656
  - Rum Retention Filters
46349
48657
  get:
46350
- description: Get a RUM retention filter for an application.
48658
+ description: Get a RUM retention filter for a RUM application.
46351
48659
  operationId: GetRetentionFilter
46352
48660
  parameters:
46353
48661
  - $ref: '#/components/parameters/RumApplicationIDParameter'
@@ -46369,7 +48677,7 @@ paths:
46369
48677
  tags:
46370
48678
  - Rum Retention Filters
46371
48679
  patch:
46372
- description: 'Update a RUM retention filter for an application.
48680
+ description: 'Update a RUM retention filter for a RUM application.
46373
48681
 
46374
48682
  Returns RUM retention filter objects from the request body when the request
46375
48683
  is successful.'
@@ -53567,6 +55875,10 @@ tags:
53567
55875
  and the `cloud_cost` data source. For more information, see the [Cloud Cost Management
53568
55876
  documentation](https://docs.datadoghq.com/cloud_cost_management/).
53569
55877
  name: Cloud Cost Management
55878
+ - description: The Cloud Network Monitoring API allows you to fetch aggregated connections
55879
+ and their attributes. See the [Cloud Network Monitoring page](https://docs.datadoghq.com/network_monitoring/cloud_network_monitoring/)
55880
+ for more information.
55881
+ name: Cloud Network Monitoring
53570
55882
  - description: Manage your Datadog Cloudflare integration directly through the Datadog
53571
55883
  API. See the [Cloudflare integration page](https://docs.datadoghq.com/integrations/cloudflare/)
53572
55884
  for more information.
@@ -53745,9 +56057,21 @@ tags:
53745
56057
  and their attributes. See the [Network Device Monitoring page](https://docs.datadoghq.com/network_monitoring/)
53746
56058
  for more information.
53747
56059
  name: Network Device Monitoring
56060
+ - description: Observability Pipelines allows you to collect and process logs within
56061
+ your own infrastructure, and then route them to downstream integrations.
56062
+ externalDocs:
56063
+ description: Find out more at
56064
+ url: https://docs.datadoghq.com/observability_pipelines/
56065
+ name: Observability Pipelines
53748
56066
  - description: Configure your [Datadog Okta integration](https://docs.datadoghq.com/integrations/okta/)
53749
56067
  directly through the Datadog API.
53750
56068
  name: Okta Integration
56069
+ - description: 'Configure your [Datadog On-Call](https://docs.datadoghq.com/service_management/on-call/)
56070
+
56071
+ directly through the Datadog API.'
56072
+ externalDocs:
56073
+ url: https://docs.datadoghq.com/service_management/on-call/
56074
+ name: On-Call
53751
56075
  - description: 'Configure your [Datadog Opsgenie integration](https://docs.datadoghq.com/integrations/opsgenie/)
53752
56076
 
53753
56077
  directly through the Datadog API.'
@@ -53819,7 +56143,7 @@ tags:
53819
56143
  url: https://docs.datadoghq.com/real_user_monitoring/platform/generate_metrics/
53820
56144
  name: Rum Metrics
53821
56145
  - description: Manage retention filters through [Manage Applications](https://app.datadoghq.com/rum/list)
53822
- for your organization.
56146
+ of RUM for your organization.
53823
56147
  name: Rum Retention Filters
53824
56148
  - description: Create and manage your security rules, signals, filters, and more.
53825
56149
  See the [Datadog Security page](https://docs.datadoghq.com/security/) for more