Yamcs HTTP API
- Alarms
- Audit
- Buckets
- Clearance
- Commands
- Cop1
- Database
- Events
- File Transfer
- Iam
- Indexes
- Links
- Management
- Mdb Override
- Mdb
- Packets
- Parameter Archive
- Processing
- Queue
- Replication
- Rocks Db
- Server
- Sessions
- Stream Archive
- Table
- Time Correlation
- Time
- Timeline
Related
Yamcs Release Notes
Yamcs Server Manual
Source Code Documentation
Download this Document
Edit AlarmΒΆ
Update an alarm
URI Template
PATCH /api/processors/{instance}/{processor}/alarms/{name*}/{seqnum}
{instance}
Yamcs instance name.
{processor}
Processor name.
{name*}
Alarm name.
{seqnum}
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
}