@@ -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,112 @@ 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+ dd:
7091+ team: datadog_team
7092+ user_email: datadog@datadog.com
7093+ user_id: datadog_user_id
7094+ user_name: datadog_username
7095+ type: object
7096+ changed_resource:
7097+ $ref: '#/components/schemas/ChangeEventAttributesChangedResource'
7098+ evt:
7099+ $ref: '#/components/schemas/EventSystemAttributes'
7100+ impacted_resources:
7101+ description: A list of resources impacted by this change.
7102+ example:
7103+ - name: service-name
7104+ type: service
7105+ items:
7106+ $ref: '#/components/schemas/ChangeEventAttributesImpactedResourcesItem'
7107+ type: array
7108+ new_value:
7109+ description: The new state of the changed resource.
7110+ example:
7111+ enabled: true
7112+ percentage: 50%
7113+ rule:
7114+ datacenter: devcycle.us1.prod
7115+ type: object
7116+ prev_value:
7117+ description: The previous state of the changed resource.
7118+ example:
7119+ enabled: true
7120+ percentage: 10%
7121+ rule:
7122+ datacenter: devcycle.us1.prod
7123+ type: object
7124+ service:
7125+ $ref: '#/components/schemas/V2EventService'
7126+ timestamp:
7127+ $ref: '#/components/schemas/V2EventTimestamp'
7128+ title:
7129+ $ref: '#/components/schemas/V2EventTitle'
7130+ type: object
7131+ ChangeEventAttributesAuthor:
7132+ description: The entity that made the change.
7133+ properties:
7134+ name:
7135+ description: The name of the user or system that made the change.
7136+ example: example@datadog.com
7137+ type: string
7138+ type:
7139+ $ref: '#/components/schemas/ChangeEventAttributesAuthorType'
7140+ type: object
7141+ ChangeEventAttributesAuthorType:
7142+ description: The type of the author.
7143+ enum:
7144+ - user
7145+ - system
7146+ example: user
7147+ type: string
7148+ x-enum-varnames:
7149+ - USER
7150+ - SYSTEM
7151+ ChangeEventAttributesChangedResource:
7152+ description: A uniquely identified resource.
7153+ properties:
7154+ name:
7155+ description: The name of the changed resource.
7156+ type: string
7157+ type:
7158+ $ref: '#/components/schemas/ChangeEventAttributesChangedResourceType'
7159+ type: object
7160+ ChangeEventAttributesChangedResourceType:
7161+ description: The type of the changed resource.
7162+ enum:
7163+ - feature_flag
7164+ - configuration
7165+ example: feature_flag
7166+ type: string
7167+ x-enum-varnames:
7168+ - FEATURE_FLAG
7169+ - CONFIGURATION
7170+ ChangeEventAttributesImpactedResourcesItem:
7171+ description: A uniquely identified resource.
7172+ properties:
7173+ name:
7174+ description: The name of the impacted resource.
7175+ type: string
7176+ type:
7177+ $ref: '#/components/schemas/ChangeEventAttributesImpactedResourcesItemType'
7178+ type: object
7179+ ChangeEventAttributesImpactedResourcesItemType:
7180+ description: The type of the impacted resource.
7181+ enum:
7182+ - service
7183+ type: string
7184+ x-enum-varnames:
7185+ - SERVICE
70127186 ChangeEventCustomAttributes:
70137187 additionalProperties: false
70147188 description: Change event attributes.
@@ -14925,6 +15099,44 @@ components:
1492515099 - USER_UPDATE
1492615100 - RECOMMENDATION
1492715101 - SNAPSHOT
15102+ EventSystemAttributes:
15103+ description: JSON object of event system attributes.
15104+ properties:
15105+ category:
15106+ $ref: '#/components/schemas/EventSystemAttributesCategory'
15107+ id:
15108+ description: Event identifier. This field is deprecated and will be removed
15109+ in a future version. Use the `uid` field instead.
15110+ type: string
15111+ integration_id:
15112+ $ref: '#/components/schemas/EventSystemAttributesIntegrationId'
15113+ source_id:
15114+ description: The source type ID of the event.
15115+ format: int64
15116+ type: integer
15117+ uid:
15118+ description: A unique identifier for the event. You can use this identifier
15119+ to query or reference the event.
15120+ type: string
15121+ type: object
15122+ EventSystemAttributesCategory:
15123+ description: Event category identifying the type of event.
15124+ enum:
15125+ - change
15126+ - alert
15127+ example: change
15128+ type: string
15129+ x-enum-varnames:
15130+ - CHANGE
15131+ - ALERT
15132+ EventSystemAttributesIntegrationId:
15133+ description: Integration ID sourced from integration manifests.
15134+ enum:
15135+ - custom-events
15136+ example: custom-events
15137+ type: string
15138+ x-enum-varnames:
15139+ - CUSTOM_EVENTS
1492815140 EventType:
1492915141 default: event
1493015142 description: Type of the event.
@@ -40580,6 +40792,70 @@ components:
4058040792 type: string
4058140793 x-enum-varnames:
4058240794 - USERS
40795+ V2Event:
40796+ description: An event object.
40797+ properties:
40798+ attributes:
40799+ $ref: '#/components/schemas/V2EventAttributes'
40800+ id:
40801+ description: The event's ID.
40802+ example: ''
40803+ type: string
40804+ type:
40805+ description: Entity type.
40806+ example: event
40807+ type: string
40808+ type: object
40809+ V2EventAggregationKey:
40810+ description: Aggregation key of the event.
40811+ example: aggregation-key
40812+ type: string
40813+ V2EventAttributes:
40814+ description: Event attributes.
40815+ properties:
40816+ attributes:
40817+ $ref: '#/components/schemas/V2EventAttributesAttributes'
40818+ message:
40819+ description: Free-formed text associated with the event.
40820+ example: The event message
40821+ type: string
40822+ tags:
40823+ description: A list of tags associated with the event.
40824+ example:
40825+ - env:api_client_test
40826+ items:
40827+ description: A tag.
40828+ type: string
40829+ type: array
40830+ timestamp:
40831+ description: Timestamp when the event occurred.
40832+ example: '2017-01-15T01:30:15.010000Z'
40833+ type: string
40834+ type: object
40835+ V2EventAttributesAttributes:
40836+ description: JSON object for category-specific attributes.
40837+ oneOf:
40838+ - $ref: '#/components/schemas/ChangeEventAttributes'
40839+ - $ref: '#/components/schemas/AlertEventAttributes'
40840+ V2EventResponse:
40841+ description: Get an event response.
40842+ properties:
40843+ data:
40844+ $ref: '#/components/schemas/V2Event'
40845+ type: object
40846+ V2EventService:
40847+ description: Service that triggered the event.
40848+ example: service-name
40849+ type: string
40850+ V2EventTimestamp:
40851+ description: POSIX timestamp of the event.
40852+ example: 175019386627
40853+ format: int64
40854+ type: integer
40855+ V2EventTitle:
40856+ description: The title of the event.
40857+ example: The event title
40858+ type: string
4058340859 ValidationError:
4058440860 description: Represents a single validation error, including a human-readable
4058540861 title and metadata.
@@ -47374,6 +47650,46 @@ paths:
4737447650 operator: OR
4737547651 permissions:
4737647652 - events_read
47653+ /api/v2/events/{event_id}:
47654+ get:
47655+ description: Get the details of an event by `event_id`.
47656+ operationId: GetEvent
47657+ parameters:
47658+ - description: The UID of the event.
47659+ in: path
47660+ name: event_id
47661+ required: true
47662+ schema:
47663+ type: string
47664+ responses:
47665+ '200':
47666+ content:
47667+ application/json:
47668+ schema:
47669+ $ref: '#/components/schemas/V2EventResponse'
47670+ description: OK
47671+ '400':
47672+ $ref: '#/components/responses/BadRequestResponse'
47673+ '401':
47674+ $ref: '#/components/responses/UnauthorizedResponse'
47675+ '403':
47676+ $ref: '#/components/responses/ForbiddenResponse'
47677+ '404':
47678+ $ref: '#/components/responses/NotFoundResponse'
47679+ '429':
47680+ $ref: '#/components/responses/TooManyRequestsResponse'
47681+ security:
47682+ - apiKeyAuth: []
47683+ appKeyAuth: []
47684+ - AuthZ:
47685+ - events_read
47686+ summary: Get an event
47687+ tags:
47688+ - Events
47689+ x-permission:
47690+ operator: OR
47691+ permissions:
47692+ - events_read
4737747693 /api/v2/incidents:
4737847694 get:
4737947695 description: Get all incidents for the user's organization.
0 commit comments