/  Yamcs HTTP API  /  Alarms  /  Edit Alarm

Edit AlarmΒΆ

Update an alarm

URI Template

PATCH /api/processors/{instance}/{processor}/alarms/{name*}/{seqnum}

Yamcs instance name.


Processor name.


Alarm name.


Request Body

interface EditAlarmRequest {

  // **Required.** The state of the alarm.
  // Either ``acknowledged``, ``shelved``, ``unshelved`` or ``cleared``.
  state: string;

  // Message documenting the alarm change.
  comment: string;

  //shelve time in milliseconds (if the state = shelved)
  //can be left out which means it is shelved indefinitely
  shelveDuration: string;  // String decimal