@@ -2138,6 +2138,89 @@ components:
21382138 - id
21392139 - base_severity
21402140 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
21412224 Annotation:
21422225 description: A list of annotations used in the workflow. These are like sticky
21432226 notes for your workflow!
@@ -13949,28 +14032,34 @@ components:
1394914032 type: string
1395014033 type: object
1395114034 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`.
1395514037 enum:
1395614038 - change
14039+ - alert
1395714040 example: change
1395814041 type: string
1395914042 x-enum-varnames:
1396014043 - CHANGE
14044+ - ALERT
1396114045 EventCreateRequest:
1396214046 description: Object representing an event creation request.
1396314047 properties:
1396414048 attributes:
1396514049 $ref: '#/components/schemas/EventPayload'
1396614050 type:
1396714051 $ref: '#/components/schemas/EventCreateRequestType'
14052+ required:
14053+ - type
14054+ - attributes
1396814055 type: object
1396914056 EventCreateRequestPayload:
1397014057 description: Payload for creating an event.
1397114058 properties:
1397214059 data:
1397314060 $ref: '#/components/schemas/EventCreateRequest'
14061+ required:
14062+ - data
1397414063 type: object
1397514064 EventCreateRequestType:
1397614065 description: Entity type.
@@ -13985,6 +14074,10 @@ components:
1398514074 properties:
1398614075 attributes:
1398714076 $ref: '#/components/schemas/EventCreateResponseAttributes'
14077+ id:
14078+ description: Event ID
14079+ example: _
14080+ type: string
1398814081 type:
1398914082 description: Event type
1399014083 example: event
@@ -14006,28 +14099,46 @@ components:
1400614099 EventCreateResponseAttributesAttributesEvt:
1400714100 description: JSON object of event system attributes.
1400814101 properties:
14009- id:
14010- description: Event id
14102+ uid:
14103+ description: Event UID
14104+ example: ABCDEFGHIJKLMNOPQRSTUVWX
1401114105 type: string
1401214106 type: object
1401314107 EventCreateResponsePayload:
1401414108 description: Response containing information about created event.
1401514109 properties:
1401614110 data:
1401714111 $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
1401814122 type: object
1401914123 EventPayload:
1402014124 description: Event attributes.
1402114125 properties:
1402214126 aggregation_key:
1402314127 description: An arbitrary string to use for aggregation when correlating
1402414128 events. Limited to 100 characters.
14129+ example: aggregation_key_123
1402514130 maxLength: 100
1402614131 type: string
1402714132 attributes:
1402814133 $ref: '#/components/schemas/EventPayloadAttributes'
1402914134 category:
1403014135 $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
1403114142 message:
1403214143 description: The body of the event. Limited to 4000 characters.
1403314144 example: payment_processed feature flag has been enabled
@@ -14041,7 +14152,10 @@ components:
1404114152 - env:test
1404214153 items:
1404314154 description: A tag.
14155+ maxLength: 200
1404414156 type: string
14157+ maxItems: 100
14158+ minItems: 1
1404514159 type: array
1404614160 timestamp:
1404714161 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:
1406714181 event category.
1406814182 oneOf:
1406914183 - $ref: '#/components/schemas/ChangeEventCustomAttributes'
14184+ - $ref: '#/components/schemas/AlertEventCustomAttributes'
1407014185 EventPriority:
1407114186 description: The priority of the event's monitor. For example, `normal` or `low`.
1407214187 enum:
@@ -45283,7 +45398,8 @@ paths:
4528345398 - events_read
4528445399 post:
4528545400 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)
4528745403 for more details.\n\n\u274C For use cases involving other event categories,
4528845404 please use the V1 endpoint."
4528945405 operationId: CreateEvent
@@ -45295,6 +45411,7 @@ paths:
4529545411 value:
4529645412 data:
4529745413 attributes:
45414+ aggregation_key: aggregation_key_123
4529845415 attributes:
4529945416 author:
4530045417@@ -45323,6 +45440,7 @@ paths:
4532345440 rule:
4532445441 datacenter: devcycle.us1.prod
4532545442 category: change
45443+ integration_id: custom-events
4532645444 message: payment_processed feature flag has been enabled
4532745445 tags:
4532845446 - env:test
@@ -45356,6 +45474,38 @@ paths:
4535645474 security:
4535745475 - apiKeyAuth: []
4535845476 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.
4535945509 summary: Post an event
4536045510 tags:
4536145511 - Events
0 commit comments