SOAP API Reference: AlarmService

Description

Retrieve alarms and update the status and comments of alarms.

Type

SOAP

Style

Document

Methods and Types

• Methods: AlarmService

  Name	Description
  AddAlarmComments	Update alarm with comments. The Alarm ID is derived from one of the GetFirstPageAlarms or a GetNextPageAlarms method call.
  GetAlarmByID	Retrieve a single alarm by the unique alarm identifier alarm. The Alarm ID is derived from one of the GetFirstPageAlarms or a GetNextPageAlarms method call.
  GetAlarmEventsByID	Retrieve a list of events associated to this alarm. The Alarm ID is derived from one of the GetFirstPageAlarms or a GetNextPageAlarms method call.
  GetAlarmHistoryByID	Retrieve a list of alarm status and comment updates. The Alarm ID is derived from one of the GetFirstPageAlarms or a GetNextPageAlarms method call.
  GetFirstPageAlarms	Retrieve the first page of alarms.
  GetFirstPageAlarmsByAlarmRuleID	Retrieve the first page of alarms filtered by the alarm rule.
  GetFirstPageAlarmsByAlarmStatus	Retrieve the first page of alarms filtered by the alarm status.
  GetFirstPageAlarmsByEntityID	Retrieve the first page of alarms filtered by the entity.
  GetNextPageAlarms	Retrieve the next page of alarms.
  UpdateAlarmStatus	Update the alarm status and optionally provide comments. The Alarm ID is derived from one of the GetFirstPageAlarms or a GetNextPageAlarms method call.

• Complex Types: AlarmService

  Name	Description
  AlarmCommentDataModel	Response model for the current state of a single alarm including the last provided comment.  This model is returned to the client in an array as a result of alarms returned by a provided query.
  AlarmEventDataModel	Response model for alarms that include event data.
  AlarmHistoryDataModel	Response model for alarms that includes alarm history.
  AlarmNotificationDataModel	Response model for alarms that include alarm notifications.
  AlarmSummaryDataModel	Response model of an alarms current status.
  AlarmSummaryDataResults	Response model for alarm summary.
  ArrayOfLogDataModel
  ErrorInfo	Error details model.
  IPAddressDataModel	IP Address object used in alarms and log queries.
  LocationInfoDataModel	Location detail object used in alarms and log queries. Only available when GeoIP service is connected to the servers.
  LogDataModel	The data for a single log message and all associated metadata for that log.
  LogRhythmWebServiceFault	This is the error message object for all of LogRhythm Web Services.  This object provides custom meaningful error messages to the client while retaining security precautions for the system.
  NetworkDataModel	Network detail object used in alarms.
  SaveResult	A response object which supplies information about an attempt to insert data. This information includes record ID if created and error / warning messages if generated.
  WatchItemDataModel	An object that defines a Watch Item.

• Simple Types: AlarmService

  Name	Description
  AlarmStatusEnum	Indicates the status of the Alarm message.
  ContactMethodTypeEnum	Enumeration used to specify the desired contact method for a user within the system.
  DirectionEnum	Identifies the direction which message traffic is moving around the network.
  HostZoneEnum	Specifies the zone the host is within.
  LocationTypeEnum	Specifies the precision type of the location value.
  MessageTypeEnum	Specifies the meta type of the message.
  WatchItemTypeEnum	Specifies Networks, Host, or Logins that should alarm when they show up in logs.
  WatchLevelEnum	Specifies the priority of the alarm for the watch item.