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