/  Yamcs HTTP API  /  Alarms  /  Shelve Alarm

Shelve AlarmΒΆ

Shelve an alarm

URI Template

POST /api/processors/{instance}/{processor}/alarms/{alarm*}/{seqnum}:shelve
{instance}

Yamcs instance name

{processor}

Processor name

{alarm*}

Alarm name

{seqnum}

Request Body

interface ShelveAlarmRequest {

  // 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
}