SOAP API Reference: ListService

Description

Create and retrieve list of log sources, host, MPE Rules, Locations, etc.

Type

SOAP

Style

Document

Methods and Types

  • Methods: ListService

    Name

    Description

    AddGeneralListItem

    Add a new general list item.            

    AddHostListItemHostname

    Add a new host list item with a hostname.            

    AddHostListItemIPAddress

    Add a new host list item IP address.            

    AddHostListItemIPAddressRange

    Add a new host list item with an IP address range.            

    AddHostListItemKnownHost

    Adds a new host list item for a known host.            

    AddList

    Adds a new list.            

    AddUserListItem

    Add a new User list item.            

    ClearListItems

    Clear all items from a list.            

    CloneList

    Clone a list.            

    GetListByID

    Retrieve a list by ID.            

    GetListByType

    Retrieve all lists for a given type.            

    GetListByTypeAndName

    Retrieve all lists for a given type and name.            

    GetListByUseContext

    Retrieve all lists for a given use context.            

    GetLogSourceList

    Retrieve Log Source List.             

    UpdateList

    Update an existing list.            


  • Complex Types: ListService

    Name

    Description

    ArrayOfListDataModel

    A response collection of list data models.

    ErrorInfo

    Error details model.

    ListDataModel

    List data object used in alarms and log queries.

    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.

    PickListDataResults

    List object used for paging list of key value pairs.

    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: ListService

    Name

    Description

    ListTypeEnum

    Specifies the type of list.

    ListUseContextEnum

    Specifies the type of values contained within the context of the list.

    ReadWritePermissionEnum

    Specifies the read write permissions on the object.

    RecordStatusEnum

    Specifies the status of a record.

    TextTypeEnum

    Specifies if the text is parsable or not.