Yamcs HTTP API
- Activities
- Alarms
- Audit
- Buckets
- Clearance
- Commands
- COP-1
- Database
- Events
- File Transfer
- IAM
- Indexes
- Instances
- Links
- MDB Override
- MDB
- Packets
- Parameter Archive
- Parameter Lists
- Parameter Values
- Processing
- Queues
- Replication
- RocksDB
- Server
- Services
- Sessions
- Stream Archive
- Table
- Time Correlation
- Time
- Timeline
Related
Yamcs Release Notes
Yamcs Server Manual
Source Code Documentation
Download this Document
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
}