Create API spec for v2 get an event (#30024)

Co-authored-by: ci.datadog-api-spec <[email protected]>

Author: api-clients-generation-pipeline[bot]

.apigentools-info

@@ -4,13 +4,13 @@
     "spec_versions": {
         "v1": {
             "apigentools_version": "1.6.6",
-            "regenerated": "2025-07-17 13:14:23.696396",
-            "spec_repo_commit": "0becaa34"
+            "regenerated": "2025-07-17 15:37:51.950625",
+            "spec_repo_commit": "214381fd"
         },
         "v2": {
             "apigentools_version": "1.6.6",
-            "regenerated": "2025-07-17 13:14:33.043180",
-            "spec_repo_commit": "0becaa34"
+            "regenerated": "2025-07-17 15:38:01.241299",
+            "spec_repo_commit": "214381fd"
         }
     }
 }

config/_default/menus/api.en.yaml

@@ -850,6 +850,7 @@ menu:
       params:
         versions:
           - v1
+          - v2
         operationids:
           - GetEvent
         unstable: []

content/en/api/v2/events/examples.json

@@ -2318,6 +2318,88 @@ components:
       - id
       - base_severity
       type: object
+    AlertEventAttributes:
+      description: Alert event attributes.
+      properties:
+        aggregation_key:
+          $ref: '#/components/schemas/V2EventAggregationKey'
+        custom:
+          description: JSON object of custom attributes.
+          example: {}
+          type: object
+        evt:
+          $ref: '#/components/schemas/EventSystemAttributes'
+        links:
+          description: The links related to the event.
+          example:
+          - category: runbook
+            title: Runbook Link
+            url: https://app.datadoghq.com/runbook
+          items:
+            $ref: '#/components/schemas/AlertEventAttributesLinksItem'
+          type: array
+        priority:
+          $ref: '#/components/schemas/AlertEventAttributesPriority'
+        service:
+          $ref: '#/components/schemas/V2EventService'
+        status:
+          $ref: '#/components/schemas/AlertEventAttributesStatus'
+        timestamp:
+          $ref: '#/components/schemas/V2EventTimestamp'
+        title:
+          $ref: '#/components/schemas/V2EventTitle'
+      type: object
+    AlertEventAttributesLinksItem:
+      description: A link.
+      properties:
+        category:
+          $ref: '#/components/schemas/AlertEventAttributesLinksItemCategory'
+        title:
+          description: The display text of the link.
+          type: string
+        url:
+          description: The URL of the link.
+          type: string
+      type: object
+    AlertEventAttributesLinksItemCategory:
+      description: The category of the link.
+      enum:
+      - runbook
+      - documentation
+      - dashboard
+      type: string
+      x-enum-varnames:
+      - RUNBOOK
+      - DOCUMENTATION
+      - DASHBOARD
+    AlertEventAttributesPriority:
+      description: The priority of the alert.
+      enum:
+      - '1'
+      - '2'
+      - '3'
+      - '4'
+      - '5'
+      example: '5'
+      type: string
+      x-enum-varnames:
+      - PRIORITY_ONE
+      - PRIORITY_TWO
+      - PRIORITY_THREE
+      - PRIORITY_FOUR
+      - PRIORITY_FIVE
+    AlertEventAttributesStatus:
+      description: The status of the alert.
+      enum:
+      - warn
+      - error
+      - ok
+      example: error
+      type: string
+      x-enum-varnames:
+      - WARN
+      - ERROR
+      - OK
     AlertEventCustomAttributes:
       additionalProperties: false
       description: Alert event attributes.
@@ -7157,6 +7239,116 @@ components:
           format: int64
           type: integer
       type: object
+    ChangeEventAttributes:
+      description: Change event attributes.
+      properties:
+        aggregation_key:
+          $ref: '#/components/schemas/V2EventAggregationKey'
+        author:
+          $ref: '#/components/schemas/ChangeEventAttributesAuthor'
+        change_metadata:
+          description: JSON object of change metadata.
+          example:
+            dd:
+              team: datadog_team
+              user_email: [email protected]
+              user_id: datadog_user_id
+              user_name: datadog_username
+          type: object
+        changed_resource:
+          $ref: '#/components/schemas/ChangeEventAttributesChangedResource'
+        evt:
+          $ref: '#/components/schemas/EventSystemAttributes'
+        impacted_resources:
+          description: A list of resources impacted by this change.
+          example:
+          - name: service-name
+            type: service
+          items:
+            $ref: '#/components/schemas/ChangeEventAttributesImpactedResourcesItem'
+          type: array
+        new_value:
+          description: The new state of the changed resource.
+          example:
+            enabled: true
+            percentage: 50%
+            rule:
+              datacenter: devcycle.us1.prod
+          type: object
+        prev_value:
+          description: The previous state of the changed resource.
+          example:
+            enabled: true
+            percentage: 10%
+            rule:
+              datacenter: devcycle.us1.prod
+          type: object
+        service:
+          $ref: '#/components/schemas/V2EventService'
+        timestamp:
+          $ref: '#/components/schemas/V2EventTimestamp'
+        title:
+          $ref: '#/components/schemas/V2EventTitle'
+      type: object
+    ChangeEventAttributesAuthor:
+      description: The entity that made the change.
+      properties:
+        name:
+          description: The name of the user or system that made the change.
+          example: [email protected]
+          type: string
+        type:
+          $ref: '#/components/schemas/ChangeEventAttributesAuthorType'
+      type: object
+    ChangeEventAttributesAuthorType:
+      description: The type of the author.
+      enum:
+      - user
+      - system
+      - api
+      - automation
+      example: user
+      type: string
+      x-enum-varnames:
+      - USER
+      - SYSTEM
+      - API
+      - AUTOMATION
+    ChangeEventAttributesChangedResource:
+      description: A uniquely identified resource.
+      properties:
+        name:
+          description: The name of the changed resource.
+          type: string
+        type:
+          $ref: '#/components/schemas/ChangeEventAttributesChangedResourceType'
+      type: object
+    ChangeEventAttributesChangedResourceType:
+      description: The type of the changed resource.
+      enum:
+      - feature_flag
+      - configuration
+      example: feature_flag
+      type: string
+      x-enum-varnames:
+      - FEATURE_FLAG
+      - CONFIGURATION
+    ChangeEventAttributesImpactedResourcesItem:
+      description: A uniquely identified resource.
+      properties:
+        name:
+          description: The name of the impacted resource.
+          type: string
+        type:
+          $ref: '#/components/schemas/ChangeEventAttributesImpactedResourcesItemType'
+      type: object
+    ChangeEventAttributesImpactedResourcesItemType:
+      description: The type of the impacted resource.
+      enum:
+      - service
+      type: string
+      x-enum-varnames:
+      - SERVICE
     ChangeEventCustomAttributes:
       additionalProperties: false
       description: Change event attributes.
@@ -15069,6 +15261,44 @@ components:
       - USER_UPDATE
       - RECOMMENDATION
       - SNAPSHOT
+    EventSystemAttributes:
+      description: JSON object of event system attributes.
+      properties:
+        category:
+          $ref: '#/components/schemas/EventSystemAttributesCategory'
+        id:
+          description: Event identifier. This field is deprecated and will be removed
+            in a future version. Use the `uid` field instead.
+          type: string
+        integration_id:
+          $ref: '#/components/schemas/EventSystemAttributesIntegrationId'
+        source_id:
+          description: The source type ID of the event.
+          format: int64
+          type: integer
+        uid:
+          description: A unique identifier for the event. You can use this identifier
+            to query or reference the event.
+          type: string
+      type: object
+    EventSystemAttributesCategory:
+      description: Event category identifying the type of event.
+      enum:
+      - change
+      - alert
+      example: change
+      type: string
+      x-enum-varnames:
+      - CHANGE
+      - ALERT
+    EventSystemAttributesIntegrationId:
+      description: Integration ID sourced from integration manifests.
+      enum:
+      - custom-events
+      example: custom-events
+      type: string
+      x-enum-varnames:
+      - CUSTOM_EVENTS
     EventType:
       default: event
       description: Type of the event.
@@ -42255,6 +42485,70 @@ components:
       type: string
       x-enum-varnames:
       - USERS
+    V2Event:
+      description: An event object.
+      properties:
+        attributes:
+          $ref: '#/components/schemas/V2EventAttributes'
+        id:
+          description: The event's ID.
+          example: ''
+          type: string
+        type:
+          description: Entity type.
+          example: event
+          type: string
+      type: object
+    V2EventAggregationKey:
+      description: Aggregation key of the event.
+      example: aggregation-key
+      type: string
+    V2EventAttributes:
+      description: Event attributes.
+      properties:
+        attributes:
+          $ref: '#/components/schemas/V2EventAttributesAttributes'
+        message:
+          description: Free-form text associated with the event.
+          example: The event message
+          type: string
+        tags:
+          description: A list of tags associated with the event.
+          example:
+          - env:api_client_test
+          items:
+            description: A tag.
+            type: string
+          type: array
+        timestamp:
+          description: Timestamp when the event occurred.
+          example: '2017-01-15T01:30:15.010000Z'
+          type: string
+      type: object
+    V2EventAttributesAttributes:
+      description: JSON object for category-specific attributes.
+      oneOf:
+      - $ref: '#/components/schemas/ChangeEventAttributes'
+      - $ref: '#/components/schemas/AlertEventAttributes'
+    V2EventResponse:
+      description: Get an event response.
+      properties:
+        data:
+          $ref: '#/components/schemas/V2Event'
+      type: object
+    V2EventService:
+      description: Service that triggered the event.
+      example: service-name
+      type: string
+    V2EventTimestamp:
+      description: POSIX timestamp of the event.
+      example: 175019386627
+      format: int64
+      type: integer
+    V2EventTitle:
+      description: The title of the event.
+      example: The event title
+      type: string
     ValidationError:
       description: Represents a single validation error, including a human-readable
         title and metadata.
@@ -50071,6 +50365,49 @@ paths:
         type: safe
     x-merge-override:
       post: false
+  /api/v2/events/{event_id}:
+    get:
+      description: Get the details of an event by `event_id`.
+      operationId: GetEvent
+      parameters:
+      - description: The UID of the event.
+        in: path
+        name: event_id
+        required: true
+        schema:
+          type: string
+      responses:
+        '200':
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/V2EventResponse'
+          description: OK
+        '400':
+          $ref: '#/components/responses/BadRequestResponse'
+        '401':
+          $ref: '#/components/responses/UnauthorizedResponse'
+        '403':
+          $ref: '#/components/responses/ForbiddenResponse'
+        '404':
+          $ref: '#/components/responses/NotFoundResponse'
+        '429':
+          $ref: '#/components/responses/TooManyRequestsResponse'
+      security:
+      - apiKeyAuth: []
+        appKeyAuth: []
+      - AuthZ:
+        - events_read
+      summary: Get an event
+      tags:
+      - Events
+      x-menu-order: 3
+      x-permission:
+        operator: OR
+        permissions:
+        - events_read
+      x-undo:
+        type: safe
   /api/v2/incidents:
     get:
       description: Get all incidents for the user's organization.