keyboard_arrow_down
  • 12.0
  • 20.0

Software Inventories

List Software Inventories

get/softwareinventories

Lists all software inventories.

Related SDK Methods:
Java

SoftwareInventoriesApi.listSoftwareInventories([param1, param2, ...])
Python

SoftwareInventoriesApi.list_software_inventories([param1, param2, ...])
JavaScript

SoftwareInventoriesApi.listSoftwareInventories([param1, param2, ...])

Request
Security:
DefaultAuthentication
header Parameters
api-version
required
string

The version of the api being called.

Example: YOUR VERSION
Responses
200

successful operation

403

Not authorized to view software inventories.

Request samples
import com.trendmicro.deepsecurity.ApiClient;
import com.trendmicro.deepsecurity.Configuration;
import com.trendmicro.deepsecurity.auth.ApiKeyAuth;
import com.trendmicro.deepsecurity.ApiException;
import com.trendmicro.deepsecurity.api.SoftwareInventoriesApi;
import com.trendmicro.deepsecurity.model.SoftwareInventories;


public class ListSoftwareInventoriesExample {
	
	public static void main(String[] args) {
		// Setup
		ApiClient defaultClient = Configuration.getDefaultApiClient();
		defaultClient.setBasePath("YOUR HOST");

		// Authentication
		ApiKeyAuth DefaultAuthentication = (ApiKeyAuth) defaultClient.getAuthentication("DefaultAuthentication");
		DefaultAuthentication.setApiKey("YOUR API KEY");
		try {
			defaultClient.trustAllCertificates(false);
		} catch (Exception e) {
			System.err.println("An exception occurred when calling ApiClient.trustAllCertificates");
			e.printStackTrace();
		}
		
		// Initialization
		// Set Any Required Values
		SoftwareInventoriesApi instance = new SoftwareInventoriesApi();
		String apiVersion = "YOUR VERSION";
		try {
			// Please replace the parameter values with yours
			SoftwareInventories result = instance.listSoftwareInventories(apiVersion);
			System.out.println(result);
		} catch (ApiException e) {
			System.err.println("An exception occurred when calling SoftwareInventoriesApi.listSoftwareInventories");
			e.printStackTrace();
		}
	}
}
Response samples
application/json
{
  • "softwareInventories": [
    ]
}

Create a Software Inventory

post/softwareinventories

Request the creation of a new software inventory to use in creating shared rulesets.

Related SDK Methods:
Java

SoftwareInventoriesApi.createSoftwareInventory([param1, param2, ...])
Python

SoftwareInventoriesApi.create_software_inventory([param1, param2, ...])
JavaScript

SoftwareInventoriesApi.createSoftwareInventory([param1, param2, ...])

Request
Security:
DefaultAuthentication
header Parameters
api-version
required
string

The version of the api being called.

Example: YOUR VERSION
Request Body schema: application/json

The settings of the new software inventory.

computerID
integer <int32>

ID of the computer that the inventory scan was performed on (or is being performed on). Searchable as Numeric.

description
string

Description of the inventory. Searchable as String.

name
string

Name of the inventory. Searchable as String.

Responses
200

successful operation

403

Not authorized to create software inventories.

Request samples
application/json
{
  • "computerID": 0,
  • "name": "string",
  • "description": "string"
}
Response samples
application/json
{
  • "computerID": 0,
  • "name": "string",
  • "description": "string",
  • "state": "unknown",
  • "startDate": 0,
  • "completedDate": 0,
  • "initiatorID": 0,
  • "ID": 0
}

Search Software Inventories

post/softwareinventories/search

Search for a software inventory using optional filters.

Related SDK Methods:
Java

SoftwareInventoriesApi.searchSoftwareInventories([param1, param2, ...])
Python

SoftwareInventoriesApi.search_software_inventories([param1, param2, ...])
JavaScript

SoftwareInventoriesApi.searchSoftwareInventories([param1, param2, ...])

Request
Security:
DefaultAuthentication
header Parameters
api-version
required
string

The version of the api being called.

Example: YOUR VERSION
Request Body schema: application/json

A collection of options used to filter the search results.

maxItems
integer <int32>

Limits the number of objects returned. Default 5000.

Array of objects (searchCriteria)

Array of search critiera used to filter objects. Searching with multiple criteria returns results that satisfy all of the criteria. Searching with no criteria returns all objects.

sortByObjectID
boolean

If true, forces the response objects to be sorted by ID, overriding the default sort order. Default "false".

Responses
200

successful operation

403

Not authorized to view software inventories.

Request samples
application/json
{
  • "maxItems": 0,
  • "searchCriteria": [
    ],
  • "sortByObjectID": true
}
Response samples
application/json
{
  • "softwareInventories": [
    ]
}

Describe a Software Inventory

get/softwareinventories/{softwareInventoryID}

Describe a software inventory by ID.

Related SDK Methods:
Java

SoftwareInventoriesApi.describeSoftwareInventory([param1, param2, ...])
Python

SoftwareInventoriesApi.describe_software_inventory([param1, param2, ...])
JavaScript

SoftwareInventoriesApi.describeSoftwareInventory([param1, param2, ...])

Request
Security:
DefaultAuthentication
path Parameters
softwareInventoryID
required
integer <int64> \d+

The ID number of the software inventory to describe.

Example: 1
header Parameters
api-version
required
string

The version of the api being called.

Example: YOUR VERSION
Responses
200

successful operation

403

Not authorized to view software inventories.

404

The software inventory does not exist.

Request samples
import com.trendmicro.deepsecurity.ApiClient;
import com.trendmicro.deepsecurity.Configuration;
import com.trendmicro.deepsecurity.auth.ApiKeyAuth;
import com.trendmicro.deepsecurity.ApiException;
import com.trendmicro.deepsecurity.api.SoftwareInventoriesApi;
import com.trendmicro.deepsecurity.model.SoftwareInventory;


public class DescribeSoftwareInventoryExample {
	
	public static void main(String[] args) {
		// Setup
		ApiClient defaultClient = Configuration.getDefaultApiClient();
		defaultClient.setBasePath("YOUR HOST");

		// Authentication
		ApiKeyAuth DefaultAuthentication = (ApiKeyAuth) defaultClient.getAuthentication("DefaultAuthentication");
		DefaultAuthentication.setApiKey("YOUR API KEY");
		try {
			defaultClient.trustAllCertificates(false);
		} catch (Exception e) {
			System.err.println("An exception occurred when calling ApiClient.trustAllCertificates");
			e.printStackTrace();
		}
		
		// Initialization
		// Set Any Required Values
		SoftwareInventoriesApi instance = new SoftwareInventoriesApi();
		Long softwareInventoryID = 1L;
		String apiVersion = "YOUR VERSION";
		try {
			// Please replace the parameter values with yours
			SoftwareInventory result = instance.describeSoftwareInventory(softwareInventoryID, apiVersion);
			System.out.println(result);
		} catch (ApiException e) {
			System.err.println("An exception occurred when calling SoftwareInventoriesApi.describeSoftwareInventory");
			e.printStackTrace();
		}
	}
}
Response samples
application/json
{
  • "computerID": 0,
  • "name": "string",
  • "description": "string",
  • "state": "unknown",
  • "startDate": 0,
  • "completedDate": 0,
  • "initiatorID": 0,
  • "ID": 0
}

Delete a Software Inventory

delete/softwareinventories/{softwareInventoryID}

Delete a software inventory by ID.

Related SDK Methods:
Java

SoftwareInventoriesApi.deleteSoftwareInventory([param1, param2, ...])
Python

SoftwareInventoriesApi.delete_software_inventory([param1, param2, ...])
JavaScript

SoftwareInventoriesApi.deleteSoftwareInventory([param1, param2, ...])

Request
Security:
DefaultAuthentication
path Parameters
softwareInventoryID
required
integer <int64> \d+

The ID number of the software inventory to delete.

Example: 1
header Parameters
api-version
required
string

The version of the api being called.

Example: YOUR VERSION
Responses
200

Request is successful.

204

Request is successful.

403

Not authorized to delete software inventories.

Request samples
import com.trendmicro.deepsecurity.ApiClient;
import com.trendmicro.deepsecurity.Configuration;
import com.trendmicro.deepsecurity.auth.ApiKeyAuth;
import com.trendmicro.deepsecurity.ApiException;
import com.trendmicro.deepsecurity.api.SoftwareInventoriesApi;


public class DeleteSoftwareInventoryExample {
	
	public static void main(String[] args) {
		// Setup
		ApiClient defaultClient = Configuration.getDefaultApiClient();
		defaultClient.setBasePath("YOUR HOST");

		// Authentication
		ApiKeyAuth DefaultAuthentication = (ApiKeyAuth) defaultClient.getAuthentication("DefaultAuthentication");
		DefaultAuthentication.setApiKey("YOUR API KEY");
		try {
			defaultClient.trustAllCertificates(false);
		} catch (Exception e) {
			System.err.println("An exception occurred when calling ApiClient.trustAllCertificates");
			e.printStackTrace();
		}
		
		// Initialization
		// Set Any Required Values
		SoftwareInventoriesApi instance = new SoftwareInventoriesApi();
		Long softwareInventoryID = 1L;
		String apiVersion = "YOUR VERSION";
		try {
			// Please replace the parameter values with yours
			instance.deleteSoftwareInventory(softwareInventoryID, apiVersion);
		} catch (ApiException e) {
			System.err.println("An exception occurred when calling SoftwareInventoriesApi.deleteSoftwareInventory");
			e.printStackTrace();
		}
	}
}

List Software Inventory Items

get/softwareinventories/{softwareInventoryID}/items

Lists all items of a software inventory.

Related SDK Methods:
Java

SoftwareInventoriesApi.listSoftwareInventoryItems([param1, param2, ...])
Python

SoftwareInventoriesApi.list_software_inventory_items([param1, param2, ...])
JavaScript

SoftwareInventoriesApi.listSoftwareInventoryItems([param1, param2, ...])

Request
Security:
DefaultAuthentication
path Parameters
softwareInventoryID
required
integer <int64> \d+

The ID number of the software inventory.

Example: 1
header Parameters
api-version
required
string

The version of the api being called.

Example: YOUR VERSION
Responses
200

successful operation

403

Not authorized to view the software inventory.

404

The software inventory does not exist.

Request samples
import com.trendmicro.deepsecurity.ApiClient;
import com.trendmicro.deepsecurity.Configuration;
import com.trendmicro.deepsecurity.auth.ApiKeyAuth;
import com.trendmicro.deepsecurity.ApiException;
import com.trendmicro.deepsecurity.api.SoftwareInventoriesApi;
import com.trendmicro.deepsecurity.model.InventoryItems;


public class ListSoftwareInventoryItemsExample {
	
	public static void main(String[] args) {
		// Setup
		ApiClient defaultClient = Configuration.getDefaultApiClient();
		defaultClient.setBasePath("YOUR HOST");

		// Authentication
		ApiKeyAuth DefaultAuthentication = (ApiKeyAuth) defaultClient.getAuthentication("DefaultAuthentication");
		DefaultAuthentication.setApiKey("YOUR API KEY");
		try {
			defaultClient.trustAllCertificates(false);
		} catch (Exception e) {
			System.err.println("An exception occurred when calling ApiClient.trustAllCertificates");
			e.printStackTrace();
		}
		
		// Initialization
		// Set Any Required Values
		SoftwareInventoriesApi instance = new SoftwareInventoriesApi();
		Long softwareInventoryID = 1L;
		String apiVersion = "YOUR VERSION";
		try {
			// Please replace the parameter values with yours
			InventoryItems result = instance.listSoftwareInventoryItems(softwareInventoryID, apiVersion);
			System.out.println(result);
		} catch (ApiException e) {
			System.err.println("An exception occurred when calling SoftwareInventoriesApi.listSoftwareInventoryItems");
			e.printStackTrace();
		}
	}
}
Response samples
application/json
{
  • "inventoryItems": [
    ]
}

Search Software Inventory Items

post/softwareinventories/{softwareInventoryID}/items/search

Search for items of a software inventory using optional filters.

Related SDK Methods:
Java

SoftwareInventoriesApi.searchSoftwareInventoryItems([param1, param2, ...])
Python

SoftwareInventoriesApi.search_software_inventory_items([param1, param2, ...])
JavaScript

SoftwareInventoriesApi.searchSoftwareInventoryItems([param1, param2, ...])

Request
Security:
DefaultAuthentication
path Parameters
softwareInventoryID
required
integer <int64> \d+

The ID number of the software inventory.

Example: 1
header Parameters
api-version
required
string

The version of the api being called.

Example: YOUR VERSION
Request Body schema: application/json

A collection of options used to filter the search results.

maxItems
integer <int32>

Limits the number of objects returned. Default 5000.

Array of objects (searchCriteria)

Array of search critiera used to filter objects. Searching with multiple criteria returns results that satisfy all of the criteria. Searching with no criteria returns all objects.

sortByObjectID
boolean

If true, forces the response objects to be sorted by ID, overriding the default sort order. Default "false".

Responses
200

successful operation

403

Not authorized to view the software inventory.

404

The software inventory does not exist.

Request samples
application/json
{
  • "maxItems": 0,
  • "searchCriteria": [
    ],
  • "sortByObjectID": true
}
Response samples
application/json
{
  • "inventoryItems": [
    ]
}

Describe a Software Inventory Item

get/softwareinventories/{softwareInventoryID}/items/{inventoryItemID}

Describe a software inventory item by ID.

Related SDK Methods:
Java

SoftwareInventoriesApi.describeSoftwareInventoryItem([param1, param2, ...])
Python

SoftwareInventoriesApi.describe_software_inventory_item([param1, param2, ...])
JavaScript

SoftwareInventoriesApi.describeSoftwareInventoryItem([param1, param2, ...])

Request
Security:
DefaultAuthentication
path Parameters
inventoryItemID
required
integer <int64> \d+

The ID number of the inventory item to describe.

Example: 1
softwareInventoryID
required
integer <int64> \d+

The ID number of the software inventory.

Example: 1
header Parameters
api-version
required
string

The version of the api being called.

Example: YOUR VERSION
Responses
200

successful operation

403

Not authorized to view the software inventory.

404

The inventory item does not exist or the software inventory does not exist.

Request samples
import com.trendmicro.deepsecurity.ApiClient;
import com.trendmicro.deepsecurity.Configuration;
import com.trendmicro.deepsecurity.auth.ApiKeyAuth;
import com.trendmicro.deepsecurity.ApiException;
import com.trendmicro.deepsecurity.api.SoftwareInventoriesApi;
import com.trendmicro.deepsecurity.model.InventoryItem;


public class DescribeSoftwareInventoryItemExample {
	
	public static void main(String[] args) {
		// Setup
		ApiClient defaultClient = Configuration.getDefaultApiClient();
		defaultClient.setBasePath("YOUR HOST");

		// Authentication
		ApiKeyAuth DefaultAuthentication = (ApiKeyAuth) defaultClient.getAuthentication("DefaultAuthentication");
		DefaultAuthentication.setApiKey("YOUR API KEY");
		try {
			defaultClient.trustAllCertificates(false);
		} catch (Exception e) {
			System.err.println("An exception occurred when calling ApiClient.trustAllCertificates");
			e.printStackTrace();
		}
		
		// Initialization
		// Set Any Required Values
		SoftwareInventoriesApi instance = new SoftwareInventoriesApi();
		Long softwareInventoryID = 1L;
		Long inventoryItemID = 1L;
		String apiVersion = "YOUR VERSION";
		try {
			// Please replace the parameter values with yours
			InventoryItem result = instance.describeSoftwareInventoryItem(softwareInventoryID, inventoryItemID, apiVersion);
			System.out.println(result);
		} catch (ApiException e) {
			System.err.println("An exception occurred when calling SoftwareInventoriesApi.describeSoftwareInventoryItem");
			e.printStackTrace();
		}
	}
}
Response samples
application/json
{
  • "vendorName": "string",
  • "productName": "string",
  • "productVersion": "string",
  • "fileVersion": "string",
  • "fileDescription": "string",
  • "category": "string",
  • "sha256": "string",
  • "sha1": "string",
  • "md5": "string",
  • "fileName": "string",
  • "path": "string",
  • "size": 0,
  • "ID": 0
}