Skip to content

Commit 5a3cc25

Browse files
author
ci.datadog-api-spec
committed
Regenerate client from commit d5e18a51 of spec repo
1 parent 697b6f4 commit 5a3cc25

File tree

6 files changed

+1872
-72
lines changed

6 files changed

+1872
-72
lines changed

.apigentools-info

+4-4
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-05-02 04:33:31.646842",
8-
"spec_repo_commit": "272cce39"
7+
"regenerated": "2025-05-03 12:38:01.359349",
8+
"spec_repo_commit": "d5e18a51"
99
},
1010
"v2": {
1111
"apigentools_version": "1.6.6",
12-
"regenerated": "2025-05-02 04:33:40.899034",
13-
"spec_repo_commit": "272cce39"
12+
"regenerated": "2025-05-03 12:38:10.356634",
13+
"spec_repo_commit": "d5e18a51"
1414
}
1515
}
1616
}

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

+11-5
Large diffs are not rendered by default.

data/api/v2/full_spec.yaml

+156-6
Original file line numberDiff line numberDiff line change
@@ -2165,6 +2165,89 @@ components:
21652165
- id
21662166
- base_severity
21672167
type: object
2168+
AlertEventCustomAttributes:
2169+
additionalProperties: false
2170+
description: Object representing custom alert event attributes.
2171+
properties:
2172+
custom:
2173+
$ref: '#/components/schemas/AlertEventCustomAttributesCustom'
2174+
links:
2175+
$ref: '#/components/schemas/AlertEventCustomAttributesLinks'
2176+
priority:
2177+
$ref: '#/components/schemas/AlertEventCustomAttributesPriority'
2178+
status:
2179+
$ref: '#/components/schemas/AlertEventCustomAttributesStatus'
2180+
type: object
2181+
AlertEventCustomAttributesCustom:
2182+
additionalProperties: {}
2183+
description: Custom attributes support up to 100 properties and a maximum nesting
2184+
depth of 10 levels.
2185+
example: {}
2186+
type: object
2187+
AlertEventCustomAttributesLinks:
2188+
description: The links related to the event.
2189+
items:
2190+
$ref: '#/components/schemas/AlertEventCustomAttributesLinksItems'
2191+
maxItems: 20
2192+
minItems: 1
2193+
type: array
2194+
AlertEventCustomAttributesLinksItems:
2195+
description: A link.
2196+
properties:
2197+
category:
2198+
$ref: '#/components/schemas/AlertEventCustomAttributesLinksItemsCategory'
2199+
title:
2200+
description: The title of the link.
2201+
example: Runbook Link
2202+
maxLength: 300
2203+
type: string
2204+
url:
2205+
description: The URL of the link.
2206+
example: https://app.datadoghq.com/runbook
2207+
maxLength: 2048
2208+
type: string
2209+
required:
2210+
- url
2211+
- category
2212+
type: object
2213+
AlertEventCustomAttributesLinksItemsCategory:
2214+
description: The category of the link.
2215+
enum:
2216+
- runbook
2217+
example: runbook
2218+
type: string
2219+
x-enum-varnames:
2220+
- RUNBOOK
2221+
AlertEventCustomAttributesPriority:
2222+
description: The priority of the alert.
2223+
enum:
2224+
- '1'
2225+
- '2'
2226+
- '3'
2227+
- '4'
2228+
- '5'
2229+
example: '1'
2230+
type: string
2231+
x-enum-varnames:
2232+
- PRIORITY_ONE
2233+
- PRIORITY_TWO
2234+
- PRIORITY_THREE
2235+
- PRIORITY_FOUR
2236+
- PRIORITY_FIVE
2237+
AlertEventCustomAttributesStatus:
2238+
description: The status of the alert.
2239+
enum:
2240+
- info
2241+
- warn
2242+
- error
2243+
- ok
2244+
example: warn
2245+
type: string
2246+
x-enum-varnames:
2247+
- INFO
2248+
- WARN
2249+
- ERROR
2250+
- OK
21682251
Annotation:
21692252
description: A list of annotations used in the workflow. These are like sticky
21702253
notes for your workflow!
@@ -13829,28 +13912,34 @@ components:
1382913912
type: string
1383013913
type: object
1383113914
EventCategory:
13832-
description: Event category to identify the type of event. Only the value `change`
13833-
is supported. Support for other categories are coming. please reach out to
13834-
datadog support if you're interested.
13915+
description: Event category to identify the type of event. For example, `change`
13916+
or `alert`.
1383513917
enum:
1383613918
- change
13919+
- alert
1383713920
example: change
1383813921
type: string
1383913922
x-enum-varnames:
1384013923
- CHANGE
13924+
- ALERT
1384113925
EventCreateRequest:
1384213926
description: Object representing an event creation request.
1384313927
properties:
1384413928
attributes:
1384513929
$ref: '#/components/schemas/EventPayload'
1384613930
type:
1384713931
$ref: '#/components/schemas/EventCreateRequestType'
13932+
required:
13933+
- type
13934+
- attributes
1384813935
type: object
1384913936
EventCreateRequestPayload:
1385013937
description: Payload for creating an event.
1385113938
properties:
1385213939
data:
1385313940
$ref: '#/components/schemas/EventCreateRequest'
13941+
required:
13942+
- data
1385413943
type: object
1385513944
EventCreateRequestType:
1385613945
description: Entity type.
@@ -13865,6 +13954,10 @@ components:
1386513954
properties:
1386613955
attributes:
1386713956
$ref: '#/components/schemas/EventCreateResponseAttributes'
13957+
id:
13958+
description: Event ID
13959+
example: _
13960+
type: string
1386813961
type:
1386913962
description: Event type
1387013963
example: event
@@ -13886,28 +13979,46 @@ components:
1388613979
EventCreateResponseAttributesAttributesEvt:
1388713980
description: JSON object of event system attributes.
1388813981
properties:
13889-
id:
13890-
description: Event id
13982+
uid:
13983+
description: Event UID
13984+
example: ABCDEFGHIJKLMNOPQRSTUVWX
1389113985
type: string
1389213986
type: object
1389313987
EventCreateResponsePayload:
1389413988
description: Response containing information about created event.
1389513989
properties:
1389613990
data:
1389713991
$ref: '#/components/schemas/EventCreateResponse'
13992+
links:
13993+
$ref: '#/components/schemas/EventCreateResponsePayloadLinks'
13994+
type: object
13995+
EventCreateResponsePayloadLinks:
13996+
description: Links attributes.
13997+
properties:
13998+
self:
13999+
description: The URL of the event.
14000+
example: https://app.datadoghq.com/event/event?id=123
14001+
type: string
1389814002
type: object
1389914003
EventPayload:
1390014004
description: Event attributes.
1390114005
properties:
1390214006
aggregation_key:
1390314007
description: An arbitrary string to use for aggregation when correlating
1390414008
events. Limited to 100 characters.
14009+
example: aggregation_key_123
1390514010
maxLength: 100
1390614011
type: string
1390714012
attributes:
1390814013
$ref: '#/components/schemas/EventPayloadAttributes'
1390914014
category:
1391014015
$ref: '#/components/schemas/EventCategory'
14016+
integration_id:
14017+
description: Integration IDs sourced from manifests. Examples include custom-events,
14018+
containerd, docker, elasticsearch, helm, mongodb, mysql, and nagios. See
14019+
the full list of available IDs [here](https://docs.datadoghq.com/getting_started/integrations/).
14020+
example: custom-events
14021+
type: string
1391114022
message:
1391214023
description: The body of the event. Limited to 4000 characters.
1391314024
example: payment_processed feature flag has been enabled
@@ -13921,7 +14032,10 @@ components:
1392114032
- env:test
1392214033
items:
1392314034
description: A tag.
14035+
maxLength: 200
1392414036
type: string
14037+
maxItems: 100
14038+
minItems: 1
1392514039
type: array
1392614040
timestamp:
1392714041
description: 'Timestamp when the event occurred. Must follow [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html)
@@ -13947,6 +14061,7 @@ components:
1394714061
event category.
1394814062
oneOf:
1394914063
- $ref: '#/components/schemas/ChangeEventCustomAttributes'
14064+
- $ref: '#/components/schemas/AlertEventCustomAttributes'
1395014065
EventPriority:
1395114066
description: The priority of the event's monitor. For example, `normal` or `low`.
1395214067
enum:
@@ -46413,7 +46528,8 @@ paths:
4641346528
type: safe
4641446529
post:
4641546530
description: "This endpoint allows you to post events.\n\n\u2705 **Only events
46416-
with the `change` category** are in General Availability. See [Change Tracking](https://docs.datadoghq.com/change_tracking)
46531+
with the `change` or `alert` category** are in General Availability. For change
46532+
events, see [Change Tracking](https://docs.datadoghq.com/change_tracking)
4641746533
for more details.\n\n\u274C For use cases involving other event categories,
4641846534
please use the V1 endpoint."
4641946535
operationId: CreateEvent
@@ -46425,6 +46541,7 @@ paths:
4642546541
value:
4642646542
data:
4642746543
attributes:
46544+
aggregation_key: aggregation_key_123
4642846545
attributes:
4642946546
author:
4643046547
@@ -46453,6 +46570,7 @@ paths:
4645346570
rule:
4645446571
datacenter: devcycle.us1.prod
4645546572
category: change
46573+
integration_id: custom-events
4645646574
message: payment_processed feature flag has been enabled
4645746575
tags:
4645846576
- env:test
@@ -46486,6 +46604,38 @@ paths:
4648646604
security:
4648746605
- apiKeyAuth: []
4648846606
appKeyAuth: []
46607+
servers:
46608+
- url: https://{subdomain}.{site}
46609+
variables:
46610+
site:
46611+
default: datadoghq.com
46612+
description: The regional site for customers.
46613+
enum:
46614+
- datadoghq.com
46615+
- us3.datadoghq.com
46616+
- us5.datadoghq.com
46617+
- ap1.datadoghq.com
46618+
- datadoghq.eu
46619+
- ddog-gov.com
46620+
subdomain:
46621+
default: event-management-intake
46622+
description: The subdomain where the API is deployed.
46623+
- url: '{protocol}://{name}'
46624+
variables:
46625+
name:
46626+
default: event-management-intake.datadoghq.com
46627+
description: Full site DNS name.
46628+
protocol:
46629+
default: https
46630+
description: The protocol for accessing the API.
46631+
- url: https://{subdomain}.{site}
46632+
variables:
46633+
site:
46634+
default: datadoghq.com
46635+
description: Any Datadog deployment.
46636+
subdomain:
46637+
default: event-management-intake
46638+
description: The subdomain where the API is deployed.
4648946639
summary: Post an event
4649046640
tags:
4649146641
- Events

0 commit comments

Comments
 (0)