@@ -2227,6 +2227,74 @@ components:
22272227 - id
22282228 - base_severity
22292229 type: object
2230+ AlertEventAttributes:
2231+ description: Alert event attributes.
2232+ properties:
2233+ aggregation_key:
2234+ $ref: '#/components/schemas/V2EventAggregationKey'
2235+ custom:
2236+ description: JSON object of custom attributes.
2237+ example: {}
2238+ type: object
2239+ evt:
2240+ $ref: '#/components/schemas/EventSystemAttributes'
2241+ links:
2242+ description: The links related to the event.
2243+ example:
2244+ - category: runbook
2245+ title: Runbook Link
2246+ url: https://app.datadoghq.com/runbook
2247+ items:
2248+ $ref: '#/components/schemas/AlertEventAttributesLinksItem'
2249+ type: array
2250+ priority:
2251+ $ref: '#/components/schemas/AlertEventAttributesPriority'
2252+ service:
2253+ $ref: '#/components/schemas/V2EventService'
2254+ timestamp:
2255+ $ref: '#/components/schemas/V2EventTimestamp'
2256+ title:
2257+ $ref: '#/components/schemas/V2EventTitle'
2258+ type: object
2259+ AlertEventAttributesLinksItem:
2260+ description: A link.
2261+ properties:
2262+ category:
2263+ $ref: '#/components/schemas/AlertEventAttributesLinksItemCategory'
2264+ title:
2265+ description: The display text of the link.
2266+ type: string
2267+ url:
2268+ description: The URL of the link.
2269+ type: string
2270+ type: object
2271+ AlertEventAttributesLinksItemCategory:
2272+ description: The category of the link.
2273+ enum:
2274+ - runbook
2275+ - documentation
2276+ - dashboard
2277+ type: string
2278+ x-enum-varnames:
2279+ - RUNBOOK
2280+ - DOCUMENTATION
2281+ - DASHBOARD
2282+ AlertEventAttributesPriority:
2283+ description: The priority of the alert.
2284+ enum:
2285+ - '1'
2286+ - '2'
2287+ - '3'
2288+ - '4'
2289+ - '5'
2290+ example: '5'
2291+ type: string
2292+ x-enum-varnames:
2293+ - PRIORITY_ONE
2294+ - PRIORITY_TWO
2295+ - PRIORITY_THREE
2296+ - PRIORITY_FOUR
2297+ - PRIORITY_FIVE
22302298 AlertEventCustomAttributes:
22312299 additionalProperties: false
22322300 description: Alert event attributes.
@@ -7009,6 +7077,99 @@ components:
70097077 format: int64
70107078 type: integer
70117079 type: object
7080+ ChangeEventAttributes:
7081+ description: Change event attributes.
7082+ properties:
7083+ aggregation_key:
7084+ $ref: '#/components/schemas/V2EventAggregationKey'
7085+ author:
7086+ $ref: '#/components/schemas/ChangeEventAttributesAuthor'
7087+ change_metadata:
7088+ description: JSON object of change metadata.
7089+ example: {}
7090+ type: object
7091+ changed_resource:
7092+ $ref: '#/components/schemas/ChangeEventAttributesChangedResource'
7093+ evt:
7094+ $ref: '#/components/schemas/EventSystemAttributes'
7095+ impacted_resources:
7096+ description: A list of resources impacted by this change.
7097+ example:
7098+ - name: service-name
7099+ type: service
7100+ items:
7101+ $ref: '#/components/schemas/ChangeEventAttributesImpactedResourcesItem'
7102+ type: array
7103+ new_value:
7104+ description: The new state of the changed resource.
7105+ example: {}
7106+ type: object
7107+ prev_value:
7108+ description: The previous state of the changed resource.
7109+ example: {}
7110+ type: object
7111+ service:
7112+ $ref: '#/components/schemas/V2EventService'
7113+ timestamp:
7114+ $ref: '#/components/schemas/V2EventTimestamp'
7115+ title:
7116+ $ref: '#/components/schemas/V2EventTitle'
7117+ type: object
7118+ ChangeEventAttributesAuthor:
7119+ description: The entity that made the change.
7120+ properties:
7121+ name:
7122+ description: The name of the user or system that made the change.
7123+ example: example@datadog.com
7124+ type: string
7125+ type:
7126+ $ref: '#/components/schemas/ChangeEventAttributesAuthorType'
7127+ type: object
7128+ ChangeEventAttributesAuthorType:
7129+ description: The type of the author.
7130+ enum:
7131+ - user
7132+ - system
7133+ example: user
7134+ type: string
7135+ x-enum-varnames:
7136+ - USER
7137+ - SYSTEM
7138+ ChangeEventAttributesChangedResource:
7139+ description: A uniquely identified resource.
7140+ properties:
7141+ name:
7142+ description: The name of the changed resource.
7143+ type: string
7144+ type:
7145+ $ref: '#/components/schemas/ChangeEventAttributesChangedResourceType'
7146+ type: object
7147+ ChangeEventAttributesChangedResourceType:
7148+ description: The type of the changed resource.
7149+ enum:
7150+ - feature_flag
7151+ - configuration
7152+ example: feature_flag
7153+ type: string
7154+ x-enum-varnames:
7155+ - FEATURE_FLAG
7156+ - CONFIGURATION
7157+ ChangeEventAttributesImpactedResourcesItem:
7158+ description: A uniquely identified resource.
7159+ properties:
7160+ name:
7161+ description: The name of the impacted resource.
7162+ type: string
7163+ type:
7164+ $ref: '#/components/schemas/ChangeEventAttributesImpactedResourcesItemType'
7165+ type: object
7166+ ChangeEventAttributesImpactedResourcesItemType:
7167+ description: The type of the impacted resource.
7168+ enum:
7169+ - service
7170+ type: string
7171+ x-enum-varnames:
7172+ - SERVICE
70127173 ChangeEventCustomAttributes:
70137174 additionalProperties: false
70147175 description: Change event attributes.
@@ -14925,6 +15086,44 @@ components:
1492515086 - USER_UPDATE
1492615087 - RECOMMENDATION
1492715088 - SNAPSHOT
15089+ EventSystemAttributes:
15090+ description: JSON object of event system attributes.
15091+ properties:
15092+ category:
15093+ $ref: '#/components/schemas/EventSystemAttributesCategory'
15094+ id:
15095+ description: Event identifier. This field is deprecated and will be removed
15096+ in a future version. Use the `uid` field instead.
15097+ type: string
15098+ integration_id:
15099+ $ref: '#/components/schemas/EventSystemAttributesIntegrationId'
15100+ source_id:
15101+ description: The source type ID of the event.
15102+ format: int64
15103+ type: integer
15104+ uid:
15105+ description: A unique identifier for the event. You can use this identifier
15106+ to query or reference the event.
15107+ type: string
15108+ type: object
15109+ EventSystemAttributesCategory:
15110+ description: Event category identifying the type of event.
15111+ enum:
15112+ - change
15113+ - alert
15114+ example: change
15115+ type: string
15116+ x-enum-varnames:
15117+ - CHANGE
15118+ - ALERT
15119+ EventSystemAttributesIntegrationId:
15120+ description: Integration ID sourced from integration manifests.
15121+ enum:
15122+ - custom-events
15123+ example: custom-events
15124+ type: string
15125+ x-enum-varnames:
15126+ - CUSTOM_EVENTS
1492815127 EventType:
1492915128 default: event
1493015129 description: Type of the event.
@@ -40576,6 +40775,76 @@ components:
4057640775 type: string
4057740776 x-enum-varnames:
4057840777 - USERS
40778+ V2Event:
40779+ description: An event object.
40780+ properties:
40781+ attributes:
40782+ $ref: '#/components/schemas/V2EventAttributes'
40783+ id:
40784+ description: The event's ID.
40785+ example: ''
40786+ type: string
40787+ type:
40788+ description: Entity type.
40789+ example: event
40790+ type: string
40791+ required:
40792+ - id
40793+ - type
40794+ - attributes
40795+ type: object
40796+ V2EventAggregationKey:
40797+ description: Aggregation key of the event.
40798+ example: aggregation-key
40799+ type: string
40800+ V2EventAttributes:
40801+ description: Event attributes.
40802+ properties:
40803+ attributes:
40804+ $ref: '#/components/schemas/V2EventAttributesAttributes'
40805+ message:
40806+ description: Free formed text associated with the event.
40807+ example: The event message
40808+ type: string
40809+ tags:
40810+ description: A list of tags associated with the event.
40811+ example:
40812+ - env:api_client_test
40813+ items:
40814+ description: A tag.
40815+ type: string
40816+ type: array
40817+ timestamp:
40818+ description: Timestamp when the event occurred.
40819+ example: '2017-01-15T01:30:15.010000Z'
40820+ type: string
40821+ required:
40822+ - attributes
40823+ type: object
40824+ V2EventAttributesAttributes:
40825+ description: JSON object for category-specific attributes.
40826+ oneOf:
40827+ - $ref: '#/components/schemas/ChangeEventAttributes'
40828+ - $ref: '#/components/schemas/AlertEventAttributes'
40829+ V2EventResponse:
40830+ description: Get an event response.
40831+ properties:
40832+ data:
40833+ $ref: '#/components/schemas/V2Event'
40834+ type: object
40835+ V2EventService:
40836+ description: Service that triggered the event.
40837+ example: service-name
40838+ type: string
40839+ V2EventTimestamp:
40840+ description: POSIX timestamp of the event.
40841+ example: 175019386627
40842+ format: int64
40843+ type: integer
40844+ V2EventTitle:
40845+ description: The title of the event.
40846+ example: The event title
40847+ type: string
4057940848 ValidationError:
4058040849 description: Represents a single validation error, including a human-readable
4058140850 title and metadata.
@@ -47370,6 +47639,46 @@ paths:
4737047639 operator: OR
4737147640 permissions:
4737247641 - events_read
47642+ /api/v2/events/{event_id}:
47643+ get:
47644+ description: Get the details of event by `event_id`.
47645+ operationId: GetEvent
47646+ parameters:
47647+ - description: The UID of the event.
47648+ in: path
47649+ name: event_id
47650+ required: true
47651+ schema:
47652+ type: string
47653+ responses:
47654+ '200':
47655+ content:
47656+ application/json:
47657+ schema:
47658+ $ref: '#/components/schemas/V2EventResponse'
47659+ description: OK
47660+ '400':
47661+ $ref: '#/components/responses/BadRequestResponse'
47662+ '401':
47663+ $ref: '#/components/responses/UnauthorizedResponse'
47664+ '403':
47665+ $ref: '#/components/responses/ForbiddenResponse'
47666+ '404':
47667+ $ref: '#/components/responses/NotFoundResponse'
47668+ '429':
47669+ $ref: '#/components/responses/TooManyRequestsResponse'
47670+ security:
47671+ - apiKeyAuth: []
47672+ appKeyAuth: []
47673+ - AuthZ:
47674+ - events_read
47675+ summary: Get an event
47676+ tags:
47677+ - Events
47678+ x-permission:
47679+ operator: OR
47680+ permissions:
47681+ - events_read
4737347682 /api/v2/incidents:
4737447683 get:
4737547684 description: Get all incidents for the user's organization.
0 commit comments