SOAP API Reference: LogQueryService

Description

Create queries to retrieve logs.

Type

SOAP

Style

Document

Methods and Types

• Methods: LogQueryService

  Name	Description
  ExecuteQuery	Executes a complex query for logs that match query parameters.

• Complex Types: LogQueryService

  Name	Description
  ArrayOfLogDataModel
  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.
  LogQueryDateRangeValue	This object is used to define the scope of a date range for a log query.
  LogQueryFilterDataModel	The generic form of a log query filter.
  LogQueryFilterValueBigIntegerDataModel
  LogQueryFilterValueByteDataModel
  LogQueryFilterValueDataModel	The generic Log Query filter Value object.
  LogQueryFilterValueDateRangeDataModel
  LogQueryFilterValueIntegerDataModel
  LogQueryFilterValueIPAddressDataModel
  LogQueryFilterValueIPRangeDataModel
  LogQueryFilterValuePortRangeDataModel
  LogQueryFilterValueQuantityDataModel
  LogQueryFilterValueStringDataModel
  LogQueryFilterValueTimeSpanDataModel
  LogQueryIPRangeValue	Value object used to express an IP address range for log queries.
  LogQueryParametersDataModel	This is the base Log Query request object.
  LogQueryPortRangeValue	Object which represents the start and end values for a port range.
  LogQueryQuantityValue	Gets or sets the port range value.
  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.
  WatchItemDataModel	An object that defines a Watch Item.

• Simple Types: LogQueryService

  Name	Description
  HostZoneEnum	Specifies the zone the host is within.
  LocationTypeEnum	Specifies the precision type of the location value.
  LogQueryFilterModeEnum	The LogQueryFilterModeEnum is used to specify if results matching the criteria are to be included or excluded from the results.
  LogQueryFilterOperatorEnum	The LogQueryFilterOperatorEnum is used to express the boolean operator applied to a LogQueryFilter.
  LogQueryFilterTypeEnum	LogQueryFilterTypeEnum is used to specify the type of search for a given filter. It also determines the type(s) of values that can be submitted in the request.
  LogQueryFilterValueTypeEnum	LogQueryFilter value types which represent the type of objects stored in the filters.
  LogQueryQuantityOperatorEnum	This enumeration is used for Quantity value type to specify the relationship of the selected quantity to the value(s) provided.
  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.