Skip to content

Commit 7ec1a3a

Browse files
author
ci.datadog-api-spec
committed
Regenerate client from commit 78730ba3 of spec repo
1 parent 9599f9e commit 7ec1a3a

File tree

7 files changed

+5482
-4
lines changed

7 files changed

+5482
-4
lines changed

.apigentools-info

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,13 +4,13 @@
44
"spec_versions": {
55
"v1": {
66
"apigentools_version": "1.6.6",
7-
"regenerated": "2025-06-19 12:13:56.197351",
8-
"spec_repo_commit": "a171e0a8"
7+
"regenerated": "2025-06-20 13:51:30.860715",
8+
"spec_repo_commit": "78730ba3"
99
},
1010
"v2": {
1111
"apigentools_version": "1.6.6",
12-
"regenerated": "2025-06-19 12:14:05.477000",
13-
"spec_repo_commit": "a171e0a8"
12+
"regenerated": "2025-06-20 13:51:40.463493",
13+
"spec_repo_commit": "78730ba3"
1414
}
1515
}
1616
}

config/_default/menus/api.en.yaml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -838,6 +838,7 @@ menu:
838838
params:
839839
versions:
840840
- v1
841+
- v2
841842
operationids:
842843
- GetEvent
843844
unstable: []

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

Lines changed: 114 additions & 0 deletions
Large diffs are not rendered by default.

data/api/v2/full_spec.yaml

Lines changed: 319 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2254,6 +2254,74 @@ components:
22542254
- id
22552255
- base_severity
22562256
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
22572325
AlertEventCustomAttributes:
22582326
additionalProperties: false
22592327
description: Alert event attributes.
@@ -7064,6 +7132,112 @@ components:
70647132
format: int64
70657133
type: integer
70667134
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+
dd:
7146+
team: datadog_team
7147+
user_email: [email protected]
7148+
user_id: datadog_user_id
7149+
user_name: datadog_username
7150+
type: object
7151+
changed_resource:
7152+
$ref: '#/components/schemas/ChangeEventAttributesChangedResource'
7153+
evt:
7154+
$ref: '#/components/schemas/EventSystemAttributes'
7155+
impacted_resources:
7156+
description: A list of resources impacted by this change.
7157+
example:
7158+
- name: service-name
7159+
type: service
7160+
items:
7161+
$ref: '#/components/schemas/ChangeEventAttributesImpactedResourcesItem'
7162+
type: array
7163+
new_value:
7164+
description: The new state of the changed resource.
7165+
example:
7166+
enabled: true
7167+
percentage: 50%
7168+
rule:
7169+
datacenter: devcycle.us1.prod
7170+
type: object
7171+
prev_value:
7172+
description: The previous state of the changed resource.
7173+
example:
7174+
enabled: true
7175+
percentage: 10%
7176+
rule:
7177+
datacenter: devcycle.us1.prod
7178+
type: object
7179+
service:
7180+
$ref: '#/components/schemas/V2EventService'
7181+
timestamp:
7182+
$ref: '#/components/schemas/V2EventTimestamp'
7183+
title:
7184+
$ref: '#/components/schemas/V2EventTitle'
7185+
type: object
7186+
ChangeEventAttributesAuthor:
7187+
description: The entity that made the change.
7188+
properties:
7189+
name:
7190+
description: The name of the user or system that made the change.
7191+
7192+
type: string
7193+
type:
7194+
$ref: '#/components/schemas/ChangeEventAttributesAuthorType'
7195+
type: object
7196+
ChangeEventAttributesAuthorType:
7197+
description: The type of the author.
7198+
enum:
7199+
- user
7200+
- system
7201+
example: user
7202+
type: string
7203+
x-enum-varnames:
7204+
- USER
7205+
- SYSTEM
7206+
ChangeEventAttributesChangedResource:
7207+
description: A uniquely identified resource.
7208+
properties:
7209+
name:
7210+
description: The name of the changed resource.
7211+
type: string
7212+
type:
7213+
$ref: '#/components/schemas/ChangeEventAttributesChangedResourceType'
7214+
type: object
7215+
ChangeEventAttributesChangedResourceType:
7216+
description: The type of the changed resource.
7217+
enum:
7218+
- feature_flag
7219+
- configuration
7220+
example: feature_flag
7221+
type: string
7222+
x-enum-varnames:
7223+
- FEATURE_FLAG
7224+
- CONFIGURATION
7225+
ChangeEventAttributesImpactedResourcesItem:
7226+
description: A uniquely identified resource.
7227+
properties:
7228+
name:
7229+
description: The name of the impacted resource.
7230+
type: string
7231+
type:
7232+
$ref: '#/components/schemas/ChangeEventAttributesImpactedResourcesItemType'
7233+
type: object
7234+
ChangeEventAttributesImpactedResourcesItemType:
7235+
description: The type of the impacted resource.
7236+
enum:
7237+
- service
7238+
type: string
7239+
x-enum-varnames:
7240+
- SERVICE
70677241
ChangeEventCustomAttributes:
70687242
additionalProperties: false
70697243
description: Change event attributes.
@@ -14805,6 +14979,44 @@ components:
1480514979
- USER_UPDATE
1480614980
- RECOMMENDATION
1480714981
- SNAPSHOT
14982+
EventSystemAttributes:
14983+
description: JSON object of event system attributes.
14984+
properties:
14985+
category:
14986+
$ref: '#/components/schemas/EventSystemAttributesCategory'
14987+
id:
14988+
description: Event identifier. This field is deprecated and will be removed
14989+
in a future version. Use the `uid` field instead.
14990+
type: string
14991+
integration_id:
14992+
$ref: '#/components/schemas/EventSystemAttributesIntegrationId'
14993+
source_id:
14994+
description: The source type ID of the event.
14995+
format: int64
14996+
type: integer
14997+
uid:
14998+
description: A unique identifier for the event. You can use this identifier
14999+
to query or reference the event.
15000+
type: string
15001+
type: object
15002+
EventSystemAttributesCategory:
15003+
description: Event category identifying the type of event.
15004+
enum:
15005+
- change
15006+
- alert
15007+
example: change
15008+
type: string
15009+
x-enum-varnames:
15010+
- CHANGE
15011+
- ALERT
15012+
EventSystemAttributesIntegrationId:
15013+
description: Integration ID sourced from integration manifests.
15014+
enum:
15015+
- custom-events
15016+
example: custom-events
15017+
type: string
15018+
x-enum-varnames:
15019+
- CUSTOM_EVENTS
1480815020
EventType:
1480915021
default: event
1481015022
description: Type of the event.
@@ -41262,6 +41474,70 @@ components:
4126241474
type: string
4126341475
x-enum-varnames:
4126441476
- USERS
41477+
V2Event:
41478+
description: An event object.
41479+
properties:
41480+
attributes:
41481+
$ref: '#/components/schemas/V2EventAttributes'
41482+
id:
41483+
description: The event's ID.
41484+
example: ''
41485+
type: string
41486+
type:
41487+
description: Entity type.
41488+
example: event
41489+
type: string
41490+
type: object
41491+
V2EventAggregationKey:
41492+
description: Aggregation key of the event.
41493+
example: aggregation-key
41494+
type: string
41495+
V2EventAttributes:
41496+
description: Event attributes.
41497+
properties:
41498+
attributes:
41499+
$ref: '#/components/schemas/V2EventAttributesAttributes'
41500+
message:
41501+
description: Free-formed text associated with the event.
41502+
example: The event message
41503+
type: string
41504+
tags:
41505+
description: A list of tags associated with the event.
41506+
example:
41507+
- env:api_client_test
41508+
items:
41509+
description: A tag.
41510+
type: string
41511+
type: array
41512+
timestamp:
41513+
description: Timestamp when the event occurred.
41514+
example: '2017-01-15T01:30:15.010000Z'
41515+
type: string
41516+
type: object
41517+
V2EventAttributesAttributes:
41518+
description: JSON object for category-specific attributes.
41519+
oneOf:
41520+
- $ref: '#/components/schemas/ChangeEventAttributes'
41521+
- $ref: '#/components/schemas/AlertEventAttributes'
41522+
V2EventResponse:
41523+
description: Get an event response.
41524+
properties:
41525+
data:
41526+
$ref: '#/components/schemas/V2Event'
41527+
type: object
41528+
V2EventService:
41529+
description: Service that triggered the event.
41530+
example: service-name
41531+
type: string
41532+
V2EventTimestamp:
41533+
description: POSIX timestamp of the event.
41534+
example: 175019386627
41535+
format: int64
41536+
type: integer
41537+
V2EventTitle:
41538+
description: The title of the event.
41539+
example: The event title
41540+
type: string
4126541541
ValidationError:
4126641542
description: Represents a single validation error, including a human-readable
4126741543
title and metadata.
@@ -48561,6 +48837,49 @@ paths:
4856148837
type: safe
4856248838
x-merge-override:
4856348839
post: false
48840+
/api/v2/events/{event_id}:
48841+
get:
48842+
description: Get the details of an event by `event_id`.
48843+
operationId: GetEvent
48844+
parameters:
48845+
- description: The UID of the event.
48846+
in: path
48847+
name: event_id
48848+
required: true
48849+
schema:
48850+
type: string
48851+
responses:
48852+
'200':
48853+
content:
48854+
application/json:
48855+
schema:
48856+
$ref: '#/components/schemas/V2EventResponse'
48857+
description: OK
48858+
'400':
48859+
$ref: '#/components/responses/BadRequestResponse'
48860+
'401':
48861+
$ref: '#/components/responses/UnauthorizedResponse'
48862+
'403':
48863+
$ref: '#/components/responses/ForbiddenResponse'
48864+
'404':
48865+
$ref: '#/components/responses/NotFoundResponse'
48866+
'429':
48867+
$ref: '#/components/responses/TooManyRequestsResponse'
48868+
security:
48869+
- apiKeyAuth: []
48870+
appKeyAuth: []
48871+
- AuthZ:
48872+
- events_read
48873+
summary: Get an event
48874+
tags:
48875+
- Events
48876+
x-menu-order: 3
48877+
x-permission:
48878+
operator: OR
48879+
permissions:
48880+
- events_read
48881+
x-undo:
48882+
type: safe
4856448883
/api/v2/incidents:
4856548884
get:
4856648885
description: Get all incidents for the user's organization.

0 commit comments

Comments
 (0)