diff --git a/.apigentools-info b/.apigentools-info index 09645d506569f..b11c73c5ad505 100644 --- a/.apigentools-info +++ b/.apigentools-info @@ -4,13 +4,13 @@ "spec_versions": { "v1": { "apigentools_version": "1.6.6", - "regenerated": "2025-06-19 12:13:56.197351", - "spec_repo_commit": "a171e0a8" + "regenerated": "2025-06-20 13:51:30.860715", + "spec_repo_commit": "78730ba3" }, "v2": { "apigentools_version": "1.6.6", - "regenerated": "2025-06-19 12:14:05.477000", - "spec_repo_commit": "a171e0a8" + "regenerated": "2025-06-20 13:51:40.463493", + "spec_repo_commit": "78730ba3" } } } \ No newline at end of file diff --git a/config/_default/menus/api.en.yaml b/config/_default/menus/api.en.yaml index df5f71ec89bfa..31dd98412f977 100644 --- a/config/_default/menus/api.en.yaml +++ b/config/_default/menus/api.en.yaml @@ -838,6 +838,7 @@ menu: params: versions: - v1 + - v2 operationids: - GetEvent unstable: [] diff --git a/content/en/api/v2/events/examples.json b/content/en/api/v2/events/examples.json index c51f2ad8cb6bc..4e7873879a25e 100644 --- a/content/en/api/v2/events/examples.json +++ b/content/en/api/v2/events/examples.json @@ -385,5 +385,119 @@ }, "html": "
\n
\n
\n
\n

filter

\n
\n

object

\n

The search and filter query settings.

\n
\n
\n
\n
\n
\n

from

\n
\n

string

\n

The minimum time for the requested events. Supports date math and regular timestamps in milliseconds.

default: now-15m

\n
\n \n
\n
\n
\n
\n
\n

query

\n
\n

string

\n

The search query following the event search syntax.

default: *

\n
\n \n
\n
\n
\n
\n
\n

to

\n
\n

string

\n

The maximum time for the requested events. Supports date math and regular timestamps in milliseconds.

default: now

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

options

\n
\n

object

\n

The global query options that are used. Either provide a timezone or a time offset but not both,\notherwise the query fails.

\n
\n
\n
\n
\n
\n

timeOffset

\n
\n

int64

\n

The time offset to apply to the query in seconds.

\n
\n \n
\n
\n
\n
\n
\n

timezone

\n
\n

string

\n

The timezone can be specified as GMT, UTC, an offset from UTC (like UTC+1), or as a Timezone Database identifier (like America/New_York).

default: UTC

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

page

\n
\n

object

\n

Pagination settings.

\n
\n
\n
\n
\n
\n

cursor

\n
\n

string

\n

The returned paging point to use to get the next results.

\n
\n \n
\n
\n
\n
\n
\n

limit

\n
\n

int32

\n

The maximum number of logs in the response.

default: 10

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

sort

\n
\n

enum

\n

The sort parameters when querying events. \nAllowed enum values: timestamp,-timestamp

\n
\n \n
\n
" } + }, + "GetEvent": { + "responses": { + "200": { + "json": { + "data": { + "attributes": { + "attributes": { + "aggregation_key": "aggregation-key", + "author": { + "name": "example@datadog.com", + "type": "user" + }, + "change_metadata": { + "dd": { + "team": "datadog_team", + "user_email": "datadog@datadog.com", + "user_id": "datadog_user_id", + "user_name": "datadog_username" + } + }, + "changed_resource": { + "name": "string", + "type": "feature_flag" + }, + "evt": { + "category": "change", + "id": "string", + "integration_id": "custom-events", + "source_id": "integer", + "uid": "string" + }, + "impacted_resources": [ + { + "name": "service-name", + "type": "service" + } + ], + "new_value": { + "enabled": true, + "percentage": "50%", + "rule": { + "datacenter": "devcycle.us1.prod" + } + }, + "prev_value": { + "enabled": true, + "percentage": "10%", + "rule": { + "datacenter": "devcycle.us1.prod" + } + }, + "service": "service-name", + "timestamp": 175019386627, + "title": "The event title" + }, + "message": "The event message", + "tags": [ + "env:api_client_test" + ], + "timestamp": "2017-01-15T01:30:15.010000Z" + }, + "id": "", + "type": "event" + } + }, + "html": "
\n
\n
\n
\n

data

\n
\n

object

\n

An event object.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Event attributes.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

 <oneOf>

\n

JSON object for category-specific attributes.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n

Change event attributes.

\n
\n
\n
\n
\n
\n

aggregation_key

\n
\n

string

\n

Aggregation key of the event.

\n
\n \n
\n
\n
\n
\n
\n

author

\n
\n

object

\n

The entity that made the change.

\n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The name of the user or system that made the change.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

The type of the author. \nAllowed enum values: user,system

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

change_metadata

\n
\n

object

\n

JSON object of change metadata.

\n
\n \n
\n
\n
\n
\n
\n

changed_resource

\n
\n

object

\n

A uniquely identified resource.

\n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The name of the changed resource.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

The type of the changed resource. \nAllowed enum values: feature_flag,configuration

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

evt

\n
\n

object

\n

JSON object of event system attributes.

\n
\n
\n
\n
\n
\n

category

\n
\n

enum

\n

Event category identifying the type of event. \nAllowed enum values: change,alert

\n
\n \n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

Event identifier. This field is deprecated and will be removed in a future version. Use the uid field instead.

\n
\n \n
\n
\n
\n
\n
\n

integration_id

\n
\n

enum

\n

Integration ID sourced from integration manifests. \nAllowed enum values: custom-events

\n
\n \n
\n
\n
\n
\n
\n

source_id

\n
\n

int64

\n

The source type ID of the event.

\n
\n \n
\n
\n
\n
\n
\n

uid

\n
\n

string

\n

A unique identifier for the event. You can use this identifier to query or reference the event.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

impacted_resources

\n
\n

[object]

\n

A list of resources impacted by this change.

\n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The name of the impacted resource.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

The type of the impacted resource. \nAllowed enum values: service

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

new_value

\n
\n

object

\n

The new state of the changed resource.

\n
\n \n
\n
\n
\n
\n
\n

prev_value

\n
\n

object

\n

The previous state of the changed resource.

\n
\n \n
\n
\n
\n
\n
\n

service

\n
\n

string

\n

Service that triggered the event.

\n
\n \n
\n
\n
\n
\n
\n

timestamp

\n
\n

int64

\n

POSIX timestamp of the event.

\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

The title of the event.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 2

\n
\n

object

\n

Alert event attributes.

\n
\n
\n
\n
\n
\n

aggregation_key

\n
\n

string

\n

Aggregation key of the event.

\n
\n \n
\n
\n
\n
\n
\n

custom

\n
\n

object

\n

JSON object of custom attributes.

\n
\n \n
\n
\n
\n
\n
\n

evt

\n
\n

object

\n

JSON object of event system attributes.

\n
\n
\n
\n
\n
\n

category

\n
\n

enum

\n

Event category identifying the type of event. \nAllowed enum values: change,alert

\n
\n \n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

Event identifier. This field is deprecated and will be removed in a future version. Use the uid field instead.

\n
\n \n
\n
\n
\n
\n
\n

integration_id

\n
\n

enum

\n

Integration ID sourced from integration manifests. \nAllowed enum values: custom-events

\n
\n \n
\n
\n
\n
\n
\n

source_id

\n
\n

int64

\n

The source type ID of the event.

\n
\n \n
\n
\n
\n
\n
\n

uid

\n
\n

string

\n

A unique identifier for the event. You can use this identifier to query or reference the event.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

links

\n
\n

[object]

\n

The links related to the event.

\n
\n
\n
\n
\n
\n

category

\n
\n

enum

\n

The category of the link. \nAllowed enum values: runbook,documentation,dashboard

\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

The display text of the link.

\n
\n \n
\n
\n
\n
\n
\n

url

\n
\n

string

\n

The URL of the link.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

priority

\n
\n

enum

\n

The priority of the alert. \nAllowed enum values: 1,2,3,4,5

\n
\n \n
\n
\n
\n
\n
\n

service

\n
\n

string

\n

Service that triggered the event.

\n
\n \n
\n
\n
\n
\n
\n

timestamp

\n
\n

int64

\n

POSIX timestamp of the event.

\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

The title of the event.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

message

\n
\n

string

\n

Free-formed text associated with the event.

\n
\n \n
\n
\n
\n
\n
\n

tags

\n
\n

[string]

\n

A list of tags associated with the event.

\n
\n \n
\n
\n
\n
\n
\n

timestamp

\n
\n

string

\n

Timestamp when the event occurred.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

The event's ID.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

string

\n

Entity type.

\n
\n \n
\n
\n
\n
" + }, + "400": { + "json": { + "errors": [ + "Bad Request" + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[string]

\n

A list of errors.

\n
\n \n
\n
" + }, + "401": { + "json": { + "errors": [ + "Bad Request" + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[string]

\n

A list of errors.

\n
\n \n
\n
" + }, + "403": { + "json": { + "errors": [ + "Bad Request" + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[string]

\n

A list of errors.

\n
\n \n
\n
" + }, + "404": { + "json": { + "errors": [ + "Bad Request" + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[string]

\n

A list of errors.

\n
\n \n
\n
" + }, + "429": { + "json": { + "errors": [ + "Bad Request" + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[string]

\n

A list of errors.

\n
\n \n
\n
" + } + }, + "request": { + "json_curl": {}, + "json": {}, + "html": "" + } } } \ No newline at end of file diff --git a/data/api/v2/full_spec.yaml b/data/api/v2/full_spec.yaml index 9b69d23ee6d49..8950a8a8a5448 100644 --- a/data/api/v2/full_spec.yaml +++ b/data/api/v2/full_spec.yaml @@ -2254,6 +2254,74 @@ 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' + 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 AlertEventCustomAttributes: additionalProperties: false description: Alert event attributes. @@ -7064,6 +7132,112 @@ 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: datadog@datadog.com + 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: example@datadog.com + type: string + type: + $ref: '#/components/schemas/ChangeEventAttributesAuthorType' + type: object + ChangeEventAttributesAuthorType: + description: The type of the author. + enum: + - user + - system + example: user + type: string + x-enum-varnames: + - USER + - SYSTEM + 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. @@ -14805,6 +14979,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. @@ -41262,6 +41474,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-formed 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. @@ -48561,6 +48837,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. diff --git a/data/api/v2/full_spec_deref.json b/data/api/v2/full_spec_deref.json index 5027787dd8a8c..ddc01474328a8 100644 --- a/data/api/v2/full_spec_deref.json +++ b/data/api/v2/full_spec_deref.json @@ -11319,6 +11319,200 @@ ], "type": "object" }, + "AlertEventAttributes": { + "description": "Alert event attributes.", + "properties": { + "aggregation_key": { + "description": "Aggregation key of the event.", + "example": "aggregation-key", + "type": "string" + }, + "custom": { + "description": "JSON object of custom attributes.", + "example": {}, + "type": "object" + }, + "evt": { + "description": "JSON object of event system attributes.", + "properties": { + "category": { + "description": "Event category identifying the type of event.", + "enum": [ + "change", + "alert" + ], + "example": "change", + "type": "string", + "x-enum-varnames": [ + "CHANGE", + "ALERT" + ] + }, + "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": { + "description": "Integration ID sourced from integration manifests.", + "enum": [ + "custom-events" + ], + "example": "custom-events", + "type": "string", + "x-enum-varnames": [ + "CUSTOM_EVENTS" + ] + }, + "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" + }, + "links": { + "description": "The links related to the event.", + "example": [ + { + "category": "runbook", + "title": "Runbook Link", + "url": "https://app.datadoghq.com/runbook" + } + ], + "items": { + "description": "A link.", + "properties": { + "category": { + "description": "The category of the link.", + "enum": [ + "runbook", + "documentation", + "dashboard" + ], + "type": "string", + "x-enum-varnames": [ + "RUNBOOK", + "DOCUMENTATION", + "DASHBOARD" + ] + }, + "title": { + "description": "The display text of the link.", + "type": "string" + }, + "url": { + "description": "The URL of the link.", + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "priority": { + "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" + ] + }, + "service": { + "description": "Service that triggered the event.", + "example": "service-name", + "type": "string" + }, + "timestamp": { + "description": "POSIX timestamp of the event.", + "example": 175019386627, + "format": "int64", + "type": "integer" + }, + "title": { + "description": "The title of the event.", + "example": "The event title", + "type": "string" + } + }, + "type": "object" + }, + "AlertEventAttributesLinksItem": { + "description": "A link.", + "properties": { + "category": { + "description": "The category of the link.", + "enum": [ + "runbook", + "documentation", + "dashboard" + ], + "type": "string", + "x-enum-varnames": [ + "RUNBOOK", + "DOCUMENTATION", + "DASHBOARD" + ] + }, + "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" + ] + }, "AlertEventCustomAttributes": { "additionalProperties": false, "description": "Alert event attributes.", @@ -41165,6 +41359,290 @@ }, "type": "object" }, + "ChangeEventAttributes": { + "description": "Change event attributes.", + "properties": { + "aggregation_key": { + "description": "Aggregation key of the event.", + "example": "aggregation-key", + "type": "string" + }, + "author": { + "description": "The entity that made the change.", + "properties": { + "name": { + "description": "The name of the user or system that made the change.", + "example": "example@datadog.com", + "type": "string" + }, + "type": { + "description": "The type of the author.", + "enum": [ + "user", + "system" + ], + "example": "user", + "type": "string", + "x-enum-varnames": [ + "USER", + "SYSTEM" + ] + } + }, + "type": "object" + }, + "change_metadata": { + "description": "JSON object of change metadata.", + "example": { + "dd": { + "team": "datadog_team", + "user_email": "datadog@datadog.com", + "user_id": "datadog_user_id", + "user_name": "datadog_username" + } + }, + "type": "object" + }, + "changed_resource": { + "description": "A uniquely identified resource.", + "properties": { + "name": { + "description": "The name of the changed resource.", + "type": "string" + }, + "type": { + "description": "The type of the changed resource.", + "enum": [ + "feature_flag", + "configuration" + ], + "example": "feature_flag", + "type": "string", + "x-enum-varnames": [ + "FEATURE_FLAG", + "CONFIGURATION" + ] + } + }, + "type": "object" + }, + "evt": { + "description": "JSON object of event system attributes.", + "properties": { + "category": { + "description": "Event category identifying the type of event.", + "enum": [ + "change", + "alert" + ], + "example": "change", + "type": "string", + "x-enum-varnames": [ + "CHANGE", + "ALERT" + ] + }, + "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": { + "description": "Integration ID sourced from integration manifests.", + "enum": [ + "custom-events" + ], + "example": "custom-events", + "type": "string", + "x-enum-varnames": [ + "CUSTOM_EVENTS" + ] + }, + "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" + }, + "impacted_resources": { + "description": "A list of resources impacted by this change.", + "example": [ + { + "name": "service-name", + "type": "service" + } + ], + "items": { + "description": "A uniquely identified resource.", + "properties": { + "name": { + "description": "The name of the impacted resource.", + "type": "string" + }, + "type": { + "description": "The type of the impacted resource.", + "enum": [ + "service" + ], + "type": "string", + "x-enum-varnames": [ + "SERVICE" + ] + } + }, + "type": "object" + }, + "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": { + "description": "Service that triggered the event.", + "example": "service-name", + "type": "string" + }, + "timestamp": { + "description": "POSIX timestamp of the event.", + "example": 175019386627, + "format": "int64", + "type": "integer" + }, + "title": { + "description": "The title of the event.", + "example": "The event title", + "type": "string" + } + }, + "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": "example@datadog.com", + "type": "string" + }, + "type": { + "description": "The type of the author.", + "enum": [ + "user", + "system" + ], + "example": "user", + "type": "string", + "x-enum-varnames": [ + "USER", + "SYSTEM" + ] + } + }, + "type": "object" + }, + "ChangeEventAttributesAuthorType": { + "description": "The type of the author.", + "enum": [ + "user", + "system" + ], + "example": "user", + "type": "string", + "x-enum-varnames": [ + "USER", + "SYSTEM" + ] + }, + "ChangeEventAttributesChangedResource": { + "description": "A uniquely identified resource.", + "properties": { + "name": { + "description": "The name of the changed resource.", + "type": "string" + }, + "type": { + "description": "The type of the changed resource.", + "enum": [ + "feature_flag", + "configuration" + ], + "example": "feature_flag", + "type": "string", + "x-enum-varnames": [ + "FEATURE_FLAG", + "CONFIGURATION" + ] + } + }, + "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": { + "description": "The type of the impacted resource.", + "enum": [ + "service" + ], + "type": "string", + "x-enum-varnames": [ + "SERVICE" + ] + } + }, + "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.", @@ -87014,6 +87492,73 @@ "SNAPSHOT" ] }, + "EventSystemAttributes": { + "description": "JSON object of event system attributes.", + "properties": { + "category": { + "description": "Event category identifying the type of event.", + "enum": [ + "change", + "alert" + ], + "example": "change", + "type": "string", + "x-enum-varnames": [ + "CHANGE", + "ALERT" + ] + }, + "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": { + "description": "Integration ID sourced from integration manifests.", + "enum": [ + "custom-events" + ], + "example": "custom-events", + "type": "string", + "x-enum-varnames": [ + "CUSTOM_EVENTS" + ] + }, + "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.", @@ -303124,6 +303669,1422 @@ "USERS" ] }, + "V2Event": { + "description": "An event object.", + "properties": { + "attributes": { + "description": "Event attributes.", + "properties": { + "attributes": { + "description": "JSON object for category-specific attributes.", + "oneOf": [ + { + "description": "Change event attributes.", + "properties": { + "aggregation_key": { + "description": "Aggregation key of the event.", + "example": "aggregation-key", + "type": "string" + }, + "author": { + "description": "The entity that made the change.", + "properties": { + "name": { + "description": "The name of the user or system that made the change.", + "example": "example@datadog.com", + "type": "string" + }, + "type": { + "description": "The type of the author.", + "enum": [ + "user", + "system" + ], + "example": "user", + "type": "string", + "x-enum-varnames": [ + "USER", + "SYSTEM" + ] + } + }, + "type": "object" + }, + "change_metadata": { + "description": "JSON object of change metadata.", + "example": { + "dd": { + "team": "datadog_team", + "user_email": "datadog@datadog.com", + "user_id": "datadog_user_id", + "user_name": "datadog_username" + } + }, + "type": "object" + }, + "changed_resource": { + "description": "A uniquely identified resource.", + "properties": { + "name": { + "description": "The name of the changed resource.", + "type": "string" + }, + "type": { + "description": "The type of the changed resource.", + "enum": [ + "feature_flag", + "configuration" + ], + "example": "feature_flag", + "type": "string", + "x-enum-varnames": [ + "FEATURE_FLAG", + "CONFIGURATION" + ] + } + }, + "type": "object" + }, + "evt": { + "description": "JSON object of event system attributes.", + "properties": { + "category": { + "description": "Event category identifying the type of event.", + "enum": [ + "change", + "alert" + ], + "example": "change", + "type": "string", + "x-enum-varnames": [ + "CHANGE", + "ALERT" + ] + }, + "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": { + "description": "Integration ID sourced from integration manifests.", + "enum": [ + "custom-events" + ], + "example": "custom-events", + "type": "string", + "x-enum-varnames": [ + "CUSTOM_EVENTS" + ] + }, + "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" + }, + "impacted_resources": { + "description": "A list of resources impacted by this change.", + "example": [ + { + "name": "service-name", + "type": "service" + } + ], + "items": { + "description": "A uniquely identified resource.", + "properties": { + "name": { + "description": "The name of the impacted resource.", + "type": "string" + }, + "type": { + "description": "The type of the impacted resource.", + "enum": [ + "service" + ], + "type": "string", + "x-enum-varnames": [ + "SERVICE" + ] + } + }, + "type": "object" + }, + "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": { + "description": "Service that triggered the event.", + "example": "service-name", + "type": "string" + }, + "timestamp": { + "description": "POSIX timestamp of the event.", + "example": 175019386627, + "format": "int64", + "type": "integer" + }, + "title": { + "description": "The title of the event.", + "example": "The event title", + "type": "string" + } + }, + "type": "object" + }, + { + "description": "Alert event attributes.", + "properties": { + "aggregation_key": { + "description": "Aggregation key of the event.", + "example": "aggregation-key", + "type": "string" + }, + "custom": { + "description": "JSON object of custom attributes.", + "example": {}, + "type": "object" + }, + "evt": { + "description": "JSON object of event system attributes.", + "properties": { + "category": { + "description": "Event category identifying the type of event.", + "enum": [ + "change", + "alert" + ], + "example": "change", + "type": "string", + "x-enum-varnames": [ + "CHANGE", + "ALERT" + ] + }, + "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": { + "description": "Integration ID sourced from integration manifests.", + "enum": [ + "custom-events" + ], + "example": "custom-events", + "type": "string", + "x-enum-varnames": [ + "CUSTOM_EVENTS" + ] + }, + "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" + }, + "links": { + "description": "The links related to the event.", + "example": [ + { + "category": "runbook", + "title": "Runbook Link", + "url": "https://app.datadoghq.com/runbook" + } + ], + "items": { + "description": "A link.", + "properties": { + "category": { + "description": "The category of the link.", + "enum": [ + "runbook", + "documentation", + "dashboard" + ], + "type": "string", + "x-enum-varnames": [ + "RUNBOOK", + "DOCUMENTATION", + "DASHBOARD" + ] + }, + "title": { + "description": "The display text of the link.", + "type": "string" + }, + "url": { + "description": "The URL of the link.", + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "priority": { + "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" + ] + }, + "service": { + "description": "Service that triggered the event.", + "example": "service-name", + "type": "string" + }, + "timestamp": { + "description": "POSIX timestamp of the event.", + "example": 175019386627, + "format": "int64", + "type": "integer" + }, + "title": { + "description": "The title of the event.", + "example": "The event title", + "type": "string" + } + }, + "type": "object" + } + ] + }, + "message": { + "description": "Free-formed 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" + }, + "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": { + "description": "JSON object for category-specific attributes.", + "oneOf": [ + { + "description": "Change event attributes.", + "properties": { + "aggregation_key": { + "description": "Aggregation key of the event.", + "example": "aggregation-key", + "type": "string" + }, + "author": { + "description": "The entity that made the change.", + "properties": { + "name": { + "description": "The name of the user or system that made the change.", + "example": "example@datadog.com", + "type": "string" + }, + "type": { + "description": "The type of the author.", + "enum": [ + "user", + "system" + ], + "example": "user", + "type": "string", + "x-enum-varnames": [ + "USER", + "SYSTEM" + ] + } + }, + "type": "object" + }, + "change_metadata": { + "description": "JSON object of change metadata.", + "example": { + "dd": { + "team": "datadog_team", + "user_email": "datadog@datadog.com", + "user_id": "datadog_user_id", + "user_name": "datadog_username" + } + }, + "type": "object" + }, + "changed_resource": { + "description": "A uniquely identified resource.", + "properties": { + "name": { + "description": "The name of the changed resource.", + "type": "string" + }, + "type": { + "description": "The type of the changed resource.", + "enum": [ + "feature_flag", + "configuration" + ], + "example": "feature_flag", + "type": "string", + "x-enum-varnames": [ + "FEATURE_FLAG", + "CONFIGURATION" + ] + } + }, + "type": "object" + }, + "evt": { + "description": "JSON object of event system attributes.", + "properties": { + "category": { + "description": "Event category identifying the type of event.", + "enum": [ + "change", + "alert" + ], + "example": "change", + "type": "string", + "x-enum-varnames": [ + "CHANGE", + "ALERT" + ] + }, + "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": { + "description": "Integration ID sourced from integration manifests.", + "enum": [ + "custom-events" + ], + "example": "custom-events", + "type": "string", + "x-enum-varnames": [ + "CUSTOM_EVENTS" + ] + }, + "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" + }, + "impacted_resources": { + "description": "A list of resources impacted by this change.", + "example": [ + { + "name": "service-name", + "type": "service" + } + ], + "items": { + "description": "A uniquely identified resource.", + "properties": { + "name": { + "description": "The name of the impacted resource.", + "type": "string" + }, + "type": { + "description": "The type of the impacted resource.", + "enum": [ + "service" + ], + "type": "string", + "x-enum-varnames": [ + "SERVICE" + ] + } + }, + "type": "object" + }, + "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": { + "description": "Service that triggered the event.", + "example": "service-name", + "type": "string" + }, + "timestamp": { + "description": "POSIX timestamp of the event.", + "example": 175019386627, + "format": "int64", + "type": "integer" + }, + "title": { + "description": "The title of the event.", + "example": "The event title", + "type": "string" + } + }, + "type": "object" + }, + { + "description": "Alert event attributes.", + "properties": { + "aggregation_key": { + "description": "Aggregation key of the event.", + "example": "aggregation-key", + "type": "string" + }, + "custom": { + "description": "JSON object of custom attributes.", + "example": {}, + "type": "object" + }, + "evt": { + "description": "JSON object of event system attributes.", + "properties": { + "category": { + "description": "Event category identifying the type of event.", + "enum": [ + "change", + "alert" + ], + "example": "change", + "type": "string", + "x-enum-varnames": [ + "CHANGE", + "ALERT" + ] + }, + "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": { + "description": "Integration ID sourced from integration manifests.", + "enum": [ + "custom-events" + ], + "example": "custom-events", + "type": "string", + "x-enum-varnames": [ + "CUSTOM_EVENTS" + ] + }, + "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" + }, + "links": { + "description": "The links related to the event.", + "example": [ + { + "category": "runbook", + "title": "Runbook Link", + "url": "https://app.datadoghq.com/runbook" + } + ], + "items": { + "description": "A link.", + "properties": { + "category": { + "description": "The category of the link.", + "enum": [ + "runbook", + "documentation", + "dashboard" + ], + "type": "string", + "x-enum-varnames": [ + "RUNBOOK", + "DOCUMENTATION", + "DASHBOARD" + ] + }, + "title": { + "description": "The display text of the link.", + "type": "string" + }, + "url": { + "description": "The URL of the link.", + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "priority": { + "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" + ] + }, + "service": { + "description": "Service that triggered the event.", + "example": "service-name", + "type": "string" + }, + "timestamp": { + "description": "POSIX timestamp of the event.", + "example": 175019386627, + "format": "int64", + "type": "integer" + }, + "title": { + "description": "The title of the event.", + "example": "The event title", + "type": "string" + } + }, + "type": "object" + } + ] + }, + "message": { + "description": "Free-formed 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": [ + { + "description": "Change event attributes.", + "properties": { + "aggregation_key": { + "description": "Aggregation key of the event.", + "example": "aggregation-key", + "type": "string" + }, + "author": { + "description": "The entity that made the change.", + "properties": { + "name": { + "description": "The name of the user or system that made the change.", + "example": "example@datadog.com", + "type": "string" + }, + "type": { + "description": "The type of the author.", + "enum": [ + "user", + "system" + ], + "example": "user", + "type": "string", + "x-enum-varnames": [ + "USER", + "SYSTEM" + ] + } + }, + "type": "object" + }, + "change_metadata": { + "description": "JSON object of change metadata.", + "example": { + "dd": { + "team": "datadog_team", + "user_email": "datadog@datadog.com", + "user_id": "datadog_user_id", + "user_name": "datadog_username" + } + }, + "type": "object" + }, + "changed_resource": { + "description": "A uniquely identified resource.", + "properties": { + "name": { + "description": "The name of the changed resource.", + "type": "string" + }, + "type": { + "description": "The type of the changed resource.", + "enum": [ + "feature_flag", + "configuration" + ], + "example": "feature_flag", + "type": "string", + "x-enum-varnames": [ + "FEATURE_FLAG", + "CONFIGURATION" + ] + } + }, + "type": "object" + }, + "evt": { + "description": "JSON object of event system attributes.", + "properties": { + "category": { + "description": "Event category identifying the type of event.", + "enum": [ + "change", + "alert" + ], + "example": "change", + "type": "string", + "x-enum-varnames": [ + "CHANGE", + "ALERT" + ] + }, + "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": { + "description": "Integration ID sourced from integration manifests.", + "enum": [ + "custom-events" + ], + "example": "custom-events", + "type": "string", + "x-enum-varnames": [ + "CUSTOM_EVENTS" + ] + }, + "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" + }, + "impacted_resources": { + "description": "A list of resources impacted by this change.", + "example": [ + { + "name": "service-name", + "type": "service" + } + ], + "items": { + "description": "A uniquely identified resource.", + "properties": { + "name": { + "description": "The name of the impacted resource.", + "type": "string" + }, + "type": { + "description": "The type of the impacted resource.", + "enum": [ + "service" + ], + "type": "string", + "x-enum-varnames": [ + "SERVICE" + ] + } + }, + "type": "object" + }, + "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": { + "description": "Service that triggered the event.", + "example": "service-name", + "type": "string" + }, + "timestamp": { + "description": "POSIX timestamp of the event.", + "example": 175019386627, + "format": "int64", + "type": "integer" + }, + "title": { + "description": "The title of the event.", + "example": "The event title", + "type": "string" + } + }, + "type": "object" + }, + { + "description": "Alert event attributes.", + "properties": { + "aggregation_key": { + "description": "Aggregation key of the event.", + "example": "aggregation-key", + "type": "string" + }, + "custom": { + "description": "JSON object of custom attributes.", + "example": {}, + "type": "object" + }, + "evt": { + "description": "JSON object of event system attributes.", + "properties": { + "category": { + "description": "Event category identifying the type of event.", + "enum": [ + "change", + "alert" + ], + "example": "change", + "type": "string", + "x-enum-varnames": [ + "CHANGE", + "ALERT" + ] + }, + "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": { + "description": "Integration ID sourced from integration manifests.", + "enum": [ + "custom-events" + ], + "example": "custom-events", + "type": "string", + "x-enum-varnames": [ + "CUSTOM_EVENTS" + ] + }, + "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" + }, + "links": { + "description": "The links related to the event.", + "example": [ + { + "category": "runbook", + "title": "Runbook Link", + "url": "https://app.datadoghq.com/runbook" + } + ], + "items": { + "description": "A link.", + "properties": { + "category": { + "description": "The category of the link.", + "enum": [ + "runbook", + "documentation", + "dashboard" + ], + "type": "string", + "x-enum-varnames": [ + "RUNBOOK", + "DOCUMENTATION", + "DASHBOARD" + ] + }, + "title": { + "description": "The display text of the link.", + "type": "string" + }, + "url": { + "description": "The URL of the link.", + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "priority": { + "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" + ] + }, + "service": { + "description": "Service that triggered the event.", + "example": "service-name", + "type": "string" + }, + "timestamp": { + "description": "POSIX timestamp of the event.", + "example": 175019386627, + "format": "int64", + "type": "integer" + }, + "title": { + "description": "The title of the event.", + "example": "The event title", + "type": "string" + } + }, + "type": "object" + } + ] + }, + "V2EventResponse": { + "description": "Get an event response.", + "properties": { + "data": { + "description": "An event object.", + "properties": { + "attributes": { + "description": "Event attributes.", + "properties": { + "attributes": { + "description": "JSON object for category-specific attributes.", + "oneOf": [ + { + "description": "Change event attributes.", + "properties": { + "aggregation_key": { + "description": "Aggregation key of the event.", + "example": "aggregation-key", + "type": "string" + }, + "author": { + "description": "The entity that made the change.", + "properties": { + "name": { + "description": "The name of the user or system that made the change.", + "example": "example@datadog.com", + "type": "string" + }, + "type": { + "description": "The type of the author.", + "enum": [ + "user", + "system" + ], + "example": "user", + "type": "string", + "x-enum-varnames": [ + "USER", + "SYSTEM" + ] + } + }, + "type": "object" + }, + "change_metadata": { + "description": "JSON object of change metadata.", + "example": { + "dd": { + "team": "datadog_team", + "user_email": "datadog@datadog.com", + "user_id": "datadog_user_id", + "user_name": "datadog_username" + } + }, + "type": "object" + }, + "changed_resource": { + "description": "A uniquely identified resource.", + "properties": { + "name": { + "description": "The name of the changed resource.", + "type": "string" + }, + "type": { + "description": "The type of the changed resource.", + "enum": [ + "feature_flag", + "configuration" + ], + "example": "feature_flag", + "type": "string", + "x-enum-varnames": [ + "FEATURE_FLAG", + "CONFIGURATION" + ] + } + }, + "type": "object" + }, + "evt": { + "description": "JSON object of event system attributes.", + "properties": { + "category": { + "description": "Event category identifying the type of event.", + "enum": [ + "change", + "alert" + ], + "example": "change", + "type": "string", + "x-enum-varnames": [ + "CHANGE", + "ALERT" + ] + }, + "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": { + "description": "Integration ID sourced from integration manifests.", + "enum": [ + "custom-events" + ], + "example": "custom-events", + "type": "string", + "x-enum-varnames": [ + "CUSTOM_EVENTS" + ] + }, + "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" + }, + "impacted_resources": { + "description": "A list of resources impacted by this change.", + "example": [ + { + "name": "service-name", + "type": "service" + } + ], + "items": { + "description": "A uniquely identified resource.", + "properties": { + "name": { + "description": "The name of the impacted resource.", + "type": "string" + }, + "type": { + "description": "The type of the impacted resource.", + "enum": [ + "service" + ], + "type": "string", + "x-enum-varnames": [ + "SERVICE" + ] + } + }, + "type": "object" + }, + "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": { + "description": "Service that triggered the event.", + "example": "service-name", + "type": "string" + }, + "timestamp": { + "description": "POSIX timestamp of the event.", + "example": 175019386627, + "format": "int64", + "type": "integer" + }, + "title": { + "description": "The title of the event.", + "example": "The event title", + "type": "string" + } + }, + "type": "object" + }, + { + "description": "Alert event attributes.", + "properties": { + "aggregation_key": { + "description": "Aggregation key of the event.", + "example": "aggregation-key", + "type": "string" + }, + "custom": { + "description": "JSON object of custom attributes.", + "example": {}, + "type": "object" + }, + "evt": { + "description": "JSON object of event system attributes.", + "properties": { + "category": { + "description": "Event category identifying the type of event.", + "enum": [ + "change", + "alert" + ], + "example": "change", + "type": "string", + "x-enum-varnames": [ + "CHANGE", + "ALERT" + ] + }, + "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": { + "description": "Integration ID sourced from integration manifests.", + "enum": [ + "custom-events" + ], + "example": "custom-events", + "type": "string", + "x-enum-varnames": [ + "CUSTOM_EVENTS" + ] + }, + "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" + }, + "links": { + "description": "The links related to the event.", + "example": [ + { + "category": "runbook", + "title": "Runbook Link", + "url": "https://app.datadoghq.com/runbook" + } + ], + "items": { + "description": "A link.", + "properties": { + "category": { + "description": "The category of the link.", + "enum": [ + "runbook", + "documentation", + "dashboard" + ], + "type": "string", + "x-enum-varnames": [ + "RUNBOOK", + "DOCUMENTATION", + "DASHBOARD" + ] + }, + "title": { + "description": "The display text of the link.", + "type": "string" + }, + "url": { + "description": "The URL of the link.", + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "priority": { + "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" + ] + }, + "service": { + "description": "Service that triggered the event.", + "example": "service-name", + "type": "string" + }, + "timestamp": { + "description": "POSIX timestamp of the event.", + "example": 175019386627, + "format": "int64", + "type": "integer" + }, + "title": { + "description": "The title of the event.", + "example": "The event title", + "type": "string" + } + }, + "type": "object" + } + ] + }, + "message": { + "description": "Free-formed 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" + }, + "id": { + "description": "The event's ID.", + "example": "", + "type": "string" + }, + "type": { + "description": "Entity type.", + "example": "event", + "type": "string" + } + }, + "type": "object" + } + }, + "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.", "properties": { @@ -373176,6 +375137,565 @@ "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": { + "description": "Get an event response.", + "properties": { + "data": { + "description": "An event object.", + "properties": { + "attributes": { + "description": "Event attributes.", + "properties": { + "attributes": { + "description": "JSON object for category-specific attributes.", + "oneOf": [ + { + "description": "Change event attributes.", + "properties": { + "aggregation_key": { + "description": "Aggregation key of the event.", + "example": "aggregation-key", + "type": "string" + }, + "author": { + "description": "The entity that made the change.", + "properties": { + "name": { + "description": "The name of the user or system that made the change.", + "example": "example@datadog.com", + "type": "string" + }, + "type": { + "description": "The type of the author.", + "enum": [ + "user", + "system" + ], + "example": "user", + "type": "string", + "x-enum-varnames": [ + "USER", + "SYSTEM" + ] + } + }, + "type": "object" + }, + "change_metadata": { + "description": "JSON object of change metadata.", + "example": { + "dd": { + "team": "datadog_team", + "user_email": "datadog@datadog.com", + "user_id": "datadog_user_id", + "user_name": "datadog_username" + } + }, + "type": "object" + }, + "changed_resource": { + "description": "A uniquely identified resource.", + "properties": { + "name": { + "description": "The name of the changed resource.", + "type": "string" + }, + "type": { + "description": "The type of the changed resource.", + "enum": [ + "feature_flag", + "configuration" + ], + "example": "feature_flag", + "type": "string", + "x-enum-varnames": [ + "FEATURE_FLAG", + "CONFIGURATION" + ] + } + }, + "type": "object" + }, + "evt": { + "description": "JSON object of event system attributes.", + "properties": { + "category": { + "description": "Event category identifying the type of event.", + "enum": [ + "change", + "alert" + ], + "example": "change", + "type": "string", + "x-enum-varnames": [ + "CHANGE", + "ALERT" + ] + }, + "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": { + "description": "Integration ID sourced from integration manifests.", + "enum": [ + "custom-events" + ], + "example": "custom-events", + "type": "string", + "x-enum-varnames": [ + "CUSTOM_EVENTS" + ] + }, + "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" + }, + "impacted_resources": { + "description": "A list of resources impacted by this change.", + "example": [ + { + "name": "service-name", + "type": "service" + } + ], + "items": { + "description": "A uniquely identified resource.", + "properties": { + "name": { + "description": "The name of the impacted resource.", + "type": "string" + }, + "type": { + "description": "The type of the impacted resource.", + "enum": [ + "service" + ], + "type": "string", + "x-enum-varnames": [ + "SERVICE" + ] + } + }, + "type": "object" + }, + "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": { + "description": "Service that triggered the event.", + "example": "service-name", + "type": "string" + }, + "timestamp": { + "description": "POSIX timestamp of the event.", + "example": 175019386627, + "format": "int64", + "type": "integer" + }, + "title": { + "description": "The title of the event.", + "example": "The event title", + "type": "string" + } + }, + "type": "object" + }, + { + "description": "Alert event attributes.", + "properties": { + "aggregation_key": { + "description": "Aggregation key of the event.", + "example": "aggregation-key", + "type": "string" + }, + "custom": { + "description": "JSON object of custom attributes.", + "example": {}, + "type": "object" + }, + "evt": { + "description": "JSON object of event system attributes.", + "properties": { + "category": { + "description": "Event category identifying the type of event.", + "enum": [ + "change", + "alert" + ], + "example": "change", + "type": "string", + "x-enum-varnames": [ + "CHANGE", + "ALERT" + ] + }, + "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": { + "description": "Integration ID sourced from integration manifests.", + "enum": [ + "custom-events" + ], + "example": "custom-events", + "type": "string", + "x-enum-varnames": [ + "CUSTOM_EVENTS" + ] + }, + "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" + }, + "links": { + "description": "The links related to the event.", + "example": [ + { + "category": "runbook", + "title": "Runbook Link", + "url": "https://app.datadoghq.com/runbook" + } + ], + "items": { + "description": "A link.", + "properties": { + "category": { + "description": "The category of the link.", + "enum": [ + "runbook", + "documentation", + "dashboard" + ], + "type": "string", + "x-enum-varnames": [ + "RUNBOOK", + "DOCUMENTATION", + "DASHBOARD" + ] + }, + "title": { + "description": "The display text of the link.", + "type": "string" + }, + "url": { + "description": "The URL of the link.", + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "priority": { + "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" + ] + }, + "service": { + "description": "Service that triggered the event.", + "example": "service-name", + "type": "string" + }, + "timestamp": { + "description": "POSIX timestamp of the event.", + "example": 175019386627, + "format": "int64", + "type": "integer" + }, + "title": { + "description": "The title of the event.", + "example": "The event title", + "type": "string" + } + }, + "type": "object" + } + ] + }, + "message": { + "description": "Free-formed 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" + }, + "id": { + "description": "The event's ID.", + "example": "", + "type": "string" + }, + "type": { + "description": "Entity type.", + "example": "event", + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + } + } + }, + "description": "OK" + }, + "400": { + "content": { + "application/json": { + "schema": { + "description": "API error response.", + "properties": { + "errors": { + "description": "A list of errors.", + "example": [ + "Bad Request" + ], + "items": { + "description": "A list of items.", + "example": "Bad Request", + "type": "string" + }, + "type": "array" + } + }, + "required": [ + "errors" + ], + "type": "object" + } + } + }, + "description": "Bad Request" + }, + "401": { + "content": { + "application/json": { + "schema": { + "description": "API error response.", + "properties": { + "errors": { + "description": "A list of errors.", + "example": [ + "Bad Request" + ], + "items": { + "description": "A list of items.", + "example": "Bad Request", + "type": "string" + }, + "type": "array" + } + }, + "required": [ + "errors" + ], + "type": "object" + } + } + }, + "description": "Unauthorized" + }, + "403": { + "content": { + "application/json": { + "schema": { + "description": "API error response.", + "properties": { + "errors": { + "description": "A list of errors.", + "example": [ + "Bad Request" + ], + "items": { + "description": "A list of items.", + "example": "Bad Request", + "type": "string" + }, + "type": "array" + } + }, + "required": [ + "errors" + ], + "type": "object" + } + } + }, + "description": "Forbidden" + }, + "404": { + "content": { + "application/json": { + "schema": { + "description": "API error response.", + "properties": { + "errors": { + "description": "A list of errors.", + "example": [ + "Bad Request" + ], + "items": { + "description": "A list of items.", + "example": "Bad Request", + "type": "string" + }, + "type": "array" + } + }, + "required": [ + "errors" + ], + "type": "object" + } + } + }, + "description": "Not Found" + }, + "429": { + "content": { + "application/json": { + "schema": { + "description": "API error response.", + "properties": { + "errors": { + "description": "A list of errors.", + "example": [ + "Bad Request" + ], + "items": { + "description": "A list of items.", + "example": "Bad Request", + "type": "string" + }, + "type": "array" + } + }, + "required": [ + "errors" + ], + "type": "object" + } + } + }, + "description": "Too many requests" + } + }, + "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.", diff --git a/data/api/v2/translate_actions.json b/data/api/v2/translate_actions.json index b1c3acd809783..de52d3064d752 100644 --- a/data/api/v2/translate_actions.json +++ b/data/api/v2/translate_actions.json @@ -659,6 +659,10 @@ "request_description": "", "request_schema_description": "The object sent with the request to retrieve a list of events from your organization." }, + "GetEvent": { + "description": "Get the details of an event by `event_id`.", + "summary": "Get an event" + }, "ListIncidents": { "description": "Get all incidents for the user's organization.", "summary": "Get a list of incidents" diff --git a/static/resources/json/full_spec_v2.json b/static/resources/json/full_spec_v2.json index 5027787dd8a8c..ddc01474328a8 100644 --- a/static/resources/json/full_spec_v2.json +++ b/static/resources/json/full_spec_v2.json @@ -11319,6 +11319,200 @@ ], "type": "object" }, + "AlertEventAttributes": { + "description": "Alert event attributes.", + "properties": { + "aggregation_key": { + "description": "Aggregation key of the event.", + "example": "aggregation-key", + "type": "string" + }, + "custom": { + "description": "JSON object of custom attributes.", + "example": {}, + "type": "object" + }, + "evt": { + "description": "JSON object of event system attributes.", + "properties": { + "category": { + "description": "Event category identifying the type of event.", + "enum": [ + "change", + "alert" + ], + "example": "change", + "type": "string", + "x-enum-varnames": [ + "CHANGE", + "ALERT" + ] + }, + "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": { + "description": "Integration ID sourced from integration manifests.", + "enum": [ + "custom-events" + ], + "example": "custom-events", + "type": "string", + "x-enum-varnames": [ + "CUSTOM_EVENTS" + ] + }, + "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" + }, + "links": { + "description": "The links related to the event.", + "example": [ + { + "category": "runbook", + "title": "Runbook Link", + "url": "https://app.datadoghq.com/runbook" + } + ], + "items": { + "description": "A link.", + "properties": { + "category": { + "description": "The category of the link.", + "enum": [ + "runbook", + "documentation", + "dashboard" + ], + "type": "string", + "x-enum-varnames": [ + "RUNBOOK", + "DOCUMENTATION", + "DASHBOARD" + ] + }, + "title": { + "description": "The display text of the link.", + "type": "string" + }, + "url": { + "description": "The URL of the link.", + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "priority": { + "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" + ] + }, + "service": { + "description": "Service that triggered the event.", + "example": "service-name", + "type": "string" + }, + "timestamp": { + "description": "POSIX timestamp of the event.", + "example": 175019386627, + "format": "int64", + "type": "integer" + }, + "title": { + "description": "The title of the event.", + "example": "The event title", + "type": "string" + } + }, + "type": "object" + }, + "AlertEventAttributesLinksItem": { + "description": "A link.", + "properties": { + "category": { + "description": "The category of the link.", + "enum": [ + "runbook", + "documentation", + "dashboard" + ], + "type": "string", + "x-enum-varnames": [ + "RUNBOOK", + "DOCUMENTATION", + "DASHBOARD" + ] + }, + "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" + ] + }, "AlertEventCustomAttributes": { "additionalProperties": false, "description": "Alert event attributes.", @@ -41165,6 +41359,290 @@ }, "type": "object" }, + "ChangeEventAttributes": { + "description": "Change event attributes.", + "properties": { + "aggregation_key": { + "description": "Aggregation key of the event.", + "example": "aggregation-key", + "type": "string" + }, + "author": { + "description": "The entity that made the change.", + "properties": { + "name": { + "description": "The name of the user or system that made the change.", + "example": "example@datadog.com", + "type": "string" + }, + "type": { + "description": "The type of the author.", + "enum": [ + "user", + "system" + ], + "example": "user", + "type": "string", + "x-enum-varnames": [ + "USER", + "SYSTEM" + ] + } + }, + "type": "object" + }, + "change_metadata": { + "description": "JSON object of change metadata.", + "example": { + "dd": { + "team": "datadog_team", + "user_email": "datadog@datadog.com", + "user_id": "datadog_user_id", + "user_name": "datadog_username" + } + }, + "type": "object" + }, + "changed_resource": { + "description": "A uniquely identified resource.", + "properties": { + "name": { + "description": "The name of the changed resource.", + "type": "string" + }, + "type": { + "description": "The type of the changed resource.", + "enum": [ + "feature_flag", + "configuration" + ], + "example": "feature_flag", + "type": "string", + "x-enum-varnames": [ + "FEATURE_FLAG", + "CONFIGURATION" + ] + } + }, + "type": "object" + }, + "evt": { + "description": "JSON object of event system attributes.", + "properties": { + "category": { + "description": "Event category identifying the type of event.", + "enum": [ + "change", + "alert" + ], + "example": "change", + "type": "string", + "x-enum-varnames": [ + "CHANGE", + "ALERT" + ] + }, + "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": { + "description": "Integration ID sourced from integration manifests.", + "enum": [ + "custom-events" + ], + "example": "custom-events", + "type": "string", + "x-enum-varnames": [ + "CUSTOM_EVENTS" + ] + }, + "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" + }, + "impacted_resources": { + "description": "A list of resources impacted by this change.", + "example": [ + { + "name": "service-name", + "type": "service" + } + ], + "items": { + "description": "A uniquely identified resource.", + "properties": { + "name": { + "description": "The name of the impacted resource.", + "type": "string" + }, + "type": { + "description": "The type of the impacted resource.", + "enum": [ + "service" + ], + "type": "string", + "x-enum-varnames": [ + "SERVICE" + ] + } + }, + "type": "object" + }, + "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": { + "description": "Service that triggered the event.", + "example": "service-name", + "type": "string" + }, + "timestamp": { + "description": "POSIX timestamp of the event.", + "example": 175019386627, + "format": "int64", + "type": "integer" + }, + "title": { + "description": "The title of the event.", + "example": "The event title", + "type": "string" + } + }, + "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": "example@datadog.com", + "type": "string" + }, + "type": { + "description": "The type of the author.", + "enum": [ + "user", + "system" + ], + "example": "user", + "type": "string", + "x-enum-varnames": [ + "USER", + "SYSTEM" + ] + } + }, + "type": "object" + }, + "ChangeEventAttributesAuthorType": { + "description": "The type of the author.", + "enum": [ + "user", + "system" + ], + "example": "user", + "type": "string", + "x-enum-varnames": [ + "USER", + "SYSTEM" + ] + }, + "ChangeEventAttributesChangedResource": { + "description": "A uniquely identified resource.", + "properties": { + "name": { + "description": "The name of the changed resource.", + "type": "string" + }, + "type": { + "description": "The type of the changed resource.", + "enum": [ + "feature_flag", + "configuration" + ], + "example": "feature_flag", + "type": "string", + "x-enum-varnames": [ + "FEATURE_FLAG", + "CONFIGURATION" + ] + } + }, + "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": { + "description": "The type of the impacted resource.", + "enum": [ + "service" + ], + "type": "string", + "x-enum-varnames": [ + "SERVICE" + ] + } + }, + "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.", @@ -87014,6 +87492,73 @@ "SNAPSHOT" ] }, + "EventSystemAttributes": { + "description": "JSON object of event system attributes.", + "properties": { + "category": { + "description": "Event category identifying the type of event.", + "enum": [ + "change", + "alert" + ], + "example": "change", + "type": "string", + "x-enum-varnames": [ + "CHANGE", + "ALERT" + ] + }, + "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": { + "description": "Integration ID sourced from integration manifests.", + "enum": [ + "custom-events" + ], + "example": "custom-events", + "type": "string", + "x-enum-varnames": [ + "CUSTOM_EVENTS" + ] + }, + "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.", @@ -303124,6 +303669,1422 @@ "USERS" ] }, + "V2Event": { + "description": "An event object.", + "properties": { + "attributes": { + "description": "Event attributes.", + "properties": { + "attributes": { + "description": "JSON object for category-specific attributes.", + "oneOf": [ + { + "description": "Change event attributes.", + "properties": { + "aggregation_key": { + "description": "Aggregation key of the event.", + "example": "aggregation-key", + "type": "string" + }, + "author": { + "description": "The entity that made the change.", + "properties": { + "name": { + "description": "The name of the user or system that made the change.", + "example": "example@datadog.com", + "type": "string" + }, + "type": { + "description": "The type of the author.", + "enum": [ + "user", + "system" + ], + "example": "user", + "type": "string", + "x-enum-varnames": [ + "USER", + "SYSTEM" + ] + } + }, + "type": "object" + }, + "change_metadata": { + "description": "JSON object of change metadata.", + "example": { + "dd": { + "team": "datadog_team", + "user_email": "datadog@datadog.com", + "user_id": "datadog_user_id", + "user_name": "datadog_username" + } + }, + "type": "object" + }, + "changed_resource": { + "description": "A uniquely identified resource.", + "properties": { + "name": { + "description": "The name of the changed resource.", + "type": "string" + }, + "type": { + "description": "The type of the changed resource.", + "enum": [ + "feature_flag", + "configuration" + ], + "example": "feature_flag", + "type": "string", + "x-enum-varnames": [ + "FEATURE_FLAG", + "CONFIGURATION" + ] + } + }, + "type": "object" + }, + "evt": { + "description": "JSON object of event system attributes.", + "properties": { + "category": { + "description": "Event category identifying the type of event.", + "enum": [ + "change", + "alert" + ], + "example": "change", + "type": "string", + "x-enum-varnames": [ + "CHANGE", + "ALERT" + ] + }, + "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": { + "description": "Integration ID sourced from integration manifests.", + "enum": [ + "custom-events" + ], + "example": "custom-events", + "type": "string", + "x-enum-varnames": [ + "CUSTOM_EVENTS" + ] + }, + "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" + }, + "impacted_resources": { + "description": "A list of resources impacted by this change.", + "example": [ + { + "name": "service-name", + "type": "service" + } + ], + "items": { + "description": "A uniquely identified resource.", + "properties": { + "name": { + "description": "The name of the impacted resource.", + "type": "string" + }, + "type": { + "description": "The type of the impacted resource.", + "enum": [ + "service" + ], + "type": "string", + "x-enum-varnames": [ + "SERVICE" + ] + } + }, + "type": "object" + }, + "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": { + "description": "Service that triggered the event.", + "example": "service-name", + "type": "string" + }, + "timestamp": { + "description": "POSIX timestamp of the event.", + "example": 175019386627, + "format": "int64", + "type": "integer" + }, + "title": { + "description": "The title of the event.", + "example": "The event title", + "type": "string" + } + }, + "type": "object" + }, + { + "description": "Alert event attributes.", + "properties": { + "aggregation_key": { + "description": "Aggregation key of the event.", + "example": "aggregation-key", + "type": "string" + }, + "custom": { + "description": "JSON object of custom attributes.", + "example": {}, + "type": "object" + }, + "evt": { + "description": "JSON object of event system attributes.", + "properties": { + "category": { + "description": "Event category identifying the type of event.", + "enum": [ + "change", + "alert" + ], + "example": "change", + "type": "string", + "x-enum-varnames": [ + "CHANGE", + "ALERT" + ] + }, + "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": { + "description": "Integration ID sourced from integration manifests.", + "enum": [ + "custom-events" + ], + "example": "custom-events", + "type": "string", + "x-enum-varnames": [ + "CUSTOM_EVENTS" + ] + }, + "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" + }, + "links": { + "description": "The links related to the event.", + "example": [ + { + "category": "runbook", + "title": "Runbook Link", + "url": "https://app.datadoghq.com/runbook" + } + ], + "items": { + "description": "A link.", + "properties": { + "category": { + "description": "The category of the link.", + "enum": [ + "runbook", + "documentation", + "dashboard" + ], + "type": "string", + "x-enum-varnames": [ + "RUNBOOK", + "DOCUMENTATION", + "DASHBOARD" + ] + }, + "title": { + "description": "The display text of the link.", + "type": "string" + }, + "url": { + "description": "The URL of the link.", + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "priority": { + "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" + ] + }, + "service": { + "description": "Service that triggered the event.", + "example": "service-name", + "type": "string" + }, + "timestamp": { + "description": "POSIX timestamp of the event.", + "example": 175019386627, + "format": "int64", + "type": "integer" + }, + "title": { + "description": "The title of the event.", + "example": "The event title", + "type": "string" + } + }, + "type": "object" + } + ] + }, + "message": { + "description": "Free-formed 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" + }, + "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": { + "description": "JSON object for category-specific attributes.", + "oneOf": [ + { + "description": "Change event attributes.", + "properties": { + "aggregation_key": { + "description": "Aggregation key of the event.", + "example": "aggregation-key", + "type": "string" + }, + "author": { + "description": "The entity that made the change.", + "properties": { + "name": { + "description": "The name of the user or system that made the change.", + "example": "example@datadog.com", + "type": "string" + }, + "type": { + "description": "The type of the author.", + "enum": [ + "user", + "system" + ], + "example": "user", + "type": "string", + "x-enum-varnames": [ + "USER", + "SYSTEM" + ] + } + }, + "type": "object" + }, + "change_metadata": { + "description": "JSON object of change metadata.", + "example": { + "dd": { + "team": "datadog_team", + "user_email": "datadog@datadog.com", + "user_id": "datadog_user_id", + "user_name": "datadog_username" + } + }, + "type": "object" + }, + "changed_resource": { + "description": "A uniquely identified resource.", + "properties": { + "name": { + "description": "The name of the changed resource.", + "type": "string" + }, + "type": { + "description": "The type of the changed resource.", + "enum": [ + "feature_flag", + "configuration" + ], + "example": "feature_flag", + "type": "string", + "x-enum-varnames": [ + "FEATURE_FLAG", + "CONFIGURATION" + ] + } + }, + "type": "object" + }, + "evt": { + "description": "JSON object of event system attributes.", + "properties": { + "category": { + "description": "Event category identifying the type of event.", + "enum": [ + "change", + "alert" + ], + "example": "change", + "type": "string", + "x-enum-varnames": [ + "CHANGE", + "ALERT" + ] + }, + "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": { + "description": "Integration ID sourced from integration manifests.", + "enum": [ + "custom-events" + ], + "example": "custom-events", + "type": "string", + "x-enum-varnames": [ + "CUSTOM_EVENTS" + ] + }, + "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" + }, + "impacted_resources": { + "description": "A list of resources impacted by this change.", + "example": [ + { + "name": "service-name", + "type": "service" + } + ], + "items": { + "description": "A uniquely identified resource.", + "properties": { + "name": { + "description": "The name of the impacted resource.", + "type": "string" + }, + "type": { + "description": "The type of the impacted resource.", + "enum": [ + "service" + ], + "type": "string", + "x-enum-varnames": [ + "SERVICE" + ] + } + }, + "type": "object" + }, + "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": { + "description": "Service that triggered the event.", + "example": "service-name", + "type": "string" + }, + "timestamp": { + "description": "POSIX timestamp of the event.", + "example": 175019386627, + "format": "int64", + "type": "integer" + }, + "title": { + "description": "The title of the event.", + "example": "The event title", + "type": "string" + } + }, + "type": "object" + }, + { + "description": "Alert event attributes.", + "properties": { + "aggregation_key": { + "description": "Aggregation key of the event.", + "example": "aggregation-key", + "type": "string" + }, + "custom": { + "description": "JSON object of custom attributes.", + "example": {}, + "type": "object" + }, + "evt": { + "description": "JSON object of event system attributes.", + "properties": { + "category": { + "description": "Event category identifying the type of event.", + "enum": [ + "change", + "alert" + ], + "example": "change", + "type": "string", + "x-enum-varnames": [ + "CHANGE", + "ALERT" + ] + }, + "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": { + "description": "Integration ID sourced from integration manifests.", + "enum": [ + "custom-events" + ], + "example": "custom-events", + "type": "string", + "x-enum-varnames": [ + "CUSTOM_EVENTS" + ] + }, + "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" + }, + "links": { + "description": "The links related to the event.", + "example": [ + { + "category": "runbook", + "title": "Runbook Link", + "url": "https://app.datadoghq.com/runbook" + } + ], + "items": { + "description": "A link.", + "properties": { + "category": { + "description": "The category of the link.", + "enum": [ + "runbook", + "documentation", + "dashboard" + ], + "type": "string", + "x-enum-varnames": [ + "RUNBOOK", + "DOCUMENTATION", + "DASHBOARD" + ] + }, + "title": { + "description": "The display text of the link.", + "type": "string" + }, + "url": { + "description": "The URL of the link.", + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "priority": { + "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" + ] + }, + "service": { + "description": "Service that triggered the event.", + "example": "service-name", + "type": "string" + }, + "timestamp": { + "description": "POSIX timestamp of the event.", + "example": 175019386627, + "format": "int64", + "type": "integer" + }, + "title": { + "description": "The title of the event.", + "example": "The event title", + "type": "string" + } + }, + "type": "object" + } + ] + }, + "message": { + "description": "Free-formed 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": [ + { + "description": "Change event attributes.", + "properties": { + "aggregation_key": { + "description": "Aggregation key of the event.", + "example": "aggregation-key", + "type": "string" + }, + "author": { + "description": "The entity that made the change.", + "properties": { + "name": { + "description": "The name of the user or system that made the change.", + "example": "example@datadog.com", + "type": "string" + }, + "type": { + "description": "The type of the author.", + "enum": [ + "user", + "system" + ], + "example": "user", + "type": "string", + "x-enum-varnames": [ + "USER", + "SYSTEM" + ] + } + }, + "type": "object" + }, + "change_metadata": { + "description": "JSON object of change metadata.", + "example": { + "dd": { + "team": "datadog_team", + "user_email": "datadog@datadog.com", + "user_id": "datadog_user_id", + "user_name": "datadog_username" + } + }, + "type": "object" + }, + "changed_resource": { + "description": "A uniquely identified resource.", + "properties": { + "name": { + "description": "The name of the changed resource.", + "type": "string" + }, + "type": { + "description": "The type of the changed resource.", + "enum": [ + "feature_flag", + "configuration" + ], + "example": "feature_flag", + "type": "string", + "x-enum-varnames": [ + "FEATURE_FLAG", + "CONFIGURATION" + ] + } + }, + "type": "object" + }, + "evt": { + "description": "JSON object of event system attributes.", + "properties": { + "category": { + "description": "Event category identifying the type of event.", + "enum": [ + "change", + "alert" + ], + "example": "change", + "type": "string", + "x-enum-varnames": [ + "CHANGE", + "ALERT" + ] + }, + "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": { + "description": "Integration ID sourced from integration manifests.", + "enum": [ + "custom-events" + ], + "example": "custom-events", + "type": "string", + "x-enum-varnames": [ + "CUSTOM_EVENTS" + ] + }, + "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" + }, + "impacted_resources": { + "description": "A list of resources impacted by this change.", + "example": [ + { + "name": "service-name", + "type": "service" + } + ], + "items": { + "description": "A uniquely identified resource.", + "properties": { + "name": { + "description": "The name of the impacted resource.", + "type": "string" + }, + "type": { + "description": "The type of the impacted resource.", + "enum": [ + "service" + ], + "type": "string", + "x-enum-varnames": [ + "SERVICE" + ] + } + }, + "type": "object" + }, + "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": { + "description": "Service that triggered the event.", + "example": "service-name", + "type": "string" + }, + "timestamp": { + "description": "POSIX timestamp of the event.", + "example": 175019386627, + "format": "int64", + "type": "integer" + }, + "title": { + "description": "The title of the event.", + "example": "The event title", + "type": "string" + } + }, + "type": "object" + }, + { + "description": "Alert event attributes.", + "properties": { + "aggregation_key": { + "description": "Aggregation key of the event.", + "example": "aggregation-key", + "type": "string" + }, + "custom": { + "description": "JSON object of custom attributes.", + "example": {}, + "type": "object" + }, + "evt": { + "description": "JSON object of event system attributes.", + "properties": { + "category": { + "description": "Event category identifying the type of event.", + "enum": [ + "change", + "alert" + ], + "example": "change", + "type": "string", + "x-enum-varnames": [ + "CHANGE", + "ALERT" + ] + }, + "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": { + "description": "Integration ID sourced from integration manifests.", + "enum": [ + "custom-events" + ], + "example": "custom-events", + "type": "string", + "x-enum-varnames": [ + "CUSTOM_EVENTS" + ] + }, + "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" + }, + "links": { + "description": "The links related to the event.", + "example": [ + { + "category": "runbook", + "title": "Runbook Link", + "url": "https://app.datadoghq.com/runbook" + } + ], + "items": { + "description": "A link.", + "properties": { + "category": { + "description": "The category of the link.", + "enum": [ + "runbook", + "documentation", + "dashboard" + ], + "type": "string", + "x-enum-varnames": [ + "RUNBOOK", + "DOCUMENTATION", + "DASHBOARD" + ] + }, + "title": { + "description": "The display text of the link.", + "type": "string" + }, + "url": { + "description": "The URL of the link.", + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "priority": { + "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" + ] + }, + "service": { + "description": "Service that triggered the event.", + "example": "service-name", + "type": "string" + }, + "timestamp": { + "description": "POSIX timestamp of the event.", + "example": 175019386627, + "format": "int64", + "type": "integer" + }, + "title": { + "description": "The title of the event.", + "example": "The event title", + "type": "string" + } + }, + "type": "object" + } + ] + }, + "V2EventResponse": { + "description": "Get an event response.", + "properties": { + "data": { + "description": "An event object.", + "properties": { + "attributes": { + "description": "Event attributes.", + "properties": { + "attributes": { + "description": "JSON object for category-specific attributes.", + "oneOf": [ + { + "description": "Change event attributes.", + "properties": { + "aggregation_key": { + "description": "Aggregation key of the event.", + "example": "aggregation-key", + "type": "string" + }, + "author": { + "description": "The entity that made the change.", + "properties": { + "name": { + "description": "The name of the user or system that made the change.", + "example": "example@datadog.com", + "type": "string" + }, + "type": { + "description": "The type of the author.", + "enum": [ + "user", + "system" + ], + "example": "user", + "type": "string", + "x-enum-varnames": [ + "USER", + "SYSTEM" + ] + } + }, + "type": "object" + }, + "change_metadata": { + "description": "JSON object of change metadata.", + "example": { + "dd": { + "team": "datadog_team", + "user_email": "datadog@datadog.com", + "user_id": "datadog_user_id", + "user_name": "datadog_username" + } + }, + "type": "object" + }, + "changed_resource": { + "description": "A uniquely identified resource.", + "properties": { + "name": { + "description": "The name of the changed resource.", + "type": "string" + }, + "type": { + "description": "The type of the changed resource.", + "enum": [ + "feature_flag", + "configuration" + ], + "example": "feature_flag", + "type": "string", + "x-enum-varnames": [ + "FEATURE_FLAG", + "CONFIGURATION" + ] + } + }, + "type": "object" + }, + "evt": { + "description": "JSON object of event system attributes.", + "properties": { + "category": { + "description": "Event category identifying the type of event.", + "enum": [ + "change", + "alert" + ], + "example": "change", + "type": "string", + "x-enum-varnames": [ + "CHANGE", + "ALERT" + ] + }, + "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": { + "description": "Integration ID sourced from integration manifests.", + "enum": [ + "custom-events" + ], + "example": "custom-events", + "type": "string", + "x-enum-varnames": [ + "CUSTOM_EVENTS" + ] + }, + "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" + }, + "impacted_resources": { + "description": "A list of resources impacted by this change.", + "example": [ + { + "name": "service-name", + "type": "service" + } + ], + "items": { + "description": "A uniquely identified resource.", + "properties": { + "name": { + "description": "The name of the impacted resource.", + "type": "string" + }, + "type": { + "description": "The type of the impacted resource.", + "enum": [ + "service" + ], + "type": "string", + "x-enum-varnames": [ + "SERVICE" + ] + } + }, + "type": "object" + }, + "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": { + "description": "Service that triggered the event.", + "example": "service-name", + "type": "string" + }, + "timestamp": { + "description": "POSIX timestamp of the event.", + "example": 175019386627, + "format": "int64", + "type": "integer" + }, + "title": { + "description": "The title of the event.", + "example": "The event title", + "type": "string" + } + }, + "type": "object" + }, + { + "description": "Alert event attributes.", + "properties": { + "aggregation_key": { + "description": "Aggregation key of the event.", + "example": "aggregation-key", + "type": "string" + }, + "custom": { + "description": "JSON object of custom attributes.", + "example": {}, + "type": "object" + }, + "evt": { + "description": "JSON object of event system attributes.", + "properties": { + "category": { + "description": "Event category identifying the type of event.", + "enum": [ + "change", + "alert" + ], + "example": "change", + "type": "string", + "x-enum-varnames": [ + "CHANGE", + "ALERT" + ] + }, + "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": { + "description": "Integration ID sourced from integration manifests.", + "enum": [ + "custom-events" + ], + "example": "custom-events", + "type": "string", + "x-enum-varnames": [ + "CUSTOM_EVENTS" + ] + }, + "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" + }, + "links": { + "description": "The links related to the event.", + "example": [ + { + "category": "runbook", + "title": "Runbook Link", + "url": "https://app.datadoghq.com/runbook" + } + ], + "items": { + "description": "A link.", + "properties": { + "category": { + "description": "The category of the link.", + "enum": [ + "runbook", + "documentation", + "dashboard" + ], + "type": "string", + "x-enum-varnames": [ + "RUNBOOK", + "DOCUMENTATION", + "DASHBOARD" + ] + }, + "title": { + "description": "The display text of the link.", + "type": "string" + }, + "url": { + "description": "The URL of the link.", + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "priority": { + "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" + ] + }, + "service": { + "description": "Service that triggered the event.", + "example": "service-name", + "type": "string" + }, + "timestamp": { + "description": "POSIX timestamp of the event.", + "example": 175019386627, + "format": "int64", + "type": "integer" + }, + "title": { + "description": "The title of the event.", + "example": "The event title", + "type": "string" + } + }, + "type": "object" + } + ] + }, + "message": { + "description": "Free-formed 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" + }, + "id": { + "description": "The event's ID.", + "example": "", + "type": "string" + }, + "type": { + "description": "Entity type.", + "example": "event", + "type": "string" + } + }, + "type": "object" + } + }, + "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.", "properties": { @@ -373176,6 +375137,565 @@ "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": { + "description": "Get an event response.", + "properties": { + "data": { + "description": "An event object.", + "properties": { + "attributes": { + "description": "Event attributes.", + "properties": { + "attributes": { + "description": "JSON object for category-specific attributes.", + "oneOf": [ + { + "description": "Change event attributes.", + "properties": { + "aggregation_key": { + "description": "Aggregation key of the event.", + "example": "aggregation-key", + "type": "string" + }, + "author": { + "description": "The entity that made the change.", + "properties": { + "name": { + "description": "The name of the user or system that made the change.", + "example": "example@datadog.com", + "type": "string" + }, + "type": { + "description": "The type of the author.", + "enum": [ + "user", + "system" + ], + "example": "user", + "type": "string", + "x-enum-varnames": [ + "USER", + "SYSTEM" + ] + } + }, + "type": "object" + }, + "change_metadata": { + "description": "JSON object of change metadata.", + "example": { + "dd": { + "team": "datadog_team", + "user_email": "datadog@datadog.com", + "user_id": "datadog_user_id", + "user_name": "datadog_username" + } + }, + "type": "object" + }, + "changed_resource": { + "description": "A uniquely identified resource.", + "properties": { + "name": { + "description": "The name of the changed resource.", + "type": "string" + }, + "type": { + "description": "The type of the changed resource.", + "enum": [ + "feature_flag", + "configuration" + ], + "example": "feature_flag", + "type": "string", + "x-enum-varnames": [ + "FEATURE_FLAG", + "CONFIGURATION" + ] + } + }, + "type": "object" + }, + "evt": { + "description": "JSON object of event system attributes.", + "properties": { + "category": { + "description": "Event category identifying the type of event.", + "enum": [ + "change", + "alert" + ], + "example": "change", + "type": "string", + "x-enum-varnames": [ + "CHANGE", + "ALERT" + ] + }, + "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": { + "description": "Integration ID sourced from integration manifests.", + "enum": [ + "custom-events" + ], + "example": "custom-events", + "type": "string", + "x-enum-varnames": [ + "CUSTOM_EVENTS" + ] + }, + "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" + }, + "impacted_resources": { + "description": "A list of resources impacted by this change.", + "example": [ + { + "name": "service-name", + "type": "service" + } + ], + "items": { + "description": "A uniquely identified resource.", + "properties": { + "name": { + "description": "The name of the impacted resource.", + "type": "string" + }, + "type": { + "description": "The type of the impacted resource.", + "enum": [ + "service" + ], + "type": "string", + "x-enum-varnames": [ + "SERVICE" + ] + } + }, + "type": "object" + }, + "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": { + "description": "Service that triggered the event.", + "example": "service-name", + "type": "string" + }, + "timestamp": { + "description": "POSIX timestamp of the event.", + "example": 175019386627, + "format": "int64", + "type": "integer" + }, + "title": { + "description": "The title of the event.", + "example": "The event title", + "type": "string" + } + }, + "type": "object" + }, + { + "description": "Alert event attributes.", + "properties": { + "aggregation_key": { + "description": "Aggregation key of the event.", + "example": "aggregation-key", + "type": "string" + }, + "custom": { + "description": "JSON object of custom attributes.", + "example": {}, + "type": "object" + }, + "evt": { + "description": "JSON object of event system attributes.", + "properties": { + "category": { + "description": "Event category identifying the type of event.", + "enum": [ + "change", + "alert" + ], + "example": "change", + "type": "string", + "x-enum-varnames": [ + "CHANGE", + "ALERT" + ] + }, + "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": { + "description": "Integration ID sourced from integration manifests.", + "enum": [ + "custom-events" + ], + "example": "custom-events", + "type": "string", + "x-enum-varnames": [ + "CUSTOM_EVENTS" + ] + }, + "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" + }, + "links": { + "description": "The links related to the event.", + "example": [ + { + "category": "runbook", + "title": "Runbook Link", + "url": "https://app.datadoghq.com/runbook" + } + ], + "items": { + "description": "A link.", + "properties": { + "category": { + "description": "The category of the link.", + "enum": [ + "runbook", + "documentation", + "dashboard" + ], + "type": "string", + "x-enum-varnames": [ + "RUNBOOK", + "DOCUMENTATION", + "DASHBOARD" + ] + }, + "title": { + "description": "The display text of the link.", + "type": "string" + }, + "url": { + "description": "The URL of the link.", + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "priority": { + "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" + ] + }, + "service": { + "description": "Service that triggered the event.", + "example": "service-name", + "type": "string" + }, + "timestamp": { + "description": "POSIX timestamp of the event.", + "example": 175019386627, + "format": "int64", + "type": "integer" + }, + "title": { + "description": "The title of the event.", + "example": "The event title", + "type": "string" + } + }, + "type": "object" + } + ] + }, + "message": { + "description": "Free-formed 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" + }, + "id": { + "description": "The event's ID.", + "example": "", + "type": "string" + }, + "type": { + "description": "Entity type.", + "example": "event", + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + } + } + }, + "description": "OK" + }, + "400": { + "content": { + "application/json": { + "schema": { + "description": "API error response.", + "properties": { + "errors": { + "description": "A list of errors.", + "example": [ + "Bad Request" + ], + "items": { + "description": "A list of items.", + "example": "Bad Request", + "type": "string" + }, + "type": "array" + } + }, + "required": [ + "errors" + ], + "type": "object" + } + } + }, + "description": "Bad Request" + }, + "401": { + "content": { + "application/json": { + "schema": { + "description": "API error response.", + "properties": { + "errors": { + "description": "A list of errors.", + "example": [ + "Bad Request" + ], + "items": { + "description": "A list of items.", + "example": "Bad Request", + "type": "string" + }, + "type": "array" + } + }, + "required": [ + "errors" + ], + "type": "object" + } + } + }, + "description": "Unauthorized" + }, + "403": { + "content": { + "application/json": { + "schema": { + "description": "API error response.", + "properties": { + "errors": { + "description": "A list of errors.", + "example": [ + "Bad Request" + ], + "items": { + "description": "A list of items.", + "example": "Bad Request", + "type": "string" + }, + "type": "array" + } + }, + "required": [ + "errors" + ], + "type": "object" + } + } + }, + "description": "Forbidden" + }, + "404": { + "content": { + "application/json": { + "schema": { + "description": "API error response.", + "properties": { + "errors": { + "description": "A list of errors.", + "example": [ + "Bad Request" + ], + "items": { + "description": "A list of items.", + "example": "Bad Request", + "type": "string" + }, + "type": "array" + } + }, + "required": [ + "errors" + ], + "type": "object" + } + } + }, + "description": "Not Found" + }, + "429": { + "content": { + "application/json": { + "schema": { + "description": "API error response.", + "properties": { + "errors": { + "description": "A list of errors.", + "example": [ + "Bad Request" + ], + "items": { + "description": "A list of items.", + "example": "Bad Request", + "type": "string" + }, + "type": "array" + } + }, + "required": [ + "errors" + ], + "type": "object" + } + } + }, + "description": "Too many requests" + } + }, + "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.",