SOAP API Reference: HostService

Description

Create, update, delete, and retrieve host.

Type

SOAP

Style

Document

Methods and Types

• Methods: HostService

  Name	Description
  AddHost	Add a new Host.
  AddHostIdentifier	Add a new host identifier.
  DeleteHostIdentifier	Deletes the host identifier.
  GetHostByID	Retrieve the host by ID.
  GetHostsByEntity	Retrieve all hosts for a given entity.
  GetHostsByEntityAndIPIdentifier	Retrieve all hosts by entity and IP identifier.
  GetHostsByEntityAndLogRhythmHostName	Retrieve all hosts by entity and LogRhythm hostname.
  GetHostsByEntityAndNameIdentifier	Retrieve all hosts by entity and host or DNS name identifier.
  GetHostsByIPIdentifier	Retrieve all hosts by IP identifier.
  GetHostsByLogRhythmHostName	Retrieve all hosts by LogRhythm hostname.
  GetHostsByNameIdentifier	Retrieve all hosts by host of DNS name identifier.
  UpdateHost	Update a host.
  UpsertHosts	Inserts, updates, or retires multiple hosts.

  
  

• Complex Types: HostService

  Name	Description
  ArrayOfHostDataModel	A response collection of host data models.
  ArrayOfSaveResult	A response object that supplies information about an attempt to insert/update/retire hosts. This information includes a record ID, Key, and error/warning messages if generated.
  ErrorInfo	Error details model.
  HostDataModel	Host response model.
  HostIdentifierDataModel	Host identifier response model.
  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.
  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.

  
  

• Simple Types: HostService

  Name	Description
  HostIdentifierTypeEnum	Specifies the type of value that identify the host.
  HostOSEnum	Specifies the operating system on the host.
  RecordStatusEnum	Specifies the status of a record.
  RiskLevelEnum	Specifies the risk level for a host or message source.