SOAP API ListService, Methods
Method: AddGeneralListItem
Description
Add a new general list item.
Input
The input of this method is the argument AddGeneralListItem having the following structure.
Element | Type | Nillable? | Description |
|---|---|---|---|
listID | int | No | The list ID. |
textType | TextTypeEnum | No | Type of the text. |
value | string | Yes | The value. |
Output
The output of this method is the argument AddGeneralListItemResponse that is always empty.
Faults
Name | Content | Description |
|---|---|---|
LogRhythmWebServiceFaultFault | 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. |
EXAMPLE
private void AddGeneralListItem(int listID, TextTypeEnum textType, string value)
{
ListServiceClient listClient = null;
try
{
// Create connection to service.
listClient = new ListServiceClient("ListServiceBasicAuth_ListService");
listClient.ClientCredentials.UserName.UserName = username;
listClient.ClientCredentials.UserName.Password = password;
// Call method
listClient.AddGeneralListItem(listID, textType, value);
}
finally
{
if (listClient != null && listClient.State != System.ServiceModel.CommunicationState.Faulted)
{
listClient.Close();
}
}
}
Method: AddHostListItemHostname
Description
Add a new host list item with a hostname.
Input
The input of this method is the argument AddHostListItemHostname having the following structure.
Element | Type | Nillable? | Description |
|---|---|---|---|
listID | int | No | The list ID. |
textType | TextTypeEnum | No | Type of the text. |
hostName | string | Yes | Name of the host. |
Output
The output of this method is the argument AddHostListItemHostnameResponse that is always empty.
Faults
Name | Content | Description |
|---|---|---|
LogRhythmWebServiceFaultFault | 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. |
EXAMPLE
private void AddHostListItemHostname(int listID, TextTypeEnum textType, string hostName)
{
ListServiceClient listClient = null;
try
{
// Create connection to service.
listClient = new ListServiceClient("ListServiceBasicAuth_ListService");
listClient.ClientCredentials.UserName.UserName = username;
listClient.ClientCredentials.UserName.Password = password;
// Call method
listClient.AddHostListItemHostname(listID, textType, hostName);
}
finally
{
if (listClient != null && listClient.State != System.ServiceModel.CommunicationState.Faulted)
{
listClient.Close();
}
}
}
Method: AddHostListItemIPAddress
Description
Add a new host list item IP address.
Input
The input of this method is the argument AddHostListItemIPAddress having the following structure.
Element | Type | Nillable? | Description |
|---|---|---|---|
listID | int | No | The list ID. |
IPAddressValue | string | Yes | The IP address value. |
Output
The output of this method is the argument AddHostListItemIPAddressResponse that is always empty.
Faults
Name | Content | Description |
|---|---|---|
LogRhythmWebServiceFaultFault | 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. |
EXAMPLE
private void AddHostListItemIPAddress(int listID, string ipAddressValue)
{
ListServiceClient listClient = null;
try
{
// Create connection to service.
listClient = new ListServiceClient("ListServiceBasicAuth_ListService");
listClient.ClientCredentials.UserName.UserName = username;
listClient.ClientCredentials.UserName.Password = password;
// Call method
listClient.AddHostListItemIPAddress(listID, ipAddressValue);
}
finally
{
if (listClient != null && listClient.State != System.ServiceModel.CommunicationState.Faulted)
{
listClient.Close();
}
}
}
Method: AddHostListItemIPAddressRange
Description
Add a new host list item with an IP address range.
Input
The input of this method is the argument AddHostListItemIPAddressRange having the following structure.
Element | Type | Nillable? | Description |
|---|---|---|---|
listID | int | No | The list ID. |
fromIPAddress | string | Yes | From IP address. |
toIPAddress | string | Yes | To IP address. |
Output
The output of this method is the argument AddHostListItemIPAddressRangeResponse that is always empty.
Faults
Name | Content | Description |
|---|---|---|
LogRhythmWebServiceFaultFault | 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. |
EXAMPLE
private void AddHostListItemIPAddressRange(int listID, string fromIPAddress, string toIPAddress)
{
ListServiceClient listClient = null;
try
{
// Create connection to service.
listClient = new ListServiceClient("ListServiceBasicAuth_ListService");
listClient.ClientCredentials.UserName.UserName = username;
listClient.ClientCredentials.UserName.Password = password;
// Call method
listClient.AddHostListItemIPAddressRange(listID, fromIPAddress, toIPAddress);
}
finally
{
if (listClient != null && listClient.State != System.ServiceModel.CommunicationState.Faulted)
{
listClient.Close();
}
}
}
Method: AddHostListItemKnownHost
Description
Adds a new host list item for a known host.
Input
The input of this method is the argument AddHostListItemKnownHost having the following structure.
Element | Type | Nillable? | Description |
|---|---|---|---|
listID | int | No | The list ID. |
entityID | int | No | The entity ID. |
LogRhythmHostName | string | Yes | Name of the LogRhythm host. |
Output
The output of this method is the argument AddHostListItemKnownHostResponse that is always empty.
Faults
Name | Content | Description |
|---|---|---|
LogRhythmWebServiceFaultFault | 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. |
EXAMPLE
private void AddHostListItemKnownHost(int listID, int entityID, string LogRhythmHostName)
{
ListServiceClient listClient = null;
try
{
// Create connection to service.
listClient = new ListServiceClient("ListServiceBasicAuth_ListService");
listClient.ClientCredentials.UserName.UserName = username;
listClient.ClientCredentials.UserName.Password = password;
// Call method
listClient.AddHostListItemKnownHost(listID, entityID, LogRhythmHostName);
}
finally
{
if (listClient != null && listClient.State != System.ServiceModel.CommunicationState.Faulted)
{
listClient.Close();
}
}
}
Method: AddList
Description
Adds a new list.
Input
The input of this method is the argument AddList having the following structure.
Element | Type | Nillable? | Description |
|---|---|---|---|
listData | ListDataModel | Yes | The list data. |
Output
The result of the save.
Element | Type | Nillable? | Description |
|---|---|---|---|
AddListResult | SaveResult | Yes | 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. |
EXAMPLE
private SaveResult AddList(ListDataModel listData)
{
ListServiceClient listClient = null;
SaveResult result = null;
try
{
// Create connection to service.
listClient = new ListServiceClient("ListServiceBasicAuth_ListService");
listClient.ClientCredentials.UserName.UserName = username;
listClient.ClientCredentials.UserName.Password = password;
// Call method
result = listClient.AddList(listData);
}
finally
{
if (listClient != null && listClient.State != System.ServiceModel.CommunicationState.Faulted)
{
listClient.Close();
}
}
return result;
}
Method: AddUserListItem
Description
Add a new User list item.
Input
The input of this method is the argument AddUserListItem having the following structure.
Element | Type | Nillable? | Description |
|---|---|---|---|
listID | int | No | The list ID. |
textType | TextTypeEnum | No | Type of the text. |
value | string | Yes | The value. |
Output
The output of this method is the argument AddUserListItemResponse that is always empty.
Faults
Name | Content | Description |
|---|---|---|
LogRhythmWebServiceFaultFault | 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. |
EXAMPLE
private void AddUserListItem(int listID, TextTypeEnum textType, string value)
{
ListServiceClient listClient = null;
try
{
// Create connection to service.
listClient = new ListServiceClient("ListServiceBasicAuth_ListService");
listClient.ClientCredentials.UserName.UserName = username;
listClient.ClientCredentials.UserName.Password = password;
// Call method
listClient.AddUserListItem(listID, textType, value);
}
finally
{
if (listClient != null && listClient.State != System.ServiceModel.CommunicationState.Faulted)
{
listClient.Close();
}
}
}
Method: ClearListItems
Description
Clear all items from a list.
Input
The input of this method is the argument ClearListItems having the following structure.
Element | Type | Nillable? | Description |
|---|---|---|---|
listID | int | No | The list ID. |
clearSubListsToo | boolean | No | If true, clear sub lists too. |
Output
The output of this method is the argument ClearListItemsResponse that is always empty.
Faults
Name | Content | Description |
|---|---|---|
LogRhythmWebServiceFaultFault | 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. |
EXAMPLE
private void ClearListItems(int listID, bool clearSubList)
{
ListServiceClient listClient = null;
try
{
// Create connection to service.
listClient = new ListServiceClient("ListServiceBasicAuth_ListService");
listClient.ClientCredentials.UserName.UserName = username;
listClient.ClientCredentials.UserName.Password = password;
// Call method
listClient.ClearListItems(listID, clearSubList);
}
finally
{
if (listClient != null && listClient.State != System.ServiceModel.CommunicationState.Faulted)
{
listClient.Close();
}
}
}
Method: CloneList
Description
Clone a list.
Input
The input of this method is the argument CloneList having the following structure.
Element | Type | Nillable? | Description |
|---|---|---|---|
listID | int | No | The list ID. |
newListName | string | Yes | New name of the list. |
Output
The cloned list.
Element | Type | Nillable? | Description |
|---|---|---|---|
CloneListResult | ListDataModel | Yes | List data object used in alarms and log queries. |
Faults
Name | Content | Description |
|---|---|---|
LogRhythmWebServiceFaultFault | 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. |
EXAMPLE
private ListDataModel CloneList(int listID, string newListName)
{
ListServiceClient listClient = null;
ListDataModel model = null;
try
{
// Create connection to service.
listClient = new ListServiceClient("ListServiceBasicAuth_ListService");
listClient.ClientCredentials.UserName.UserName = username;
listClient.ClientCredentials.UserName.Password = password;
// Call method
model = listClient.CloneList(listID, newListName);
}
finally
{
if (listClient != null && listClient.State != System.ServiceModel.CommunicationState.Faulted)
{
listClient.Close();
}
}
return model;
}
Method: GetListByID
Description
Retrieve a list by ID.
Input
The input of this method is the argument GetListByID having the following structure.
Element | Type | Nillable? | Description |
|---|---|---|---|
listID | int | No | The list ID. |
Output
The list data of found, otherwise null is returned.
Element | Type | Nillable? | Description |
|---|---|---|---|
GetListByIDResult | ListDataModel | Yes | List data object used in alarms and log queries. |
Faults
Name | Content | Description |
|---|---|---|
LogRhythmWebServiceFaultFault | 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. |
EXAMPLE
private ListDataModel GetListByID(int listID)
{
ListServiceClient listClient = null;
ListDataModel model = null;
try
{
// Create connection to service.
listClient = new ListServiceClient("ListServiceBasicAuth_ListService");
listClient.ClientCredentials.UserName.UserName = username;
listClient.ClientCredentials.UserName.Password = password;
// Call method
model = listClient.GetListByID(listID);
}
finally
{
if (listClient != null && listClient.State != System.ServiceModel.CommunicationState.Faulted)
{
listClient.Close();
}
}
return model;
}
Method: GetListByType
Description
Retrieve all lists for a given type.
Input
The input of this method is the argument GetListByType having the following structure.
Element | Type | Nillable? | Description |
|---|---|---|---|
listType | ListTypeEnum | No | Type of the list. |
Output
All matching lists, or an empty list if none found.
Element | Type | Nillable? | Description |
|---|---|---|---|
GetListByTypeResult | ArrayOfListDataModel | Yes | A response collection of list data models. |
Faults
Name | Content | Description |
|---|---|---|
LogRhythmWebServiceFaultFault | 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. |
EXAMPLE
private ListDataModel[] GetListByType(ListTypeEnum listType)
{
ListServiceClient listClient = null;
ListDataModel[] models = null;
try
{
// Create connection to service.
listClient = new ListServiceClient("ListServiceBasicAuth_ListService");
listClient.ClientCredentials.UserName.UserName = username;
listClient.ClientCredentials.UserName.Password = password;
// Call method
models = listClient.GetListByType(listType);
}
finally
{
if (listClient != null && listClient.State != System.ServiceModel.CommunicationState.Faulted)
{
listClient.Close();
}
}
return models;
}
Method: GetListByTypeAndName
Description
Retrieve all lists for a given type and name.
Input
The input of this method is the argument GetListByTypeAndName having the following structure.
Element | Type | Nillable? | Description |
|---|---|---|---|
listType | ListTypeEnum | No | Type of the list. |
name | string | Yes | The name. |
Output
All matching lists, or an empty list if none found.
Element | Type | Nillable? | Description |
|---|---|---|---|
GetListByTypeAndNameResult | ArrayOfListDataModel | Yes | A response collection of list data models. |
Faults
Name | Content | Description |
|---|---|---|
LogRhythmWebServiceFaultFault | 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. |
EXAMPLE
private ListDataModel[] GetListByTypeAndName(ListTypeEnum listType, string name)
{
ListServiceClient listClient = null;
ListDataModel[] models = null;
try
{
// Create connection to service.
listClient = new ListServiceClient("ListServiceBasicAuth_ListService");
listClient.ClientCredentials.UserName.UserName = username;
listClient.ClientCredentials.UserName.Password = password;
// Call method
models = listClient.GetListByTypeAndName(listType, name);
}
finally
{
if (listClient != null && listClient.State != System.ServiceModel.CommunicationState.Faulted)
{
listClient.Close();
}
}
return models;
}
Method: GetListByUseContext
Description
Retrieve all lists for a given use context.
Input
The input of this method is the argument GetListByUseContext having the following structure.
Element | Type | Nillable? | Description |
|---|---|---|---|
useContext | ListUseContextEnum | No | The use context. |
Output
All matching lists, or an empty list if none found.
Element | Type | Nillable? | Description |
|---|---|---|---|
GetListByUseContextResult | ArrayOfListDataModel | Yes | A response collection of list data models. |
Faults
Name | Content | Description |
|---|---|---|
LogRhythmWebServiceFaultFault | 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. |
EXAMPLE
private ListDataModel[] GetListByUseContext(ListUseContextEnum listUseContext)
{
ListServiceClient listClient = null;
ListDataModel[] models = null;
try
{
// Create connection to service.
listClient = new ListServiceClient("ListServiceBasicAuth_ListService");
listClient.ClientCredentials.UserName.UserName = username;
listClient.ClientCredentials.UserName.Password = password;
// Call method
models = listClient.GetListByUseContext(listUseContext);
}
finally
{
if (listClient != null && listClient.State != System.ServiceModel.CommunicationState.Faulted)
{
listClient.Close();
}
}
return models;
}
Method: GetLogSourceList
Description
Retrieve Log Source List.
Input
The input of this method is the argument GetLogSourceList that is always empty.
Output
List of int ID values and string names.
Element | Type | Nillable? | Description |
|---|---|---|---|
GetLogSourceListResult | PickListDataResults | Yes | List object used for paging list of key value pairs. |
Faults
Name | Content | Description |
|---|---|---|
LogRhythmWebServiceFaultFault | 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. |
EXAMPLE
private PickListDataResults GetLogSourceList()
{
ListServiceClient listClient = null;
PickListDataResults results = null;
try
{
// Create connection to service.
listClient = new ListServiceClient("ListServiceBasicAuth_ListService");
listClient.ClientCredentials.UserName.UserName = username;
listClient.ClientCredentials.UserName.Password = password;
// Call method
results = listClient.GetLogSourceList();
}
finally
{
if (listClient != null && listClient.State != System.ServiceModel.CommunicationState.Faulted)
{
listClient.Close();
}
}
return results;
}
Method: UpdateList
Description
Update an existing list.
Input
The input of this method is the argument UpdateList having the following structure.
Element | Type | Nillable? | Description |
|---|---|---|---|
listData | ListDataModel | Yes | The list data. |
Output
The result of the update.
Element | Type | Nillable? | Description |
|---|---|---|---|
UpdateListResult | SaveResult | Yes | 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. |
EXAMPLE
private SaveResult UpdateList(ListDataModel list)
{
ListServiceClient listClient = null;
SaveResult result = null;
try
{
// Create connection to service.
listClient = new ListServiceClient("ListServiceBasicAuth_ListService");
listClient.ClientCredentials.UserName.UserName = username;
listClient.ClientCredentials.UserName.Password = password;
// Call method
result = listClient.UpdateList(list);
}
finally
{
if (listClient != null && listClient.State != System.ServiceModel.CommunicationState.Faulted)
{
listClient.Close();
}
}
return result;
}