@@ -2138,6 +2138,89 @@ components:
2138
2138
- id
2139
2139
- base_severity
2140
2140
type: object
2141
+ AlertEventCustomAttributes:
2142
+ additionalProperties: false
2143
+ description: Object representing custom alert event attributes.
2144
+ properties:
2145
+ custom:
2146
+ $ref: '#/components/schemas/AlertEventCustomAttributesCustom'
2147
+ links:
2148
+ $ref: '#/components/schemas/AlertEventCustomAttributesLinks'
2149
+ priority:
2150
+ $ref: '#/components/schemas/AlertEventCustomAttributesPriority'
2151
+ status:
2152
+ $ref: '#/components/schemas/AlertEventCustomAttributesStatus'
2153
+ type: object
2154
+ AlertEventCustomAttributesCustom:
2155
+ additionalProperties: {}
2156
+ description: Custom attributes support up to 100 properties and a maximum nesting
2157
+ depth of 10 levels.
2158
+ example: {}
2159
+ type: object
2160
+ AlertEventCustomAttributesLinks:
2161
+ description: The links related to the event.
2162
+ items:
2163
+ $ref: '#/components/schemas/AlertEventCustomAttributesLinksItems'
2164
+ maxItems: 20
2165
+ minItems: 1
2166
+ type: array
2167
+ AlertEventCustomAttributesLinksItems:
2168
+ description: A link.
2169
+ properties:
2170
+ category:
2171
+ $ref: '#/components/schemas/AlertEventCustomAttributesLinksItemsCategory'
2172
+ title:
2173
+ description: The title of the link.
2174
+ example: Runbook Link
2175
+ maxLength: 300
2176
+ type: string
2177
+ url:
2178
+ description: The URL of the link.
2179
+ example: https://app.datadoghq.com/runbook
2180
+ maxLength: 2048
2181
+ type: string
2182
+ required:
2183
+ - url
2184
+ - category
2185
+ type: object
2186
+ AlertEventCustomAttributesLinksItemsCategory:
2187
+ description: The category of the link.
2188
+ enum:
2189
+ - runbook
2190
+ example: runbook
2191
+ type: string
2192
+ x-enum-varnames:
2193
+ - RUNBOOK
2194
+ AlertEventCustomAttributesPriority:
2195
+ description: The priority of the alert.
2196
+ enum:
2197
+ - '1'
2198
+ - '2'
2199
+ - '3'
2200
+ - '4'
2201
+ - '5'
2202
+ example: '1'
2203
+ type: string
2204
+ x-enum-varnames:
2205
+ - PRIORITY_ONE
2206
+ - PRIORITY_TWO
2207
+ - PRIORITY_THREE
2208
+ - PRIORITY_FOUR
2209
+ - PRIORITY_FIVE
2210
+ AlertEventCustomAttributesStatus:
2211
+ description: The status of the alert.
2212
+ enum:
2213
+ - info
2214
+ - warn
2215
+ - error
2216
+ - ok
2217
+ example: warn
2218
+ type: string
2219
+ x-enum-varnames:
2220
+ - INFO
2221
+ - WARN
2222
+ - ERROR
2223
+ - OK
2141
2224
Annotation:
2142
2225
description: A list of annotations used in the workflow. These are like sticky
2143
2226
notes for your workflow!
@@ -13949,28 +14032,34 @@ components:
13949
14032
type: string
13950
14033
type: object
13951
14034
EventCategory:
13952
- description: Event category to identify the type of event. Only the value `change`
13953
- is supported. Support for other categories are coming. please reach out to
13954
- datadog support if you're interested.
14035
+ description: Event category to identify the type of event. For example, `change`
14036
+ or `alert`.
13955
14037
enum:
13956
14038
- change
14039
+ - alert
13957
14040
example: change
13958
14041
type: string
13959
14042
x-enum-varnames:
13960
14043
- CHANGE
14044
+ - ALERT
13961
14045
EventCreateRequest:
13962
14046
description: Object representing an event creation request.
13963
14047
properties:
13964
14048
attributes:
13965
14049
$ref: '#/components/schemas/EventPayload'
13966
14050
type:
13967
14051
$ref: '#/components/schemas/EventCreateRequestType'
14052
+ required:
14053
+ - type
14054
+ - attributes
13968
14055
type: object
13969
14056
EventCreateRequestPayload:
13970
14057
description: Payload for creating an event.
13971
14058
properties:
13972
14059
data:
13973
14060
$ref: '#/components/schemas/EventCreateRequest'
14061
+ required:
14062
+ - data
13974
14063
type: object
13975
14064
EventCreateRequestType:
13976
14065
description: Entity type.
@@ -13985,6 +14074,10 @@ components:
13985
14074
properties:
13986
14075
attributes:
13987
14076
$ref: '#/components/schemas/EventCreateResponseAttributes'
14077
+ id:
14078
+ description: Event ID
14079
+ example: _
14080
+ type: string
13988
14081
type:
13989
14082
description: Event type
13990
14083
example: event
@@ -14006,28 +14099,46 @@ components:
14006
14099
EventCreateResponseAttributesAttributesEvt:
14007
14100
description: JSON object of event system attributes.
14008
14101
properties:
14009
- id:
14010
- description: Event id
14102
+ uid:
14103
+ description: Event UID
14104
+ example: ABCDEFGHIJKLMNOPQRSTUVWX
14011
14105
type: string
14012
14106
type: object
14013
14107
EventCreateResponsePayload:
14014
14108
description: Response containing information about created event.
14015
14109
properties:
14016
14110
data:
14017
14111
$ref: '#/components/schemas/EventCreateResponse'
14112
+ links:
14113
+ $ref: '#/components/schemas/EventCreateResponsePayloadLinks'
14114
+ type: object
14115
+ EventCreateResponsePayloadLinks:
14116
+ description: Links attributes.
14117
+ properties:
14118
+ self:
14119
+ description: The URL of the event.
14120
+ example: https://app.datadoghq.com/event/event?id=123
14121
+ type: string
14018
14122
type: object
14019
14123
EventPayload:
14020
14124
description: Event attributes.
14021
14125
properties:
14022
14126
aggregation_key:
14023
14127
description: An arbitrary string to use for aggregation when correlating
14024
14128
events. Limited to 100 characters.
14129
+ example: aggregation_key_123
14025
14130
maxLength: 100
14026
14131
type: string
14027
14132
attributes:
14028
14133
$ref: '#/components/schemas/EventPayloadAttributes'
14029
14134
category:
14030
14135
$ref: '#/components/schemas/EventCategory'
14136
+ integration_id:
14137
+ description: Integration IDs sourced from manifests. Examples include custom-events,
14138
+ containerd, docker, elasticsearch, helm, mongodb, mysql, and nagios. See
14139
+ the full list of available IDs [here](https://docs.datadoghq.com/getting_started/integrations/).
14140
+ example: custom-events
14141
+ type: string
14031
14142
message:
14032
14143
description: The body of the event. Limited to 4000 characters.
14033
14144
example: payment_processed feature flag has been enabled
@@ -14041,7 +14152,10 @@ components:
14041
14152
- env:test
14042
14153
items:
14043
14154
description: A tag.
14155
+ maxLength: 200
14044
14156
type: string
14157
+ maxItems: 100
14158
+ minItems: 1
14045
14159
type: array
14046
14160
timestamp:
14047
14161
description: 'Timestamp when the event occurred. Must follow [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html)
@@ -14067,6 +14181,7 @@ components:
14067
14181
event category.
14068
14182
oneOf:
14069
14183
- $ref: '#/components/schemas/ChangeEventCustomAttributes'
14184
+ - $ref: '#/components/schemas/AlertEventCustomAttributes'
14070
14185
EventPriority:
14071
14186
description: The priority of the event's monitor. For example, `normal` or `low`.
14072
14187
enum:
@@ -45283,7 +45398,8 @@ paths:
45283
45398
- events_read
45284
45399
post:
45285
45400
description: "This endpoint allows you to post events.\n\n\u2705 **Only events
45286
- with the `change` category** are in General Availability. See [Change Tracking](https://docs.datadoghq.com/change_tracking)
45401
+ with the `change` or `alert` category** are in General Availability. For change
45402
+ events, see [Change Tracking](https://docs.datadoghq.com/change_tracking)
45287
45403
for more details.\n\n\u274C For use cases involving other event categories,
45288
45404
please use the V1 endpoint."
45289
45405
operationId: CreateEvent
@@ -45295,6 +45411,7 @@ paths:
45295
45411
value:
45296
45412
data:
45297
45413
attributes:
45414
+ aggregation_key: aggregation_key_123
45298
45415
attributes:
45299
45416
author:
45300
45417
@@ -45323,6 +45440,7 @@ paths:
45323
45440
rule:
45324
45441
datacenter: devcycle.us1.prod
45325
45442
category: change
45443
+ integration_id: custom-events
45326
45444
message: payment_processed feature flag has been enabled
45327
45445
tags:
45328
45446
- env:test
@@ -45356,6 +45474,38 @@ paths:
45356
45474
security:
45357
45475
- apiKeyAuth: []
45358
45476
appKeyAuth: []
45477
+ servers:
45478
+ - url: https://{subdomain}.{site}
45479
+ variables:
45480
+ site:
45481
+ default: datadoghq.com
45482
+ description: The regional site for customers.
45483
+ enum:
45484
+ - datadoghq.com
45485
+ - us3.datadoghq.com
45486
+ - us5.datadoghq.com
45487
+ - ap1.datadoghq.com
45488
+ - datadoghq.eu
45489
+ - ddog-gov.com
45490
+ subdomain:
45491
+ default: event-management-intake
45492
+ description: The subdomain where the API is deployed.
45493
+ - url: '{protocol}://{name}'
45494
+ variables:
45495
+ name:
45496
+ default: event-management-intake.datadoghq.com
45497
+ description: Full site DNS name.
45498
+ protocol:
45499
+ default: https
45500
+ description: The protocol for accessing the API.
45501
+ - url: https://{subdomain}.{site}
45502
+ variables:
45503
+ site:
45504
+ default: datadoghq.com
45505
+ description: Any Datadog deployment.
45506
+ subdomain:
45507
+ default: event-management-intake
45508
+ description: The subdomain where the API is deployed.
45359
45509
summary: Post an event
45360
45510
tags:
45361
45511
- Events
0 commit comments