Methods
Request
Custom Headers
Allowable values: [
application/json,text/plain]
Query Parameters
Event deduplication identifier
Event Identifier
Possible values: Value must match regular expression
^[0-9a-f]{8}-[0-9a-f]{4}-1[0-9a-f]{3}-[0-9a-f]{4}-[0-9a-f]{12}$
Response
The unique identifier of the event
Example:
201675c0-7fe5-11e6-9d4f-6dc0ca8a3f41The qualified subject of the event. I.e. the managed entity about which the event was generated. These fields participate in deduplication
resource
Indicates the event severity level, which indicates how the perceived capability of the managed object has been affected. Severity will be in the range 1 to 5 where 1 is the lowest severity and 5 is the highest
Possible values: [
Critical,Major,Minor,Warning,Information,Indeterminate,5,4,3,2,1,60,50,40,30,20,10]Indicates the event severity level, which indicates how the perceived capability of the managed object has been affected. 10 is the lowest severity, 60 is the highest
Possible values: [
10,20,30,40,50,60]Contains text which describes the event condition
The classification of the event based on the resource type, the event type and the threshold breach or status
This is the key used to determine if two instances of an event record presented to the system de-duplicate If present prevents construction of identifier for de-duplication if not present the Identifier will be constructed from the resource and type fields.
Additional properties for the event. An Object with free format properties, values must be either string or integer
details
Possible values: [
open,clear,closed]The number of seconds after which the event will be cleared, if there have been no further occurrence
Possible values: value ≥ 1
Example:
3600RFC 3339 format timestamp. The time of the earliest event occurrence for this instance
True if a flapping policy applies and the event instance is currently within the flapping threshold
UUID of the associated incident
Example:
201675c0-7fa5-11e6-1d4f-9cb0ca7a3eeaRFC 3339 format timestamp. The time of the most recent event occurrence for this instance
Resources that have a relation to the resource that has the event
relatedResources
Runbooks and parameter mapping associated with this event
The system sending the event
sender
The event has been suppressed from becomming an incident
If the event generation system provides with additional URL to triage to deep dive this field can be used. Public URL provided by the origin to access further information, opened in a browser, not for programatic access.
True if an X-in-Y policy applies and the event instance has not yet breached the threshold
Status Code
200 OK
Invalid request
Unable to locate the event
No Sample Response
Request
Custom Headers
Allowable values: [
application/json,text/plain]
Creates an event
The entity about which the event was generated. These fields participate in deduplication
resource
The event severity level, which indicates how the perceived capability of the managed object has been affected. If using the numeric scale, 10 is the lowest severity, with 60 being the highest severity level. The levels 1 through 5 are for backwards compatibility and will be removed.
Allowable values: [
Critical,Major,Minor,Warning,Information,Indeterminate,5,4,3,2,1,60,50,40,30,20,10]Contains text which describes the event condition
Possible values: length ≥ 1
The classification of the event based on the resource type, the event type and the threshold breach or status
This is the key used to determine if two instances of an event record presented to the system de-duplicate If present prevents construction of identifier for de-duplication if not present the Identifier will be constructed from the resource and type fields.
Additional event attributes and values. Values must be a string or an integer
details
The number of seconds after which the event will be cleared, if there have been no further occurrence
Possible values: value ≥ 1
Default:
1Example:
3600Managed resources that have a relation to the managed resource that has the event
relatedResources
True if this is a resolution event
Default:
falseThe system sending the event
sender
The time the event occurred
If the event generation system provides with additional URL to triage to deep dive this field can be used. Public URL provided by the origin to access further information, opened in a browser, not for programatic access.
Response
This is the key used to determine if two instances of an event record presented to the system de-duplicate If present prevents construction of identifier for de-duplication if not present the Identifier will be constructed from the resource and type fields.
The unique identifier for the event
Example:
201675c0-7fe5-11e6-9d4f-6dc0ca8a3f41
Status Code
200 OK
Invalid request
Invalid media type