@@ -2254,6 +2254,74 @@ components:
2254
2254
- id
2255
2255
- base_severity
2256
2256
type: object
2257
+ AlertEventAttributes:
2258
+ description: Alert event attributes.
2259
+ properties:
2260
+ aggregation_key:
2261
+ $ref: '#/components/schemas/V2EventAggregationKey'
2262
+ custom:
2263
+ description: JSON object of custom attributes.
2264
+ example: {}
2265
+ type: object
2266
+ evt:
2267
+ $ref: '#/components/schemas/EventSystemAttributes'
2268
+ links:
2269
+ description: The links related to the event.
2270
+ example:
2271
+ - category: runbook
2272
+ title: Runbook Link
2273
+ url: https://app.datadoghq.com/runbook
2274
+ items:
2275
+ $ref: '#/components/schemas/AlertEventAttributesLinksItem'
2276
+ type: array
2277
+ priority:
2278
+ $ref: '#/components/schemas/AlertEventAttributesPriority'
2279
+ service:
2280
+ $ref: '#/components/schemas/V2EventService'
2281
+ timestamp:
2282
+ $ref: '#/components/schemas/V2EventTimestamp'
2283
+ title:
2284
+ $ref: '#/components/schemas/V2EventTitle'
2285
+ type: object
2286
+ AlertEventAttributesLinksItem:
2287
+ description: A link.
2288
+ properties:
2289
+ category:
2290
+ $ref: '#/components/schemas/AlertEventAttributesLinksItemCategory'
2291
+ title:
2292
+ description: The display text of the link.
2293
+ type: string
2294
+ url:
2295
+ description: The URL of the link.
2296
+ type: string
2297
+ type: object
2298
+ AlertEventAttributesLinksItemCategory:
2299
+ description: The category of the link.
2300
+ enum:
2301
+ - runbook
2302
+ - documentation
2303
+ - dashboard
2304
+ type: string
2305
+ x-enum-varnames:
2306
+ - RUNBOOK
2307
+ - DOCUMENTATION
2308
+ - DASHBOARD
2309
+ AlertEventAttributesPriority:
2310
+ description: The priority of the alert.
2311
+ enum:
2312
+ - '1'
2313
+ - '2'
2314
+ - '3'
2315
+ - '4'
2316
+ - '5'
2317
+ example: '5'
2318
+ type: string
2319
+ x-enum-varnames:
2320
+ - PRIORITY_ONE
2321
+ - PRIORITY_TWO
2322
+ - PRIORITY_THREE
2323
+ - PRIORITY_FOUR
2324
+ - PRIORITY_FIVE
2257
2325
AlertEventCustomAttributes:
2258
2326
additionalProperties: false
2259
2327
description: Alert event attributes.
@@ -7064,6 +7132,99 @@ components:
7064
7132
format: int64
7065
7133
type: integer
7066
7134
type: object
7135
+ ChangeEventAttributes:
7136
+ description: Change event attributes.
7137
+ properties:
7138
+ aggregation_key:
7139
+ $ref: '#/components/schemas/V2EventAggregationKey'
7140
+ author:
7141
+ $ref: '#/components/schemas/ChangeEventAttributesAuthor'
7142
+ change_metadata:
7143
+ description: JSON object of change metadata.
7144
+ example: {}
7145
+ type: object
7146
+ changed_resource:
7147
+ $ref: '#/components/schemas/ChangeEventAttributesChangedResource'
7148
+ evt:
7149
+ $ref: '#/components/schemas/EventSystemAttributes'
7150
+ impacted_resources:
7151
+ description: A list of resources impacted by this change.
7152
+ example:
7153
+ - name: service-name
7154
+ type: service
7155
+ items:
7156
+ $ref: '#/components/schemas/ChangeEventAttributesImpactedResourcesItem'
7157
+ type: array
7158
+ new_value:
7159
+ description: The new state of the changed resource.
7160
+ example: {}
7161
+ type: object
7162
+ prev_value:
7163
+ description: The previous state of the changed resource.
7164
+ example: {}
7165
+ type: object
7166
+ service:
7167
+ $ref: '#/components/schemas/V2EventService'
7168
+ timestamp:
7169
+ $ref: '#/components/schemas/V2EventTimestamp'
7170
+ title:
7171
+ $ref: '#/components/schemas/V2EventTitle'
7172
+ type: object
7173
+ ChangeEventAttributesAuthor:
7174
+ description: The entity that made the change.
7175
+ properties:
7176
+ name:
7177
+ description: The name of the user or system that made the change.
7178
+
7179
+ type: string
7180
+ type:
7181
+ $ref: '#/components/schemas/ChangeEventAttributesAuthorType'
7182
+ type: object
7183
+ ChangeEventAttributesAuthorType:
7184
+ description: The type of the author.
7185
+ enum:
7186
+ - user
7187
+ - system
7188
+ example: user
7189
+ type: string
7190
+ x-enum-varnames:
7191
+ - USER
7192
+ - SYSTEM
7193
+ ChangeEventAttributesChangedResource:
7194
+ description: A uniquely identified resource.
7195
+ properties:
7196
+ name:
7197
+ description: The name of the changed resource.
7198
+ type: string
7199
+ type:
7200
+ $ref: '#/components/schemas/ChangeEventAttributesChangedResourceType'
7201
+ type: object
7202
+ ChangeEventAttributesChangedResourceType:
7203
+ description: The type of the changed resource.
7204
+ enum:
7205
+ - feature_flag
7206
+ - configuration
7207
+ example: feature_flag
7208
+ type: string
7209
+ x-enum-varnames:
7210
+ - FEATURE_FLAG
7211
+ - CONFIGURATION
7212
+ ChangeEventAttributesImpactedResourcesItem:
7213
+ description: A uniquely identified resource.
7214
+ properties:
7215
+ name:
7216
+ description: The name of the impacted resource.
7217
+ type: string
7218
+ type:
7219
+ $ref: '#/components/schemas/ChangeEventAttributesImpactedResourcesItemType'
7220
+ type: object
7221
+ ChangeEventAttributesImpactedResourcesItemType:
7222
+ description: The type of the impacted resource.
7223
+ enum:
7224
+ - service
7225
+ type: string
7226
+ x-enum-varnames:
7227
+ - SERVICE
7067
7228
ChangeEventCustomAttributes:
7068
7229
additionalProperties: false
7069
7230
description: Change event attributes.
@@ -14805,6 +14966,44 @@ components:
14805
14966
- USER_UPDATE
14806
14967
- RECOMMENDATION
14807
14968
- SNAPSHOT
14969
+ EventSystemAttributes:
14970
+ description: JSON object of event system attributes.
14971
+ properties:
14972
+ category:
14973
+ $ref: '#/components/schemas/EventSystemAttributesCategory'
14974
+ id:
14975
+ description: Event identifier. This field is deprecated and will be removed
14976
+ in a future version. Use the `uid` field instead.
14977
+ type: string
14978
+ integration_id:
14979
+ $ref: '#/components/schemas/EventSystemAttributesIntegrationId'
14980
+ source_id:
14981
+ description: The source type ID of the event.
14982
+ format: int64
14983
+ type: integer
14984
+ uid:
14985
+ description: A unique identifier for the event. You can use this identifier
14986
+ to query or reference the event.
14987
+ type: string
14988
+ type: object
14989
+ EventSystemAttributesCategory:
14990
+ description: Event category identifying the type of event.
14991
+ enum:
14992
+ - change
14993
+ - alert
14994
+ example: change
14995
+ type: string
14996
+ x-enum-varnames:
14997
+ - CHANGE
14998
+ - ALERT
14999
+ EventSystemAttributesIntegrationId:
15000
+ description: Integration ID sourced from integration manifests.
15001
+ enum:
15002
+ - custom-events
15003
+ example: custom-events
15004
+ type: string
15005
+ x-enum-varnames:
15006
+ - CUSTOM_EVENTS
14808
15007
EventType:
14809
15008
default: event
14810
15009
description: Type of the event.
@@ -41258,6 +41457,76 @@ components:
41258
41457
type: string
41259
41458
x-enum-varnames:
41260
41459
- USERS
41460
+ V2Event:
41461
+ description: An event object.
41462
+ properties:
41463
+ attributes:
41464
+ $ref: '#/components/schemas/V2EventAttributes'
41465
+ id:
41466
+ description: The event's ID.
41467
+ example: ''
41468
+ type: string
41469
+ type:
41470
+ description: Entity type.
41471
+ example: event
41472
+ type: string
41473
+ required:
41474
+ - id
41475
+ - type
41476
+ - attributes
41477
+ type: object
41478
+ V2EventAggregationKey:
41479
+ description: Aggregation key of the event.
41480
+ example: aggregation-key
41481
+ type: string
41482
+ V2EventAttributes:
41483
+ description: Event attributes.
41484
+ properties:
41485
+ attributes:
41486
+ $ref: '#/components/schemas/V2EventAttributesAttributes'
41487
+ message:
41488
+ description: Free formed text associated with the event.
41489
+ example: The event message
41490
+ type: string
41491
+ tags:
41492
+ description: A list of tags associated with the event.
41493
+ example:
41494
+ - env:api_client_test
41495
+ items:
41496
+ description: A tag.
41497
+ type: string
41498
+ type: array
41499
+ timestamp:
41500
+ description: Timestamp when the event occurred.
41501
+ example: '2017-01-15T01:30:15.010000Z'
41502
+ type: string
41503
+ required:
41504
+ - attributes
41505
+ type: object
41506
+ V2EventAttributesAttributes:
41507
+ description: JSON object for category-specific attributes.
41508
+ oneOf:
41509
+ - $ref: '#/components/schemas/ChangeEventAttributes'
41510
+ - $ref: '#/components/schemas/AlertEventAttributes'
41511
+ V2EventResponse:
41512
+ description: Get an event response.
41513
+ properties:
41514
+ data:
41515
+ $ref: '#/components/schemas/V2Event'
41516
+ type: object
41517
+ V2EventService:
41518
+ description: Service that triggered the event.
41519
+ example: service-name
41520
+ type: string
41521
+ V2EventTimestamp:
41522
+ description: POSIX timestamp of the event.
41523
+ example: 175019386627
41524
+ format: int64
41525
+ type: integer
41526
+ V2EventTitle:
41527
+ description: The title of the event.
41528
+ example: The event title
41529
+ type: string
41261
41530
ValidationError:
41262
41531
description: Represents a single validation error, including a human-readable
41263
41532
title and metadata.
@@ -48557,6 +48826,49 @@ paths:
48557
48826
type: safe
48558
48827
x-merge-override:
48559
48828
post: false
48829
+ /api/v2/events/{event_id}:
48830
+ get:
48831
+ description: Get the details of event by `event_id`.
48832
+ operationId: GetEvent
48833
+ parameters:
48834
+ - description: The UID of the event.
48835
+ in: path
48836
+ name: event_id
48837
+ required: true
48838
+ schema:
48839
+ type: string
48840
+ responses:
48841
+ '200':
48842
+ content:
48843
+ application/json:
48844
+ schema:
48845
+ $ref: '#/components/schemas/V2EventResponse'
48846
+ description: OK
48847
+ '400':
48848
+ $ref: '#/components/responses/BadRequestResponse'
48849
+ '401':
48850
+ $ref: '#/components/responses/UnauthorizedResponse'
48851
+ '403':
48852
+ $ref: '#/components/responses/ForbiddenResponse'
48853
+ '404':
48854
+ $ref: '#/components/responses/NotFoundResponse'
48855
+ '429':
48856
+ $ref: '#/components/responses/TooManyRequestsResponse'
48857
+ security:
48858
+ - apiKeyAuth: []
48859
+ appKeyAuth: []
48860
+ - AuthZ:
48861
+ - events_read
48862
+ summary: Get an event
48863
+ tags:
48864
+ - Events
48865
+ x-menu-order: 3
48866
+ x-permission:
48867
+ operator: OR
48868
+ permissions:
48869
+ - events_read
48870
+ x-undo:
48871
+ type: safe
48560
48872
/api/v2/incidents:
48561
48873
get:
48562
48874
description: Get all incidents for the user's organization.
0 commit comments