Push Event Using POST

Push Event Using POST

Push a single Event into the system

Request
URI
POST
https://{api_host}/api/events
COPY
Request Body

The event object

event of type(s) application/json
Required

Show optional properties

{
    "eventType": "string",
    "message": "string",
    "resourceId": "string"
}
{
    "cancelTimeUTC": 0,
    "eventType": "string",
    "htType": "string",
    "key": "string",
    "keyIndicator": false,
    "managedExternally": false,
    "message": "string",
    "resourceId": "string",
    "severity": "string",
    "startTimeUTC": 0,
    "value": "number"
}
integer As int64 As int64
cancelTimeUTC
Optional

Indicates that an event has been cancelled. For an externally managed event a new event with the same message value must be sent with a cancelTime in order to cancel the event.

string
eventType
Required

The type of the event. Different event types have different required fields.

Possible values are : CHANGE, NOTIFICATION, RESOURCE_DOWN, SYSTEM_DEGRADATION, AVAILABILITY_DOWN, AVAILABILITY_EXCEPTION, AVAILABILITY_NOT_COLLECTING, HARD_THRESHOLD,
string
htType
Optional

The type of hard threshold violation

Possible values are : EQUAL, NOT_EQUAL, ABOVE, BELOW,
string
key
Optional

The StatKey for the condition of the HardThreshold event

boolean
keyIndicator
Optional

Whether the HardThreshold event is a key performance indicator True indicates it is a KPI. False otherwise.

boolean
managedExternally
Optional

If set to true, this event shall persist across collection cycles until another event is pushed to change the status. If set to false, this event will be cancelled during the next collection cycle if it is not pushed again

string
message
Required

Event message, the message identifies the event in the system.

string As uuid As uuid
resourceId
Required

The id of the resource for the event

string
severity
Optional

The severity of a system degradation event

Possible values are : UNKNOWN, NONE, INFORMATION, WARNING, IMMEDIATE, CRITICAL, AUTO,
integer As int64 As int64
startTimeUTC
Optional

The start time for the event in UTC. This time must be after >= 946684800000L, or January 1, 2000. Default is 946684800000L. Value is ignored for Change events.

number As double As double
value
Optional

The current value (not the expected value) of the metric for the HardThreshold event

Authentication
This operation uses the following authentication methods.
Responses
200

The Event is added successfully

Operation doesn't return any data structure

On This Page
Events Operations
POST
Push Event By Adapter Kind Key Using POST
POST
Push Events By Adapter Kind Key Using POST
POST
Push Events Using POST
POST
Push Event Using POST