datadog_api_client 2.37.0 → 2.38.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 (76) hide show
  1. checksums.yaml +4 -4
  2. data/.apigentools-info +4 -4
  3. data/.generator/schemas/v1/openapi.yaml +20 -1
  4. data/.generator/schemas/v2/openapi.yaml +1083 -74
  5. data/CHANGELOG.md +20 -0
  6. data/examples/v2/action-connection/GetAppKeyRegistration.rb +5 -0
  7. data/examples/v2/action-connection/ListAppKeyRegistrations.rb +5 -0
  8. data/examples/v2/action-connection/RegisterAppKey.rb +5 -0
  9. data/examples/v2/action-connection/UnregisterAppKey.rb +5 -0
  10. data/examples/v2/events/CreateEvent.rb +4 -2
  11. data/examples/v2/monitors/CreateMonitorUserTemplate.rb +37 -0
  12. data/examples/v2/monitors/DeleteMonitorUserTemplate.rb +8 -0
  13. data/examples/v2/monitors/GetMonitorUserTemplate.rb +11 -0
  14. data/examples/v2/monitors/ListMonitorUserTemplates.rb +8 -0
  15. data/examples/v2/monitors/UpdateMonitorUserTemplate.rb +41 -0
  16. data/examples/v2/monitors/ValidateExistingMonitorUserTemplate.rb +41 -0
  17. data/examples/v2/monitors/ValidateMonitorUserTemplate.rb +37 -0
  18. data/lib/datadog_api_client/configuration.rb +59 -0
  19. data/lib/datadog_api_client/inflector.rb +29 -0
  20. data/lib/datadog_api_client/v1/models/synthetics_mobile_test.rb +12 -1
  21. data/lib/datadog_api_client/v1/models/synthetics_test_request.rb +1 -1
  22. data/lib/datadog_api_client/v1/models/synthetics_test_request_dns_server_port.rb +63 -0
  23. data/lib/datadog_api_client/v2/api/action_connection_api.rb +263 -4
  24. data/lib/datadog_api_client/v2/api/app_builder_api.rb +8 -8
  25. data/lib/datadog_api_client/v2/api/events_api.rb +8 -4
  26. data/lib/datadog_api_client/v2/api/monitors_api.rb +512 -0
  27. data/lib/datadog_api_client/v2/api/workflow_automation_api.rb +8 -8
  28. data/lib/datadog_api_client/v2/models/alert_event_custom_attributes.rb +145 -0
  29. data/lib/datadog_api_client/v2/models/alert_event_custom_attributes_links_items.rb +152 -0
  30. data/lib/datadog_api_client/v2/models/alert_event_custom_attributes_links_items_category.rb +28 -0
  31. data/lib/datadog_api_client/v2/models/alert_event_custom_attributes_priority.rb +30 -0
  32. data/lib/datadog_api_client/v2/models/alert_event_custom_attributes_status.rb +28 -0
  33. data/lib/datadog_api_client/v2/models/app_key_registration_data.rb +133 -0
  34. data/lib/datadog_api_client/v2/models/app_key_registration_data_type.rb +26 -0
  35. data/lib/datadog_api_client/v2/models/change_event_custom_attributes.rb +19 -33
  36. data/lib/datadog_api_client/v2/models/change_event_custom_attributes_author.rb +10 -31
  37. data/lib/datadog_api_client/v2/models/change_event_custom_attributes_changed_resource.rb +15 -32
  38. data/lib/datadog_api_client/v2/models/change_event_custom_attributes_changed_resource_type.rb +1 -1
  39. data/lib/datadog_api_client/v2/models/change_event_custom_attributes_impacted_resources_items.rb +15 -32
  40. data/lib/datadog_api_client/v2/models/change_event_custom_attributes_impacted_resources_items_type.rb +1 -1
  41. data/lib/datadog_api_client/v2/models/event_category.rb +2 -1
  42. data/lib/datadog_api_client/v2/models/event_create_request.rb +32 -3
  43. data/lib/datadog_api_client/v2/models/event_create_request_payload.rb +20 -2
  44. data/lib/datadog_api_client/v2/models/event_create_response.rb +3 -3
  45. data/lib/datadog_api_client/v2/models/event_create_response_attributes.rb +2 -2
  46. data/lib/datadog_api_client/v2/models/event_create_response_attributes_attributes.rb +1 -1
  47. data/lib/datadog_api_client/v2/models/event_create_response_attributes_attributes_evt.rb +14 -4
  48. data/lib/datadog_api_client/v2/models/event_create_response_payload.rb +15 -5
  49. data/lib/datadog_api_client/v2/models/event_create_response_payload_links.rb +105 -0
  50. data/lib/datadog_api_client/v2/models/event_payload.rb +48 -36
  51. data/lib/datadog_api_client/v2/models/event_payload_attributes.rb +3 -2
  52. data/lib/datadog_api_client/v2/models/event_payload_integration_id.rb +26 -0
  53. data/lib/datadog_api_client/v2/models/get_app_key_registration_response.rb +105 -0
  54. data/lib/datadog_api_client/v2/models/incident_create_attributes.rb +11 -1
  55. data/lib/datadog_api_client/v2/models/incident_response_attributes.rb +11 -1
  56. data/lib/datadog_api_client/v2/models/job_definition_from_rule.rb +1 -26
  57. data/lib/datadog_api_client/v2/models/list_app_key_registrations_response.rb +117 -0
  58. data/lib/datadog_api_client/v2/models/list_app_key_registrations_response_meta.rb +115 -0
  59. data/lib/datadog_api_client/v2/models/monitor_user_template.rb +200 -0
  60. data/lib/datadog_api_client/v2/models/monitor_user_template_create_data.rb +144 -0
  61. data/lib/datadog_api_client/v2/models/monitor_user_template_create_request.rb +123 -0
  62. data/lib/datadog_api_client/v2/models/monitor_user_template_create_response.rb +105 -0
  63. data/lib/datadog_api_client/v2/models/monitor_user_template_list_response.rb +107 -0
  64. data/lib/datadog_api_client/v2/models/monitor_user_template_request_attributes.rb +172 -0
  65. data/lib/datadog_api_client/v2/models/monitor_user_template_resource_type.rb +26 -0
  66. data/lib/datadog_api_client/v2/models/monitor_user_template_response.rb +105 -0
  67. data/lib/datadog_api_client/v2/models/monitor_user_template_response_attributes.rb +188 -0
  68. data/lib/datadog_api_client/v2/models/monitor_user_template_response_data.rb +125 -0
  69. data/lib/datadog_api_client/v2/models/monitor_user_template_response_data_with_versions.rb +125 -0
  70. data/lib/datadog_api_client/v2/models/monitor_user_template_template_variables_items.rb +132 -0
  71. data/lib/datadog_api_client/v2/models/monitor_user_template_update_data.rb +165 -0
  72. data/lib/datadog_api_client/v2/models/monitor_user_template_update_request.rb +123 -0
  73. data/lib/datadog_api_client/v2/models/register_app_key_response.rb +105 -0
  74. data/lib/datadog_api_client/v2/models/simple_monitor_user_template.rb +188 -0
  75. data/lib/datadog_api_client/version.rb +1 -1
  76. metadata +41 -1
@@ -127,6 +127,13 @@ components:
127
127
  required: true
128
128
  schema:
129
129
  type: string
130
+ ApplicationKeyId:
131
+ description: The ID of the app key
132
+ in: path
133
+ name: app_key_id
134
+ required: true
135
+ schema:
136
+ type: string
130
137
  ApplicationKeyIncludeParameter:
131
138
  description: Resource path for related resources to include in the response.
132
139
  Only `owned_by` is supported.
@@ -2227,6 +2234,97 @@ components:
2227
2234
  - id
2228
2235
  - base_severity
2229
2236
  type: object
2237
+ AlertEventCustomAttributes:
2238
+ additionalProperties: false
2239
+ description: Alert event attributes.
2240
+ properties:
2241
+ custom:
2242
+ $ref: '#/components/schemas/AlertEventCustomAttributesCustom'
2243
+ links:
2244
+ $ref: '#/components/schemas/AlertEventCustomAttributesLinks'
2245
+ priority:
2246
+ $ref: '#/components/schemas/AlertEventCustomAttributesPriority'
2247
+ status:
2248
+ $ref: '#/components/schemas/AlertEventCustomAttributesStatus'
2249
+ required:
2250
+ - status
2251
+ type: object
2252
+ AlertEventCustomAttributesCustom:
2253
+ additionalProperties: {}
2254
+ description: Free form JSON object for arbitrary data. Supports up to 100 properties
2255
+ per object and a maximum nesting depth of 10 levels.
2256
+ example: {}
2257
+ type: object
2258
+ AlertEventCustomAttributesLinks:
2259
+ description: The links related to the event. Maximum of 20 links allowed.
2260
+ items:
2261
+ $ref: '#/components/schemas/AlertEventCustomAttributesLinksItems'
2262
+ maxItems: 20
2263
+ minItems: 1
2264
+ type: array
2265
+ AlertEventCustomAttributesLinksItems:
2266
+ additionalProperties: false
2267
+ description: A link.
2268
+ properties:
2269
+ category:
2270
+ $ref: '#/components/schemas/AlertEventCustomAttributesLinksItemsCategory'
2271
+ title:
2272
+ description: The display text of the link. Limited to 300 characters.
2273
+ example: Runbook Link
2274
+ maxLength: 300
2275
+ minLength: 1
2276
+ type: string
2277
+ url:
2278
+ description: The URL of the link. Limited to 2048 characters.
2279
+ example: https://app.datadoghq.com/runbook
2280
+ maxLength: 2048
2281
+ minLength: 1
2282
+ type: string
2283
+ required:
2284
+ - url
2285
+ - category
2286
+ type: object
2287
+ AlertEventCustomAttributesLinksItemsCategory:
2288
+ description: The category of the link.
2289
+ enum:
2290
+ - runbook
2291
+ - documentation
2292
+ - dashboard
2293
+ example: runbook
2294
+ type: string
2295
+ x-enum-varnames:
2296
+ - RUNBOOK
2297
+ - DOCUMENTATION
2298
+ - DASHBOARD
2299
+ AlertEventCustomAttributesPriority:
2300
+ default: '5'
2301
+ description: The priority of the alert.
2302
+ enum:
2303
+ - '1'
2304
+ - '2'
2305
+ - '3'
2306
+ - '4'
2307
+ - '5'
2308
+ example: '5'
2309
+ type: string
2310
+ x-enum-varnames:
2311
+ - PRIORITY_ONE
2312
+ - PRIORITY_TWO
2313
+ - PRIORITY_THREE
2314
+ - PRIORITY_FOUR
2315
+ - PRIORITY_FIVE
2316
+ AlertEventCustomAttributesStatus:
2317
+ description: The status of the alert.
2318
+ enum:
2319
+ - warn
2320
+ - error
2321
+ - ok
2322
+ example: warn
2323
+ type: string
2324
+ x-enum-varnames:
2325
+ - WARN
2326
+ - ERROR
2327
+ - OK
2230
2328
  Annotation:
2231
2329
  description: A list of annotations used in the workflow. These are like sticky
2232
2330
  notes for your workflow!
@@ -2367,6 +2465,27 @@ components:
2367
2465
  type: string
2368
2466
  x-enum-varnames:
2369
2467
  - DEPLOYMENT
2468
+ AppKeyRegistrationData:
2469
+ description: Data related to the app key registration.
2470
+ properties:
2471
+ id:
2472
+ description: The app key registration identifier
2473
+ format: uuid
2474
+ readOnly: true
2475
+ type: string
2476
+ type:
2477
+ $ref: '#/components/schemas/AppKeyRegistrationDataType'
2478
+ required:
2479
+ - type
2480
+ type: object
2481
+ AppKeyRegistrationDataType:
2482
+ description: The definition of `AppKeyRegistrationDataType` object.
2483
+ enum:
2484
+ - app_key_registration
2485
+ example: app_key_registration
2486
+ type: string
2487
+ x-enum-varnames:
2488
+ - APP_KEY_REGISTRATION
2370
2489
  AppMeta:
2371
2490
  description: Metadata of an app.
2372
2491
  properties:
@@ -6919,14 +7038,16 @@ components:
6919
7038
  type: integer
6920
7039
  type: object
6921
7040
  ChangeEventCustomAttributes:
6922
- description: Object representing custom change event attributes.
7041
+ additionalProperties: false
7042
+ description: Change event attributes.
6923
7043
  properties:
6924
7044
  author:
6925
7045
  $ref: '#/components/schemas/ChangeEventCustomAttributesAuthor'
6926
7046
  change_metadata:
6927
7047
  additionalProperties: {}
6928
- description: Free form object with information related to the `change` event.
6929
- Can be arbitrarily nested and contain any valid JSON.
7048
+ description: Free form JSON object with information related to the `change`
7049
+ event. Supports up to 100 properties per object and a maximum nesting
7050
+ depth of 10 levels.
6930
7051
  example:
6931
7052
  dd:
6932
7053
  team: datadog_team
@@ -6941,17 +7062,19 @@ components:
6941
7062
  description: 'A list of resources impacted by this change. It is recommended
6942
7063
  to provide an impacted resource to display
6943
7064
 
6944
- the change event at the right location. Only resources of type `service`
6945
- are supported.'
7065
+ the change event at the correct location. Only resources of type `service`
7066
+ are supported. Maximum of 100 impacted resources allowed.'
6946
7067
  example:
6947
7068
  - name: payments_api
6948
7069
  type: service
6949
7070
  items:
6950
7071
  $ref: '#/components/schemas/ChangeEventCustomAttributesImpactedResourcesItems'
7072
+ maxItems: 100
6951
7073
  type: array
6952
7074
  new_value:
6953
7075
  additionalProperties: {}
6954
- description: Free form object to track new value of the changed resource.
7076
+ description: Free form JSON object representing the new state of the changed
7077
+ resource.
6955
7078
  example:
6956
7079
  enabled: true
6957
7080
  percentage: 50%
@@ -6960,7 +7083,8 @@ components:
6960
7083
  type: object
6961
7084
  prev_value:
6962
7085
  additionalProperties: {}
6963
- description: Free form object to track previous value of the changed resource.
7086
+ description: Free form JSON object representing the previous state of the
7087
+ changed resource.
6964
7088
  example:
6965
7089
  enabled: true
6966
7090
  percentage: 10%
@@ -6971,13 +7095,16 @@ components:
6971
7095
  - changed_resource
6972
7096
  type: object
6973
7097
  ChangeEventCustomAttributesAuthor:
6974
- description: Object representing the entity which made the change. Optional
6975
- field but if provided should include `type` and `name`.
7098
+ additionalProperties: false
7099
+ description: The entity that made the change. Optional, if provided it must
7100
+ include `type` and `name`.
6976
7101
  properties:
6977
7102
  name:
6978
- description: Author's name. Limited to 128 characters.
6979
- example: datadog@datadog.com
7103
+ description: The name of the user or system that made the change. Limited
7104
+ to 128 characters.
7105
+ example: example@datadog.com
6980
7106
  maxLength: 128
7107
+ minLength: 1
6981
7108
  type: string
6982
7109
  type:
6983
7110
  $ref: '#/components/schemas/ChangeEventCustomAttributesAuthorType'
@@ -7000,11 +7127,14 @@ components:
7000
7127
  - API
7001
7128
  - AUTOMATION
7002
7129
  ChangeEventCustomAttributesChangedResource:
7003
- description: Object representing a uniquely identified resource.
7130
+ additionalProperties: false
7131
+ description: A uniquely identified resource.
7004
7132
  properties:
7005
7133
  name:
7006
- description: Resource's name.
7134
+ description: The name of the resource that was changed. Limited to 128 characters.
7007
7135
  example: fallback_payments_test
7136
+ maxLength: 128
7137
+ minLength: 1
7008
7138
  type: string
7009
7139
  type:
7010
7140
  $ref: '#/components/schemas/ChangeEventCustomAttributesChangedResourceType'
@@ -7013,7 +7143,7 @@ components:
7013
7143
  - name
7014
7144
  type: object
7015
7145
  ChangeEventCustomAttributesChangedResourceType:
7016
- description: Resource's type.
7146
+ description: The type of the resource that was changed.
7017
7147
  enum:
7018
7148
  - feature_flag
7019
7149
  - configuration
@@ -7023,12 +7153,14 @@ components:
7023
7153
  - FEATURE_FLAG
7024
7154
  - CONFIGURATION
7025
7155
  ChangeEventCustomAttributesImpactedResourcesItems:
7026
- description: Object representing a uniquely identified resource. Only the resource
7027
- type `service` is supported.
7156
+ additionalProperties: false
7157
+ description: Object representing a uniquely identified resource.
7028
7158
  properties:
7029
7159
  name:
7030
- description: Resource's name.
7160
+ description: The name of the impacted resource. Limited to 128 characters.
7031
7161
  example: payments_api
7162
+ maxLength: 128
7163
+ minLength: 1
7032
7164
  type: string
7033
7165
  type:
7034
7166
  $ref: '#/components/schemas/ChangeEventCustomAttributesImpactedResourcesItemsType'
@@ -7037,7 +7169,7 @@ components:
7037
7169
  - name
7038
7170
  type: object
7039
7171
  ChangeEventCustomAttributesImpactedResourcesItemsType:
7040
- description: Resource's type.
7172
+ description: The type of the impacted resource.
7041
7173
  enum:
7042
7174
  - service
7043
7175
  example: service
@@ -14679,28 +14811,33 @@ components:
14679
14811
  type: string
14680
14812
  type: object
14681
14813
  EventCategory:
14682
- description: Event category to identify the type of event. Only the value `change`
14683
- is supported. Support for other categories are coming. please reach out to
14684
- datadog support if you're interested.
14814
+ description: Event category identifying the type of event.
14685
14815
  enum:
14686
14816
  - change
14817
+ - alert
14687
14818
  example: change
14688
14819
  type: string
14689
14820
  x-enum-varnames:
14690
14821
  - CHANGE
14822
+ - ALERT
14691
14823
  EventCreateRequest:
14692
- description: Object representing an event creation request.
14824
+ description: An event object.
14693
14825
  properties:
14694
14826
  attributes:
14695
14827
  $ref: '#/components/schemas/EventPayload'
14696
14828
  type:
14697
14829
  $ref: '#/components/schemas/EventCreateRequestType'
14830
+ required:
14831
+ - type
14832
+ - attributes
14698
14833
  type: object
14699
14834
  EventCreateRequestPayload:
14700
14835
  description: Payload for creating an event.
14701
14836
  properties:
14702
14837
  data:
14703
14838
  $ref: '#/components/schemas/EventCreateRequest'
14839
+ required:
14840
+ - data
14704
14841
  type: object
14705
14842
  EventCreateRequestType:
14706
14843
  description: Entity type.
@@ -14711,24 +14848,23 @@ components:
14711
14848
  x-enum-varnames:
14712
14849
  - EVENT
14713
14850
  EventCreateResponse:
14714
- description: Object containing an event response.
14851
+ description: Event object.
14715
14852
  properties:
14716
14853
  attributes:
14717
14854
  $ref: '#/components/schemas/EventCreateResponseAttributes'
14718
14855
  type:
14719
- description: Event type
14856
+ description: Entity type.
14720
14857
  example: event
14721
14858
  type: string
14722
14859
  type: object
14723
14860
  EventCreateResponseAttributes:
14724
- description: JSON object containing all events attributes and their associated
14725
- values.
14861
+ description: Event attributes.
14726
14862
  properties:
14727
14863
  attributes:
14728
14864
  $ref: '#/components/schemas/EventCreateResponseAttributesAttributes'
14729
14865
  type: object
14730
14866
  EventCreateResponseAttributesAttributes:
14731
- description: JSON object of attributes from your events.
14867
+ description: JSON object for category-specific attributes.
14732
14868
  properties:
14733
14869
  evt:
14734
14870
  $ref: '#/components/schemas/EventCreateResponseAttributesAttributesEvt'
@@ -14737,41 +14873,71 @@ components:
14737
14873
  description: JSON object of event system attributes.
14738
14874
  properties:
14739
14875
  id:
14740
- description: Event id
14876
+ deprecated: true
14877
+ description: Event identifier. This field is deprecated and will be removed
14878
+ in a future version. Use the `uid` field instead.
14879
+ type: string
14880
+ uid:
14881
+ description: A unique identifier for the event. You can use this identifier
14882
+ to query or reference the event.
14741
14883
  type: string
14742
14884
  type: object
14743
14885
  EventCreateResponsePayload:
14744
- description: Response containing information about created event.
14886
+ description: Event creation response.
14745
14887
  properties:
14746
14888
  data:
14747
14889
  $ref: '#/components/schemas/EventCreateResponse'
14890
+ links:
14891
+ $ref: '#/components/schemas/EventCreateResponsePayloadLinks'
14892
+ type: object
14893
+ EventCreateResponsePayloadLinks:
14894
+ description: Links to the event.
14895
+ properties:
14896
+ self:
14897
+ description: The URL of the event. This link is only functional when using
14898
+ the default subdomain.
14899
+ type: string
14748
14900
  type: object
14749
14901
  EventPayload:
14902
+ additionalProperties: false
14750
14903
  description: Event attributes.
14751
14904
  properties:
14752
14905
  aggregation_key:
14753
- description: An arbitrary string to use for aggregation when correlating
14754
- events. Limited to 100 characters.
14906
+ description: A string used for aggregation when [correlating](https://docs.datadoghq.com/service_management/events/correlation/)
14907
+ events. If you specify a key, events are deduplicated to alerts based
14908
+ on this key. Limited to 100 characters.
14909
+ example: aggregation_key_123
14755
14910
  maxLength: 100
14911
+ minLength: 1
14756
14912
  type: string
14757
14913
  attributes:
14758
14914
  $ref: '#/components/schemas/EventPayloadAttributes'
14759
14915
  category:
14760
14916
  $ref: '#/components/schemas/EventCategory'
14917
+ integration_id:
14918
+ $ref: '#/components/schemas/EventPayloadIntegrationId'
14761
14919
  message:
14762
- description: The body of the event. Limited to 4000 characters.
14920
+ description: Free formed text associated with the event. It's suggested
14921
+ to use `data.attributes.attributes.custom` for well-structured attributes.
14922
+ Limited to 4000 characters.
14763
14923
  example: payment_processed feature flag has been enabled
14764
14924
  maxLength: 4000
14925
+ minLength: 1
14765
14926
  type: string
14766
14927
  tags:
14767
- description: 'A list of tags to apply to the event.
14928
+ description: 'A list of tags associated with the event. Maximum of 100 tags
14929
+ allowed.
14768
14930
 
14769
14931
  Refer to [Tags docs](https://docs.datadoghq.com/getting_started/tagging/).'
14770
14932
  example:
14771
- - env:test
14933
+ - env:api_client_test
14772
14934
  items:
14773
14935
  description: A tag.
14936
+ maxLength: 200
14937
+ minLength: 1
14774
14938
  type: string
14939
+ maxItems: 100
14940
+ minItems: 1
14775
14941
  type: array
14776
14942
  timestamp:
14777
14943
  description: 'Timestamp when the event occurred. Must follow [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html)
@@ -14783,9 +14949,10 @@ components:
14783
14949
  18 hours.'
14784
14950
  type: string
14785
14951
  title:
14786
- description: The event title. Limited to 500 characters.
14952
+ description: The title of the event. Limited to 500 characters.
14787
14953
  example: payment_processed feature flag updated
14788
14954
  maxLength: 500
14955
+ minLength: 1
14789
14956
  type: string
14790
14957
  required:
14791
14958
  - title
@@ -14793,10 +14960,19 @@ components:
14793
14960
  - attributes
14794
14961
  type: object
14795
14962
  EventPayloadAttributes:
14796
- description: JSON object for custom attributes. Schema are different per each
14797
- event category.
14963
+ description: JSON object for category-specific attributes. Schema is different
14964
+ per event category.
14798
14965
  oneOf:
14799
14966
  - $ref: '#/components/schemas/ChangeEventCustomAttributes'
14967
+ - $ref: '#/components/schemas/AlertEventCustomAttributes'
14968
+ EventPayloadIntegrationId:
14969
+ description: Integration ID sourced from integration manifests.
14970
+ enum:
14971
+ - custom-events
14972
+ example: custom-events
14973
+ type: string
14974
+ x-enum-varnames:
14975
+ - CUSTOM_EVENTS
14800
14976
  EventPriority:
14801
14977
  description: The priority of the event's monitor. For example, `normal` or `low`.
14802
14978
  enum:
@@ -15992,6 +16168,12 @@ components:
15992
16168
  data:
15993
16169
  $ref: '#/components/schemas/ActionConnectionData'
15994
16170
  type: object
16171
+ GetAppKeyRegistrationResponse:
16172
+ description: The response object after getting an app key registration.
16173
+ properties:
16174
+ data:
16175
+ $ref: '#/components/schemas/AppKeyRegistrationData'
16176
+ type: object
15995
16177
  GetAppResponse:
15996
16178
  description: The full app definition response object.
15997
16179
  properties:
@@ -17271,6 +17453,10 @@ components:
17271
17453
  items:
17272
17454
  $ref: '#/components/schemas/IncidentTimelineCellCreateAttributes'
17273
17455
  type: array
17456
+ is_test:
17457
+ description: A flag indicating whether the incident is a test incident.
17458
+ example: false
17459
+ type: boolean
17274
17460
  notification_handles:
17275
17461
  description: Notification handles that will be notified of the incident
17276
17462
  at creation.
@@ -17676,6 +17862,10 @@ components:
17676
17862
  description: A unique identifier that represents an incident type.
17677
17863
  example: 00000000-0000-0000-0000-000000000000
17678
17864
  type: string
17865
+ is_test:
17866
+ description: A flag indicating whether the incident is a test incident.
17867
+ example: false
17868
+ type: boolean
17679
17869
  modified:
17680
17870
  description: Timestamp when the incident was last modified.
17681
17871
  format: date-time
@@ -19402,12 +19592,6 @@ components:
19402
19592
  JobDefinitionFromRule:
19403
19593
  description: Definition of a historical job based on a security monitoring rule.
19404
19594
  properties:
19405
- caseIndex:
19406
- description: Index of the rule case applied by the job.
19407
- example: 0
19408
- format: int32
19409
- maximum: 9
19410
- type: integer
19411
19595
  from:
19412
19596
  description: Starting time of data analyzed by the job.
19413
19597
  example: 1729843470000
@@ -19438,7 +19622,6 @@ components:
19438
19622
  - from
19439
19623
  - to
19440
19624
  - index
19441
- - caseIndex
19442
19625
  type: object
19443
19626
  KindAttributes:
19444
19627
  description: Kind attributes.
@@ -19770,6 +19953,32 @@ components:
19770
19953
  format: int64
19771
19954
  type: integer
19772
19955
  type: object
19956
+ ListAppKeyRegistrationsResponse:
19957
+ description: A paginated list of app key registrations.
19958
+ properties:
19959
+ data:
19960
+ description: An array of app key registrations.
19961
+ items:
19962
+ $ref: '#/components/schemas/AppKeyRegistrationData'
19963
+ type: array
19964
+ meta:
19965
+ $ref: '#/components/schemas/ListAppKeyRegistrationsResponseMeta'
19966
+ type: object
19967
+ ListAppKeyRegistrationsResponseMeta:
19968
+ description: The definition of `ListAppKeyRegistrationsResponseMeta` object.
19969
+ properties:
19970
+ total:
19971
+ description: The total number of app key registrations.
19972
+ example: 1
19973
+ format: int64
19974
+ type: integer
19975
+ total_filtered:
19976
+ description: The total number of app key registrations that match the specified
19977
+ filters.
19978
+ example: 1
19979
+ format: int64
19980
+ type: integer
19981
+ type: object
19773
19982
  ListApplicationKeysResponse:
19774
19983
  description: Response for a list of application keys.
19775
19984
  properties:
@@ -23664,6 +23873,278 @@ components:
23664
23873
  description: The monitor type.
23665
23874
  type: string
23666
23875
  type: object
23876
+ MonitorUserTemplate:
23877
+ additionalProperties: {}
23878
+ description: A monitor user template object.
23879
+ properties:
23880
+ created:
23881
+ $ref: '#/components/schemas/MonitorUserTemplateCreated'
23882
+ description:
23883
+ $ref: '#/components/schemas/MonitorUserTemplateDescription'
23884
+ modified:
23885
+ $ref: '#/components/schemas/MonitorUserTemplateModified'
23886
+ monitor_definition:
23887
+ additionalProperties: {}
23888
+ description: A valid monitor definition in the same format as the [V1 Monitor
23889
+ API](https://docs.datadoghq.com/api/latest/monitors/#create-a-monitor).
23890
+ example:
23891
+ message: You may need to add web hosts if this is consistently high.
23892
+ name: Bytes received on host0
23893
+ query: avg(last_5m):sum:system.net.bytes_rcvd{host:host0} > 100
23894
+ type: query alert
23895
+ type: object
23896
+ tags:
23897
+ $ref: '#/components/schemas/MonitorUserTemplateTags'
23898
+ template_variables:
23899
+ $ref: '#/components/schemas/MonitorUserTemplateTemplateVariables'
23900
+ title:
23901
+ $ref: '#/components/schemas/MonitorUserTemplateTitle'
23902
+ version:
23903
+ $ref: '#/components/schemas/MonitorUserTemplateVersion'
23904
+ versions:
23905
+ description: All versions of the monitor user template.
23906
+ items:
23907
+ $ref: '#/components/schemas/SimpleMonitorUserTemplate'
23908
+ type: array
23909
+ type: object
23910
+ MonitorUserTemplateCreateData:
23911
+ description: Monitor user template data.
23912
+ properties:
23913
+ attributes:
23914
+ $ref: '#/components/schemas/MonitorUserTemplateRequestAttributes'
23915
+ type:
23916
+ $ref: '#/components/schemas/MonitorUserTemplateResourceType'
23917
+ required:
23918
+ - type
23919
+ - attributes
23920
+ type: object
23921
+ MonitorUserTemplateCreateRequest:
23922
+ description: Request for creating a monitor user template.
23923
+ properties:
23924
+ data:
23925
+ $ref: '#/components/schemas/MonitorUserTemplateCreateData'
23926
+ required:
23927
+ - data
23928
+ type: object
23929
+ MonitorUserTemplateCreateResponse:
23930
+ description: Response for creating a monitor user template.
23931
+ properties:
23932
+ data:
23933
+ $ref: '#/components/schemas/MonitorUserTemplateResponseData'
23934
+ type: object
23935
+ MonitorUserTemplateCreated:
23936
+ description: The created timestamp of the template.
23937
+ example: '2024-01-02T03:04:23.274966+00:00'
23938
+ format: date-time
23939
+ readOnly: true
23940
+ type: string
23941
+ MonitorUserTemplateDescription:
23942
+ description: A brief description of the monitor user template.
23943
+ example: This is a template for monitoring user activity.
23944
+ nullable: true
23945
+ type: string
23946
+ MonitorUserTemplateId:
23947
+ description: The unique identifier.
23948
+ example: 00000000-0000-1234-0000-000000000000
23949
+ type: string
23950
+ MonitorUserTemplateListResponse:
23951
+ description: Response for retrieving all monitor user templates.
23952
+ properties:
23953
+ data:
23954
+ description: An array of monitor user templates.
23955
+ items:
23956
+ $ref: '#/components/schemas/MonitorUserTemplateResponseData'
23957
+ type: array
23958
+ type: object
23959
+ MonitorUserTemplateModified:
23960
+ description: The last modified timestamp. When the template version was created.
23961
+ example: '2024-02-02T03:04:23.274966+00:00'
23962
+ format: date-time
23963
+ readOnly: true
23964
+ type: string
23965
+ MonitorUserTemplateRequestAttributes:
23966
+ additionalProperties: false
23967
+ description: Attributes for a monitor user template.
23968
+ properties:
23969
+ description:
23970
+ $ref: '#/components/schemas/MonitorUserTemplateDescription'
23971
+ monitor_definition:
23972
+ additionalProperties: {}
23973
+ description: A valid monitor definition in the same format as the [V1 Monitor
23974
+ API](https://docs.datadoghq.com/api/latest/monitors/#create-a-monitor).
23975
+ example:
23976
+ message: You may need to add web hosts if this is consistently high.
23977
+ name: Bytes received on host0
23978
+ query: avg(last_5m):sum:system.net.bytes_rcvd{host:host0} > 100
23979
+ type: query alert
23980
+ type: object
23981
+ tags:
23982
+ $ref: '#/components/schemas/MonitorUserTemplateTags'
23983
+ template_variables:
23984
+ $ref: '#/components/schemas/MonitorUserTemplateTemplateVariables'
23985
+ title:
23986
+ $ref: '#/components/schemas/MonitorUserTemplateTitle'
23987
+ required:
23988
+ - title
23989
+ - monitor_definition
23990
+ - tags
23991
+ type: object
23992
+ MonitorUserTemplateResourceType:
23993
+ default: monitor-user-template
23994
+ description: Monitor user template resource type.
23995
+ enum:
23996
+ - monitor-user-template
23997
+ example: monitor-user-template
23998
+ type: string
23999
+ x-enum-varnames:
24000
+ - MONITOR_USER_TEMPLATE
24001
+ MonitorUserTemplateResponse:
24002
+ description: Response for retrieving a monitor user template.
24003
+ properties:
24004
+ data:
24005
+ $ref: '#/components/schemas/MonitorUserTemplateResponseDataWithVersions'
24006
+ type: object
24007
+ MonitorUserTemplateResponseAttributes:
24008
+ additionalProperties: {}
24009
+ description: Attributes for a monitor user template.
24010
+ properties:
24011
+ created:
24012
+ $ref: '#/components/schemas/MonitorUserTemplateCreated'
24013
+ description:
24014
+ $ref: '#/components/schemas/MonitorUserTemplateDescription'
24015
+ modified:
24016
+ $ref: '#/components/schemas/MonitorUserTemplateModified'
24017
+ monitor_definition:
24018
+ additionalProperties: {}
24019
+ description: A valid monitor definition in the same format as the [V1 Monitor
24020
+ API](https://docs.datadoghq.com/api/latest/monitors/#create-a-monitor).
24021
+ example:
24022
+ message: You may need to add web hosts if this is consistently high.
24023
+ name: Bytes received on host0
24024
+ query: avg(last_5m):sum:system.net.bytes_rcvd{host:host0} > 100
24025
+ type: query alert
24026
+ type: object
24027
+ tags:
24028
+ $ref: '#/components/schemas/MonitorUserTemplateTags'
24029
+ template_variables:
24030
+ $ref: '#/components/schemas/MonitorUserTemplateTemplateVariables'
24031
+ title:
24032
+ $ref: '#/components/schemas/MonitorUserTemplateTitle'
24033
+ version:
24034
+ $ref: '#/components/schemas/MonitorUserTemplateVersion'
24035
+ type: object
24036
+ MonitorUserTemplateResponseData:
24037
+ description: Monitor user template list response data.
24038
+ properties:
24039
+ attributes:
24040
+ $ref: '#/components/schemas/MonitorUserTemplateResponseAttributes'
24041
+ id:
24042
+ $ref: '#/components/schemas/MonitorUserTemplateId'
24043
+ type:
24044
+ $ref: '#/components/schemas/MonitorUserTemplateResourceType'
24045
+ type: object
24046
+ MonitorUserTemplateResponseDataWithVersions:
24047
+ description: Monitor user template data.
24048
+ properties:
24049
+ attributes:
24050
+ $ref: '#/components/schemas/MonitorUserTemplate'
24051
+ id:
24052
+ $ref: '#/components/schemas/MonitorUserTemplateId'
24053
+ type:
24054
+ $ref: '#/components/schemas/MonitorUserTemplateResourceType'
24055
+ type: object
24056
+ MonitorUserTemplateTags:
24057
+ description: The definition of `MonitorUserTemplateTags` object.
24058
+ example:
24059
+ - product:Our Custom App
24060
+ - integration:Azure
24061
+ items:
24062
+ description: 'Tags associated with the monitor user template. Must be key
24063
+ value. Only ''product'' and ''integration'' keys are
24064
+
24065
+ allowed. The value is the name of the category to display the template under.
24066
+ Integrations can be filtered out in the UI.
24067
+
24068
+ (Review note: This modeling of ''categories'' is subject to change.)'
24069
+ example: us-east1
24070
+ minLength: 1
24071
+ type: string
24072
+ uniqueItems: true
24073
+ type: array
24074
+ MonitorUserTemplateTemplateVariables:
24075
+ description: The definition of `MonitorUserTemplateTemplateVariables` object.
24076
+ items:
24077
+ $ref: '#/components/schemas/MonitorUserTemplateTemplateVariablesItems'
24078
+ type: array
24079
+ MonitorUserTemplateTemplateVariablesItems:
24080
+ additionalProperties: false
24081
+ description: List of objects representing template variables on the monitor
24082
+ which can have selectable values.
24083
+ properties:
24084
+ available_values:
24085
+ description: Available values for the variable.
24086
+ example:
24087
+ - value1
24088
+ - value2
24089
+ items:
24090
+ minLength: 1
24091
+ type: string
24092
+ uniqueItems: true
24093
+ type: array
24094
+ defaults:
24095
+ description: Default values of the template variable.
24096
+ example:
24097
+ - defaultValue
24098
+ items:
24099
+ minLength: 0
24100
+ type: string
24101
+ uniqueItems: true
24102
+ type: array
24103
+ name:
24104
+ description: The name of the template variable.
24105
+ example: regionName
24106
+ type: string
24107
+ tag_key:
24108
+ description: The tag key associated with the variable. This works the same
24109
+ as dashboard template variables.
24110
+ example: datacenter
24111
+ type: string
24112
+ required:
24113
+ - name
24114
+ type: object
24115
+ MonitorUserTemplateTitle:
24116
+ description: The title of the monitor user template.
24117
+ example: Postgres CPU Monitor
24118
+ type: string
24119
+ MonitorUserTemplateUpdateData:
24120
+ description: Monitor user template data.
24121
+ properties:
24122
+ attributes:
24123
+ $ref: '#/components/schemas/MonitorUserTemplateRequestAttributes'
24124
+ id:
24125
+ $ref: '#/components/schemas/MonitorUserTemplateId'
24126
+ type:
24127
+ $ref: '#/components/schemas/MonitorUserTemplateResourceType'
24128
+ required:
24129
+ - id
24130
+ - type
24131
+ - attributes
24132
+ type: object
24133
+ MonitorUserTemplateUpdateRequest:
24134
+ description: Request for creating a new monitor user template version.
24135
+ properties:
24136
+ data:
24137
+ $ref: '#/components/schemas/MonitorUserTemplateUpdateData'
24138
+ required:
24139
+ - data
24140
+ type: object
24141
+ MonitorUserTemplateVersion:
24142
+ description: The version of the monitor user template.
24143
+ example: 0
24144
+ format: int64
24145
+ nullable: true
24146
+ readOnly: true
24147
+ type: integer
23667
24148
  MonthlyCostAttributionAttributes:
23668
24149
  description: Cost Attribution by Tag for a given organization.
23669
24150
  properties:
@@ -29407,6 +29888,12 @@ components:
29407
29888
  x-enum-varnames:
29408
29889
  - ANY
29409
29890
  - ALL
29891
+ RegisterAppKeyResponse:
29892
+ description: The response object after creating an app key registration.
29893
+ properties:
29894
+ data:
29895
+ $ref: '#/components/schemas/AppKeyRegistrationData'
29896
+ type: object
29410
29897
  RelationAttributes:
29411
29898
  description: Relation attributes.
29412
29899
  properties:
@@ -36839,6 +37326,37 @@ components:
36839
37326
  description: The definition of `ShiftIncluded` object.
36840
37327
  oneOf:
36841
37328
  - $ref: '#/components/schemas/ScheduleUser'
37329
+ SimpleMonitorUserTemplate:
37330
+ description: A simplified version of a monitor user template.
37331
+ properties:
37332
+ created:
37333
+ $ref: '#/components/schemas/MonitorUserTemplateCreated'
37334
+ description:
37335
+ $ref: '#/components/schemas/MonitorUserTemplateDescription'
37336
+ id:
37337
+ description: The unique identifier. The initial version will match the template
37338
+ ID.
37339
+ example: 00000000-0000-1234-0000-000000000000
37340
+ type: string
37341
+ monitor_definition:
37342
+ additionalProperties: {}
37343
+ description: A valid monitor definition in the same format as the [V1 Monitor
37344
+ API](https://docs.datadoghq.com/api/latest/monitors/#create-a-monitor).
37345
+ example:
37346
+ message: You may need to add web hosts if this is consistently high.
37347
+ name: Bytes received on host0
37348
+ query: avg(last_5m):sum:system.net.bytes_rcvd{host:host0} > 100
37349
+ type: query alert
37350
+ type: object
37351
+ tags:
37352
+ $ref: '#/components/schemas/MonitorUserTemplateTags'
37353
+ template_variables:
37354
+ $ref: '#/components/schemas/MonitorUserTemplateTemplateVariables'
37355
+ title:
37356
+ $ref: '#/components/schemas/MonitorUserTemplateTitle'
37357
+ version:
37358
+ $ref: '#/components/schemas/MonitorUserTemplateVersion'
37359
+ type: object
36842
37360
  SingleAggregatedConnectionResponseArray:
36843
37361
  description: List of aggregated connections.
36844
37362
  example:
@@ -41440,9 +41958,185 @@ info:
41440
41958
  version: '1.0'
41441
41959
  openapi: 3.0.0
41442
41960
  paths:
41961
+ /api/v2/actions/app_key_registrations:
41962
+ get:
41963
+ description: List App Key Registrations
41964
+ operationId: ListAppKeyRegistrations
41965
+ parameters:
41966
+ - description: The number of App Key Registrations to return per page.
41967
+ in: query
41968
+ name: page[size]
41969
+ required: false
41970
+ schema:
41971
+ format: int64
41972
+ type: integer
41973
+ - description: The page number to return.
41974
+ in: query
41975
+ name: page[number]
41976
+ required: false
41977
+ schema:
41978
+ format: int64
41979
+ type: integer
41980
+ responses:
41981
+ '200':
41982
+ content:
41983
+ application/json:
41984
+ schema:
41985
+ $ref: '#/components/schemas/ListAppKeyRegistrationsResponse'
41986
+ description: OK
41987
+ '400':
41988
+ content:
41989
+ application/json:
41990
+ schema:
41991
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
41992
+ description: Bad request
41993
+ '403':
41994
+ content:
41995
+ application/json:
41996
+ schema:
41997
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
41998
+ description: Forbidden
41999
+ '429':
42000
+ content:
42001
+ application/json:
42002
+ schema:
42003
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
42004
+ description: Too many requests
42005
+ summary: List App Key Registrations
42006
+ tags:
42007
+ - Action Connection
42008
+ x-permission:
42009
+ operator: OR
42010
+ permissions:
42011
+ - org_app_keys_read
42012
+ /api/v2/actions/app_key_registrations/{app_key_id}:
42013
+ delete:
42014
+ description: Unregister an App Key
42015
+ operationId: UnregisterAppKey
42016
+ parameters:
42017
+ - $ref: '#/components/parameters/ApplicationKeyId'
42018
+ responses:
42019
+ '204':
42020
+ description: No Content
42021
+ '400':
42022
+ content:
42023
+ application/json:
42024
+ schema:
42025
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
42026
+ description: Bad request
42027
+ '403':
42028
+ content:
42029
+ application/json:
42030
+ schema:
42031
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
42032
+ description: Forbidden
42033
+ '404':
42034
+ content:
42035
+ application/json:
42036
+ schema:
42037
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
42038
+ description: Not found
42039
+ '429':
42040
+ content:
42041
+ application/json:
42042
+ schema:
42043
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
42044
+ description: Too many requests
42045
+ summary: Unregister an App Key
42046
+ tags:
42047
+ - Action Connection
42048
+ x-permission:
42049
+ operator: OR
42050
+ permissions:
42051
+ - user_access_manage
42052
+ - user_app_keys
42053
+ - service_account_write
42054
+ get:
42055
+ description: Get an existing App Key Registration
42056
+ operationId: GetAppKeyRegistration
42057
+ parameters:
42058
+ - $ref: '#/components/parameters/ApplicationKeyId'
42059
+ responses:
42060
+ '200':
42061
+ content:
42062
+ application/json:
42063
+ schema:
42064
+ $ref: '#/components/schemas/GetAppKeyRegistrationResponse'
42065
+ description: OK
42066
+ '400':
42067
+ content:
42068
+ application/json:
42069
+ schema:
42070
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
42071
+ description: Bad request
42072
+ '403':
42073
+ content:
42074
+ application/json:
42075
+ schema:
42076
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
42077
+ description: Forbidden
42078
+ '404':
42079
+ content:
42080
+ application/json:
42081
+ schema:
42082
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
42083
+ description: Not found
42084
+ '429':
42085
+ content:
42086
+ application/json:
42087
+ schema:
42088
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
42089
+ description: Too many requests
42090
+ summary: Get an existing App Key Registration
42091
+ tags:
42092
+ - Action Connection
42093
+ x-permission:
42094
+ operator: OR
42095
+ permissions:
42096
+ - org_app_keys_read
42097
+ put:
42098
+ description: Register a new App Key
42099
+ operationId: RegisterAppKey
42100
+ parameters:
42101
+ - $ref: '#/components/parameters/ApplicationKeyId'
42102
+ responses:
42103
+ '201':
42104
+ content:
42105
+ application/json:
42106
+ schema:
42107
+ $ref: '#/components/schemas/RegisterAppKeyResponse'
42108
+ description: Created
42109
+ '400':
42110
+ content:
42111
+ application/json:
42112
+ schema:
42113
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
42114
+ description: Bad request
42115
+ '403':
42116
+ content:
42117
+ application/json:
42118
+ schema:
42119
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
42120
+ description: Forbidden
42121
+ '429':
42122
+ content:
42123
+ application/json:
42124
+ schema:
42125
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
42126
+ description: Too many requests
42127
+ summary: Register a new App Key
42128
+ tags:
42129
+ - Action Connection
42130
+ x-permission:
42131
+ operator: OR
42132
+ permissions:
42133
+ - user_access_manage
42134
+ - user_app_keys
42135
+ - service_account_write
41443
42136
  /api/v2/actions/connections:
41444
42137
  post:
41445
- description: Create a new Action Connection
42138
+ description: Create a new Action Connection. This API requires a [registered
42139
+ application key](https://docs.datadoghq.com/api/latest/action-connection/#register-a-new-app-key).
41446
42140
  operationId: CreateActionConnection
41447
42141
  requestBody:
41448
42142
  content:
@@ -41480,7 +42174,8 @@ paths:
41480
42174
  - Action Connection
41481
42175
  /api/v2/actions/connections/{connection_id}:
41482
42176
  delete:
41483
- description: Delete an existing Action Connection
42177
+ description: Delete an existing Action Connection. This API requires a [registered
42178
+ application key](https://docs.datadoghq.com/api/latest/action-connection/#register-a-new-app-key).
41484
42179
  operationId: DeleteActionConnection
41485
42180
  parameters:
41486
42181
  - $ref: '#/components/parameters/ConnectionId'
@@ -41513,7 +42208,8 @@ paths:
41513
42208
  permissions:
41514
42209
  - connection_write
41515
42210
  get:
41516
- description: Get an existing Action Connection
42211
+ description: Get an existing Action Connection. This API requires a [registered
42212
+ application key](https://docs.datadoghq.com/api/latest/action-connection/#register-a-new-app-key).
41517
42213
  operationId: GetActionConnection
41518
42214
  parameters:
41519
42215
  - $ref: '#/components/parameters/ConnectionId'
@@ -41552,7 +42248,8 @@ paths:
41552
42248
  tags:
41553
42249
  - Action Connection
41554
42250
  patch:
41555
- description: Update an existing Action Connection
42251
+ description: Update an existing Action Connection. This API requires a [registered
42252
+ application key](https://docs.datadoghq.com/api/latest/action-connection/#register-a-new-app-key).
41556
42253
  operationId: UpdateActionConnection
41557
42254
  parameters:
41558
42255
  - $ref: '#/components/parameters/ConnectionId'
@@ -42582,6 +43279,7 @@ paths:
42582
43279
  /api/v2/app-builder/apps:
42583
43280
  delete:
42584
43281
  description: Delete multiple apps in a single request from a list of app IDs.
43282
+ This API requires a [registered application key](https://docs.datadoghq.com/api/latest/action-connection/#register-a-new-app-key).
42585
43283
  operationId: DeleteApps
42586
43284
  requestBody:
42587
43285
  content:
@@ -42626,7 +43324,8 @@ paths:
42626
43324
  get:
42627
43325
  description: List all apps, with optional filters and sorting. This endpoint
42628
43326
  is paginated. Only basic app information such as the app ID, name, and description
42629
- is returned by this endpoint.
43327
+ is returned by this endpoint. This API requires a [registered application
43328
+ key](https://docs.datadoghq.com/api/latest/action-connection/#register-a-new-app-key).
42630
43329
  operationId: ListApps
42631
43330
  parameters:
42632
43331
  - description: The number of apps to return per page.
@@ -42732,7 +43431,8 @@ paths:
42732
43431
  permissions:
42733
43432
  - apps_run
42734
43433
  post:
42735
- description: Create a new app, returning the app ID.
43434
+ description: Create a new app, returning the app ID. This API requires a [registered
43435
+ application key](https://docs.datadoghq.com/api/latest/action-connection/#register-a-new-app-key).
42736
43436
  operationId: CreateApp
42737
43437
  requestBody:
42738
43438
  content:
@@ -42772,7 +43472,8 @@ paths:
42772
43472
  - workflows_run
42773
43473
  /api/v2/app-builder/apps/{app_id}:
42774
43474
  delete:
42775
- description: Delete a single app.
43475
+ description: Delete a single app. This API requires a [registered application
43476
+ key](https://docs.datadoghq.com/api/latest/action-connection/#register-a-new-app-key).
42776
43477
  operationId: DeleteApp
42777
43478
  parameters:
42778
43479
  - description: The ID of the app to delete.
@@ -42824,7 +43525,8 @@ paths:
42824
43525
  permissions:
42825
43526
  - apps_write
42826
43527
  get:
42827
- description: Get the full definition of an app.
43528
+ description: Get the full definition of an app. This API requires a [registered
43529
+ application key](https://docs.datadoghq.com/api/latest/action-connection/#register-a-new-app-key).
42828
43530
  operationId: GetApp
42829
43531
  parameters:
42830
43532
  - description: The ID of the app to retrieve.
@@ -42887,6 +43589,7 @@ paths:
42887
43589
  - connections_read
42888
43590
  patch:
42889
43591
  description: Update an existing app. This creates a new version of the app.
43592
+ This API requires a [registered application key](https://docs.datadoghq.com/api/latest/action-connection/#register-a-new-app-key).
42890
43593
  operationId: UpdateApp
42891
43594
  parameters:
42892
43595
  - description: The ID of the app to update.
@@ -42938,7 +43641,8 @@ paths:
42938
43641
  description: Unpublish an app, removing the live version of the app. Unpublishing
42939
43642
  creates a new instance of a `deployment` object on the app, with a nil `app_version_id`
42940
43643
  (`00000000-0000-0000-0000-000000000000`). The app can still be updated and
42941
- published again in the future.
43644
+ published again in the future. This API requires a [registered application
43645
+ key](https://docs.datadoghq.com/api/latest/action-connection/#register-a-new-app-key).
42942
43646
  operationId: UnpublishApp
42943
43647
  parameters:
42944
43648
  - description: The ID of the app to unpublish.
@@ -42986,7 +43690,8 @@ paths:
42986
43690
  post:
42987
43691
  description: Publish an app for use by other users. To ensure the app is accessible
42988
43692
  to the correct users, you also need to set a [Restriction Policy](https://docs.datadoghq.com/api/latest/restriction-policies/)
42989
- on the app if a policy does not yet exist.
43693
+ on the app if a policy does not yet exist. This API requires a [registered
43694
+ application key](https://docs.datadoghq.com/api/latest/action-connection/#register-a-new-app-key).
42990
43695
  operationId: PublishApp
42991
43696
  parameters:
42992
43697
  - description: The ID of the app to publish.
@@ -47159,10 +47864,15 @@ paths:
47159
47864
  permissions:
47160
47865
  - events_read
47161
47866
  post:
47162
- description: "This endpoint allows you to post events.\n\n\u2705 **Only events
47163
- with the `change` category** are in General Availability. See [Change Tracking](https://docs.datadoghq.com/change_tracking)
47867
+ description: "This endpoint allows you to publish events.\n\n\u2705 **Only events
47868
+ with the `change` or `alert` category** are in General Availability. For change
47869
+ events, see [Change Tracking](https://docs.datadoghq.com/change_tracking)
47164
47870
  for more details.\n\n\u274C For use cases involving other event categories,
47165
- please use the V1 endpoint."
47871
+ use the V1 endpoint or reach out to [support](https://www.datadoghq.com/support/).\n\n\u274C
47872
+ Notifications are not yet supported for events sent to this endpoint. Use
47873
+ the V1 endpoint for notification functionality.\n\n\u274C This endpoint is
47874
+ not available for the Government (US1-FED) site. Contact your account representative
47875
+ for more information."
47166
47876
  operationId: CreateEvent
47167
47877
  requestBody:
47168
47878
  content:
@@ -47172,9 +47882,10 @@ paths:
47172
47882
  value:
47173
47883
  data:
47174
47884
  attributes:
47885
+ aggregation_key: aggregation_key_123
47175
47886
  attributes:
47176
47887
  author:
47177
- name: datadog@datadog.com
47888
+ name: example@datadog.com
47178
47889
  type: user
47179
47890
  change_metadata:
47180
47891
  dd:
@@ -47200,17 +47911,19 @@ paths:
47200
47911
  rule:
47201
47912
  datacenter: devcycle.us1.prod
47202
47913
  category: change
47914
+ integration_id: custom-events
47203
47915
  message: payment_processed feature flag has been enabled
47204
47916
  tags:
47205
- - env:test
47917
+ - env:api_client_test
47918
+ timestamp: '2020-01-01T01:30:15.010000Z'
47206
47919
  title: payment_processed feature flag updated
47207
47920
  type: event
47208
47921
  schema:
47209
47922
  $ref: '#/components/schemas/EventCreateRequestPayload'
47210
- description: Event request object
47923
+ description: Event creation request payload.
47211
47924
  required: true
47212
47925
  responses:
47213
- '200':
47926
+ '202':
47214
47927
  content:
47215
47928
  application/json:
47216
47929
  schema:
@@ -47233,6 +47946,38 @@ paths:
47233
47946
  security:
47234
47947
  - apiKeyAuth: []
47235
47948
  appKeyAuth: []
47949
+ servers:
47950
+ - url: https://{subdomain}.{site}
47951
+ variables:
47952
+ site:
47953
+ default: datadoghq.com
47954
+ description: The regional site for customers.
47955
+ enum:
47956
+ - datadoghq.com
47957
+ - us3.datadoghq.com
47958
+ - us5.datadoghq.com
47959
+ - ap1.datadoghq.com
47960
+ - datadoghq.eu
47961
+ - ddog-gov.com
47962
+ subdomain:
47963
+ default: event-management-intake
47964
+ description: The subdomain where the API is deployed.
47965
+ - url: '{protocol}://{name}'
47966
+ variables:
47967
+ name:
47968
+ default: event-management-intake.datadoghq.com
47969
+ description: Full site DNS name.
47970
+ protocol:
47971
+ default: https
47972
+ description: The protocol for accessing the API.
47973
+ - url: https://{subdomain}.{site}
47974
+ variables:
47975
+ site:
47976
+ default: datadoghq.com
47977
+ description: Any Datadog deployment.
47978
+ subdomain:
47979
+ default: event-management-intake
47980
+ description: The subdomain where the API is deployed.
47236
47981
  summary: Post an event
47237
47982
  tags:
47238
47983
  - Events
@@ -52384,6 +53129,270 @@ paths:
52384
53129
  operator: OR
52385
53130
  permissions:
52386
53131
  - monitor_config_policy_write
53132
+ /api/v2/monitor/template:
53133
+ get:
53134
+ description: Retrieve all monitor user templates.
53135
+ operationId: ListMonitorUserTemplates
53136
+ responses:
53137
+ '200':
53138
+ content:
53139
+ application/json:
53140
+ schema:
53141
+ $ref: '#/components/schemas/MonitorUserTemplateListResponse'
53142
+ description: OK
53143
+ '429':
53144
+ $ref: '#/components/responses/TooManyRequestsResponse'
53145
+ security:
53146
+ - apiKeyAuth: []
53147
+ appKeyAuth: []
53148
+ - AuthZ:
53149
+ - monitors_read
53150
+ summary: Get all monitor user templates
53151
+ tags:
53152
+ - Monitors
53153
+ x-unstable: '**Note**: This endpoint is in Preview. If you have any feedback,
53154
+
53155
+ contact [Datadog support](https://docs.datadoghq.com/help/).'
53156
+ post:
53157
+ description: Create a new monitor user template.
53158
+ operationId: CreateMonitorUserTemplate
53159
+ requestBody:
53160
+ content:
53161
+ application/json:
53162
+ schema:
53163
+ $ref: '#/components/schemas/MonitorUserTemplateCreateRequest'
53164
+ required: true
53165
+ responses:
53166
+ '200':
53167
+ content:
53168
+ application/json:
53169
+ schema:
53170
+ $ref: '#/components/schemas/MonitorUserTemplateCreateResponse'
53171
+ description: OK
53172
+ '400':
53173
+ content:
53174
+ application/json:
53175
+ schema:
53176
+ $ref: '#/components/schemas/APIErrorResponse'
53177
+ description: Bad Request
53178
+ '429':
53179
+ $ref: '#/components/responses/TooManyRequestsResponse'
53180
+ security:
53181
+ - apiKeyAuth: []
53182
+ appKeyAuth: []
53183
+ - AuthZ:
53184
+ - monitor_config_policy_write
53185
+ summary: Create a monitor user template
53186
+ tags:
53187
+ - Monitors
53188
+ x-unstable: '**Note**: This endpoint is in Preview. If you have any feedback,
53189
+
53190
+ contact [Datadog support](https://docs.datadoghq.com/help/).'
53191
+ /api/v2/monitor/template/validate:
53192
+ post:
53193
+ description: Validate the structure and content of a monitor user template.
53194
+ operationId: ValidateMonitorUserTemplate
53195
+ requestBody:
53196
+ content:
53197
+ application/json:
53198
+ schema:
53199
+ $ref: '#/components/schemas/MonitorUserTemplateCreateRequest'
53200
+ required: true
53201
+ responses:
53202
+ '204':
53203
+ description: OK
53204
+ '400':
53205
+ content:
53206
+ application/json:
53207
+ schema:
53208
+ $ref: '#/components/schemas/APIErrorResponse'
53209
+ description: Bad Request
53210
+ '429':
53211
+ $ref: '#/components/responses/TooManyRequestsResponse'
53212
+ security:
53213
+ - apiKeyAuth: []
53214
+ appKeyAuth: []
53215
+ - AuthZ:
53216
+ - monitor_config_policy_write
53217
+ summary: Validate a monitor user template
53218
+ tags:
53219
+ - Monitors
53220
+ x-unstable: '**Note**: This endpoint is in Preview. If you have any feedback,
53221
+
53222
+ contact [Datadog support](https://docs.datadoghq.com/help/).'
53223
+ /api/v2/monitor/template/{template_id}:
53224
+ delete:
53225
+ description: Delete an existing monitor user template by its ID.
53226
+ operationId: DeleteMonitorUserTemplate
53227
+ parameters:
53228
+ - description: ID of the monitor user template.
53229
+ in: path
53230
+ name: template_id
53231
+ required: true
53232
+ schema:
53233
+ type: string
53234
+ responses:
53235
+ '204':
53236
+ description: OK
53237
+ '404':
53238
+ content:
53239
+ application/json:
53240
+ schema:
53241
+ $ref: '#/components/schemas/APIErrorResponse'
53242
+ description: Not Found
53243
+ '429':
53244
+ $ref: '#/components/responses/TooManyRequestsResponse'
53245
+ security:
53246
+ - apiKeyAuth: []
53247
+ appKeyAuth: []
53248
+ - AuthZ:
53249
+ - monitor_config_policy_write
53250
+ summary: Delete a monitor user template
53251
+ tags:
53252
+ - Monitors
53253
+ x-unstable: '**Note**: This endpoint is in Preview. If you have any feedback,
53254
+
53255
+ contact [Datadog support](https://docs.datadoghq.com/help/).'
53256
+ get:
53257
+ description: Retrieve a monitor user template by its ID.
53258
+ operationId: GetMonitorUserTemplate
53259
+ parameters:
53260
+ - description: ID of the monitor user template.
53261
+ in: path
53262
+ name: template_id
53263
+ required: true
53264
+ schema:
53265
+ example: 00000000-0000-1234-0000-000000000000
53266
+ type: string
53267
+ - description: Whether to include all versions of the template in the response
53268
+ in the versions field.
53269
+ example: false
53270
+ in: query
53271
+ name: with_all_versions
53272
+ required: false
53273
+ schema:
53274
+ type: boolean
53275
+ responses:
53276
+ '200':
53277
+ content:
53278
+ application/json:
53279
+ schema:
53280
+ $ref: '#/components/schemas/MonitorUserTemplateResponse'
53281
+ description: OK
53282
+ '404':
53283
+ content:
53284
+ application/json:
53285
+ schema:
53286
+ $ref: '#/components/schemas/APIErrorResponse'
53287
+ description: Not Found
53288
+ '429':
53289
+ $ref: '#/components/responses/TooManyRequestsResponse'
53290
+ security:
53291
+ - apiKeyAuth: []
53292
+ appKeyAuth: []
53293
+ - AuthZ:
53294
+ - monitors_read
53295
+ summary: Get a monitor user template
53296
+ tags:
53297
+ - Monitors
53298
+ x-unstable: '**Note**: This endpoint is in Preview. If you have any feedback,
53299
+
53300
+ contact [Datadog support](https://docs.datadoghq.com/help/).'
53301
+ put:
53302
+ description: Creates a new version of an existing monitor user template.
53303
+ operationId: UpdateMonitorUserTemplate
53304
+ parameters:
53305
+ - description: ID of the monitor user template.
53306
+ in: path
53307
+ name: template_id
53308
+ required: true
53309
+ schema:
53310
+ type: string
53311
+ requestBody:
53312
+ content:
53313
+ application/json:
53314
+ schema:
53315
+ $ref: '#/components/schemas/MonitorUserTemplateUpdateRequest'
53316
+ required: true
53317
+ responses:
53318
+ '200':
53319
+ content:
53320
+ application/json:
53321
+ schema:
53322
+ $ref: '#/components/schemas/MonitorUserTemplateResponse'
53323
+ description: OK
53324
+ '400':
53325
+ content:
53326
+ application/json:
53327
+ schema:
53328
+ $ref: '#/components/schemas/APIErrorResponse'
53329
+ description: Bad Request
53330
+ '404':
53331
+ content:
53332
+ application/json:
53333
+ schema:
53334
+ $ref: '#/components/schemas/APIErrorResponse'
53335
+ description: Not Found
53336
+ '429':
53337
+ $ref: '#/components/responses/TooManyRequestsResponse'
53338
+ security:
53339
+ - apiKeyAuth: []
53340
+ appKeyAuth: []
53341
+ - AuthZ:
53342
+ - monitor_config_policy_write
53343
+ summary: Update a monitor user template to a new version
53344
+ tags:
53345
+ - Monitors
53346
+ x-unstable: '**Note**: This endpoint is in Preview. If you have any feedback,
53347
+
53348
+ contact [Datadog support](https://docs.datadoghq.com/help/).'
53349
+ /api/v2/monitor/template/{template_id}/validate:
53350
+ post:
53351
+ description: Validate the structure and content of an existing monitor user
53352
+ template being updated to a new version.
53353
+ operationId: ValidateExistingMonitorUserTemplate
53354
+ parameters:
53355
+ - description: ID of the monitor user template.
53356
+ in: path
53357
+ name: template_id
53358
+ required: true
53359
+ schema:
53360
+ example: 00000000-0000-1234-0000-000000000000
53361
+ type: string
53362
+ requestBody:
53363
+ content:
53364
+ application/json:
53365
+ schema:
53366
+ $ref: '#/components/schemas/MonitorUserTemplateUpdateRequest'
53367
+ required: true
53368
+ responses:
53369
+ '204':
53370
+ description: OK
53371
+ '400':
53372
+ content:
53373
+ application/json:
53374
+ schema:
53375
+ $ref: '#/components/schemas/APIErrorResponse'
53376
+ description: Bad Request
53377
+ '404':
53378
+ content:
53379
+ application/json:
53380
+ schema:
53381
+ $ref: '#/components/schemas/APIErrorResponse'
53382
+ description: Not Found
53383
+ '429':
53384
+ $ref: '#/components/responses/TooManyRequestsResponse'
53385
+ security:
53386
+ - apiKeyAuth: []
53387
+ appKeyAuth: []
53388
+ - AuthZ:
53389
+ - monitor_config_policy_write
53390
+ summary: Validate an existing monitor user template
53391
+ tags:
53392
+ - Monitors
53393
+ x-unstable: '**Note**: This endpoint is in Preview. If you have any feedback,
53394
+
53395
+ contact [Datadog support](https://docs.datadoghq.com/help/).'
52387
53396
  /api/v2/monitor/{monitor_id}/downtime_matches:
52388
53397
  get:
52389
53398
  description: Get all active downtimes for the specified monitor.
@@ -62873,7 +63882,7 @@ paths:
62873
63882
  /api/v2/workflows:
62874
63883
  post:
62875
63884
  description: Create a new workflow, returning the workflow ID. This API requires
62876
- an application key scoped with the `workflows_write` permission.
63885
+ a [registered application key](https://docs.datadoghq.com/api/latest/action-connection/#register-a-new-app-key).
62877
63886
  operationId: CreateWorkflow
62878
63887
  requestBody:
62879
63888
  content:
@@ -62915,8 +63924,8 @@ paths:
62915
63924
  - workflows_write
62916
63925
  /api/v2/workflows/{workflow_id}:
62917
63926
  delete:
62918
- description: Delete a workflow by ID. This API requires an application key scoped
62919
- with the `workflows_write` permission.
63927
+ description: Delete a workflow by ID. This API requires a [registered application
63928
+ key](https://docs.datadoghq.com/api/latest/action-connection/#register-a-new-app-key).
62920
63929
  operationId: DeleteWorkflow
62921
63930
  parameters:
62922
63931
  - $ref: '#/components/parameters/WorkflowId'
@@ -62949,8 +63958,8 @@ paths:
62949
63958
  permissions:
62950
63959
  - workflows_write
62951
63960
  get:
62952
- description: Get a workflow by ID. This API requires an application key scoped
62953
- with the `workflows_read` permission.
63961
+ description: Get a workflow by ID. This API requires a [registered application
63962
+ key](https://docs.datadoghq.com/api/latest/action-connection/#register-a-new-app-key).
62954
63963
  operationId: GetWorkflow
62955
63964
  parameters:
62956
63965
  - $ref: '#/components/parameters/WorkflowId'
@@ -62993,8 +64002,8 @@ paths:
62993
64002
  permissions:
62994
64003
  - workflows_read
62995
64004
  patch:
62996
- description: Update a workflow by ID. This API requires an application key scoped
62997
- with the `workflows_write` permission.
64005
+ description: Update a workflow by ID. This API requires a [registered application
64006
+ key](https://docs.datadoghq.com/api/latest/action-connection/#register-a-new-app-key).
62998
64007
  operationId: UpdateWorkflow
62999
64008
  parameters:
63000
64009
  - $ref: '#/components/parameters/WorkflowId'
@@ -63044,8 +64053,8 @@ paths:
63044
64053
  - workflows_write
63045
64054
  /api/v2/workflows/{workflow_id}/instances:
63046
64055
  get:
63047
- description: List all instances of a given workflow. This API requires an application
63048
- key scoped with the workflows_read permission.
64056
+ description: List all instances of a given workflow. This API requires a [registered
64057
+ application key](https://docs.datadoghq.com/api/latest/action-connection/#register-a-new-app-key).
63049
64058
  operationId: ListWorkflowInstances
63050
64059
  parameters:
63051
64060
  - $ref: '#/components/parameters/WorkflowId'
@@ -63077,8 +64086,8 @@ paths:
63077
64086
  permissions:
63078
64087
  - workflows_read
63079
64088
  post:
63080
- description: Execute the given workflow. This API requires an application key
63081
- scoped with the workflows_run permission.
64089
+ description: Execute the given workflow. This API requires a [registered application
64090
+ key](https://docs.datadoghq.com/api/latest/action-connection/#register-a-new-app-key).
63082
64091
  operationId: CreateWorkflowInstance
63083
64092
  parameters:
63084
64093
  - $ref: '#/components/parameters/WorkflowId'
@@ -63117,7 +64126,7 @@ paths:
63117
64126
  /api/v2/workflows/{workflow_id}/instances/{instance_id}:
63118
64127
  get:
63119
64128
  description: Get a specific execution of a given workflow. This API requires
63120
- an application key scoped with the workflows_read permission.
64129
+ a [registered application key](https://docs.datadoghq.com/api/latest/action-connection/#register-a-new-app-key).
63121
64130
  operationId: GetWorkflowInstance
63122
64131
  parameters:
63123
64132
  - $ref: '#/components/parameters/WorkflowId'
@@ -63152,7 +64161,7 @@ paths:
63152
64161
  /api/v2/workflows/{workflow_id}/instances/{instance_id}/cancel:
63153
64162
  put:
63154
64163
  description: Cancels a specific execution of a given workflow. This API requires
63155
- an application key scoped with the workflows_run permission.
64164
+ a [registered application key](https://docs.datadoghq.com/api/latest/action-connection/#register-a-new-app-key).
63156
64165
  operationId: CancelWorkflowInstance
63157
64166
  parameters:
63158
64167
  - $ref: '#/components/parameters/WorkflowId'