diff --git a/content/en/api/v2/events/examples.json b/content/en/api/v2/events/examples.json index d4e6bf9f466..0bb8f3669e6 100644 --- a/content/en/api/v2/events/examples.json +++ b/content/en/api/v2/events/examples.json @@ -246,6 +246,7 @@ } }, "category": "change", + "host": "hostname", "integration_id": "custom-events", "message": "payment_processed feature flag has been enabled", "tags": [ @@ -257,7 +258,7 @@ "type": "event" } }, - "html": "
\n
\n
\n
\n

data [required]

\n
\n

object

\n

An event object.

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

attributes [required]

\n
\n

object

\n

Event attributes.

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

aggregation_key

\n
\n

string

\n

A string used for aggregation when correlating events. If you specify a key, events are deduplicated to alerts based on this key. Limited to 100 characters.

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

attributes [required]

\n
\n

 <oneOf>

\n

JSON object for category-specific attributes. Schema is different per event category.

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

Option 1

\n
\n

object

\n

Change event attributes.

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

author

\n
\n

object

\n

The entity that made the change. Optional, if provided it must include type and name.

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

name [required]

\n
\n

string

\n

The name of the user or system that made the change. Limited to 128 characters.

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

type [required]

\n
\n

enum

\n

Author's type. \nAllowed enum values: user,system,api,automation

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

change_metadata

\n
\n

object

\n

Free form JSON object with information related to the change event. Supports up to 100 properties per object and a maximum nesting depth of 10 levels.

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

changed_resource [required]

\n
\n

object

\n

A uniquely identified resource.

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

name [required]

\n
\n

string

\n

The name of the resource that was changed. Limited to 128 characters.

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

type [required]

\n
\n

enum

\n

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

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

impacted_resources

\n
\n

[object]

\n

A list of resources impacted by this change. It is recommended to provide an impacted resource to display\nthe change event at the correct location. Only resources of type service are supported. Maximum of 100 impacted resources allowed.

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

name [required]

\n
\n

string

\n

The name of the impacted resource. Limited to 128 characters.

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

type [required]

\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

Free form JSON object representing the new state of the changed resource.

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

prev_value

\n
\n

object

\n

Free form JSON object representing the previous state of the changed resource.

\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

custom

\n
\n

object

\n

Free form JSON object for arbitrary data. Supports up to 100 properties per object and a maximum nesting depth of 10 levels.

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

links

\n
\n

[object]

\n

The links related to the event. Maximum of 20 links allowed.

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

category [required]

\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. Limited to 300 characters.

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

url [required]

\n
\n

string

\n

The URL of the link. Limited to 2048 characters.

\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

default: 5

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

status [required]

\n
\n

enum

\n

The status of the alert. \nAllowed enum values: warn,error,ok

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

category [required]

\n
\n

enum

\n

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

\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

message

\n
\n

string

\n

Free formed text associated with the event. It's suggested to use data.attributes.attributes.custom for well-structured attributes. Limited to 4000 characters.

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

tags

\n
\n

[string]

\n

A list of tags associated with the event. Maximum of 100 tags allowed.\nRefer to Tags docs.

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

timestamp

\n
\n

string

\n

Timestamp when the event occurred. Must follow ISO 8601 format.\nFor example "2017-01-15T01:30:15.010000Z".\nDefaults to the timestamp of receipt. Limited to values no older than 18 hours.

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

title [required]

\n
\n

string

\n

The title of the event. Limited to 500 characters.

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

type [required]

\n
\n

enum

\n

Entity type. \nAllowed enum values: event

\n
\n \n
\n
\n
\n
" + "html": "
\n
\n
\n
\n

data [required]

\n
\n

object

\n

An event object.

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

attributes [required]

\n
\n

object

\n

Event attributes.

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

aggregation_key

\n
\n

string

\n

A string used for aggregation when correlating events. If you specify a key, events are deduplicated to alerts based on this key. Limited to 100 characters.

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

attributes [required]

\n
\n

 <oneOf>

\n

JSON object for category-specific attributes. Schema is different per event category.

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

Option 1

\n
\n

object

\n

Change event attributes.

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

author

\n
\n

object

\n

The entity that made the change. Optional, if provided it must include type and name.

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

name [required]

\n
\n

string

\n

The name of the user or system that made the change. Limited to 128 characters.

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

type [required]

\n
\n

enum

\n

Author's type. \nAllowed enum values: user,system,api,automation

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

change_metadata

\n
\n

object

\n

Free form JSON object with information related to the change event. Supports up to 100 properties per object and a maximum nesting depth of 10 levels.

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

changed_resource [required]

\n
\n

object

\n

A uniquely identified resource.

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

name [required]

\n
\n

string

\n

The name of the resource that was changed. Limited to 128 characters.

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

type [required]

\n
\n

enum

\n

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

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

impacted_resources

\n
\n

[object]

\n

A list of resources impacted by this change. It is recommended to provide an impacted resource to display\nthe change event at the correct location. Only resources of type service are supported. Maximum of 100 impacted resources allowed.

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

name [required]

\n
\n

string

\n

The name of the impacted resource. Limited to 128 characters.

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

type [required]

\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

Free form JSON object representing the new state of the changed resource.

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

prev_value

\n
\n

object

\n

Free form JSON object representing the previous state of the changed resource.

\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

custom

\n
\n

object

\n

Free form JSON object for arbitrary data. Supports up to 100 properties per object and a maximum nesting depth of 10 levels.

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

links

\n
\n

[object]

\n

The links related to the event. Maximum of 20 links allowed.

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

category [required]

\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. Limited to 300 characters.

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

url [required]

\n
\n

string

\n

The URL of the link. Limited to 2048 characters.

\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

default: 5

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

status [required]

\n
\n

enum

\n

The status of the alert. \nAllowed enum values: warn,error,ok

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

category [required]

\n
\n

enum

\n

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

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

host

\n
\n

string

\n

Host name to associate with the event. Any tags associated with the host are also applied to this event. Limited to 255 characters.

\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

message

\n
\n

string

\n

Free formed text associated with the event. It's suggested to use data.attributes.attributes.custom for well-structured attributes. Limited to 4000 characters.

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

tags

\n
\n

[string]

\n

A list of tags associated with the event. Maximum of 100 tags allowed.\nRefer to Tags docs.

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

timestamp

\n
\n

string

\n

Timestamp when the event occurred. Must follow ISO 8601 format.\nFor example "2017-01-15T01:30:15.010000Z".\nDefaults to the timestamp of receipt. Limited to values no older than 18 hours.

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

title [required]

\n
\n

string

\n

The title of the event. Limited to 500 characters.

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

type [required]

\n
\n

enum

\n

Entity type. \nAllowed enum values: event

\n
\n \n
\n
\n
\n
" } }, "SearchEvents": { diff --git a/content/en/api/v2/events/request.CreateEvent.json b/content/en/api/v2/events/request.CreateEvent.json index db9b931294d..805b9f9824f 100644 --- a/content/en/api/v2/events/request.CreateEvent.json +++ b/content/en/api/v2/events/request.CreateEvent.json @@ -43,6 +43,7 @@ }, "category": "change", "integration_id": "custom-events", + "host": "test-host", "message": "payment_processed feature flag has been enabled", "tags": [ "env:api_client_test" diff --git a/data/api/v2/full_spec.yaml b/data/api/v2/full_spec.yaml index ff8c9a3f54d..b4822fa9a90 100644 --- a/data/api/v2/full_spec.yaml +++ b/data/api/v2/full_spec.yaml @@ -19997,6 +19997,13 @@ components: $ref: '#/components/schemas/EventPayloadAttributes' category: $ref: '#/components/schemas/EventCategory' + host: + description: Host name to associate with the event. Any tags associated + with the host are also applied to this event. Limited to 255 characters. + example: hostname + maxLength: 255 + minLength: 1 + type: string integration_id: $ref: '#/components/schemas/EventPayloadIntegrationId' message: @@ -67887,6 +67894,7 @@ paths: rule: datacenter: devcycle.us1.prod category: change + host: hostname integration_id: custom-events message: payment_processed feature flag has been enabled tags: