Docs / Yamcs HTTP API / Alarms / Edit Alarm

Edit Alarm

PATCH /api/processors/:instance/:processor/parameters/:namespace/:name/alarms/:seqnum

Parameters

Name Type Description
state string Required. The state of the alarm. Either acknowledged or unacknowledged
comment string Message documenting the alarm change.

Example

{
  "state": "acknowledged",
  "comment": "bla bla"
}

Alternative Media Types

Protobuf

Use these HTTP headers:

Content-Type: application/protobuf
Accept: application/protobuf

Request is of type:

rest/rest.proto 
message EditAlarmRequest {
  optional string state = 1;
  optional string comment = 2;
}