Get

/alarms/{id}/

This endpoint returns details of a specified alarm

Security

HTTP

Type basic

Basic authentication using VMS user name and password

API Key: ApiToken

Header parameter nameApiToken

Send current valid API token in an Authorization header with format Api-Token .

Path parameters

id

stringRequired

Alarm ID

Responses

200

Expand All

object

id

integer

timestamp

string (date-time)

last_updated

string (date-time)

Last alarm occurrence

event_definition

string

object_name

string

cluster

string

object_type

string

The type of object involved in the event that triggered the alarm.

object_id

integer

The object involved in the event that triggered the alarm.

object_guid

string

severity

string

The alarm severity. Can be minor, major or critical.

event

string

The event that raised the alarm.

alarm_message

string

A description of the event that triggered the alarm.

event_type

string

related event type

event_name

string

related event definition name

acknowledged

boolean

True if the alarm was acknowledged by the user

metadata

object

rel_obj_id

string

related object's id

rel_obj_class

string

related object's class, possible values: [host, dbox, cbox, null]

Return Details of an Alarm