Asset Scan Templates

An asset scan template defines what will be performed during an asset scan. It is used to scan for the software and/or the hardware components that are contained on the target machine.

Base URL

        https://<consoleFQDN:port>/st/console/api/v1.0/asset/scantemplates

Supported Requests

Method	URL	Input	Return
GET	https://<consoleFQDN:port>/st/console/api/v1.0/asset/scantemplates	URL Parameters	AssetScanTemplates[]
	https://<consoleFQDN:port>/st/console/api/v1.0/asset/scantemplates/{id}		Configuration information for the specified asset scan template.
	https://<consoleFQDN:port>/st/console/api/v1.0/asset/scantemplates/{id}/usedby		List of entities using the specified asset scan template.

Input Model

URL Parameters

Name	Type	Description
count	Integer	Provide the count of items to return. The default is 10 and the maximum value is 1000.
createdByMe	Boolean	Returns only those items created by the user. This parameter will be removed in a future release and should only be used in legacy requests.
name	String	Returns the items whose name matches the specified name.
start	Integer	Sets the starting point. The items are sorted by their unique identifier and the starting point is the index into that sorted list.

Example with Sample Response

Find all entities using an asset scan template with ID 01234567-89AB-CDEF-0123-456789ABCDEF

GET Request

https://<consoleFQDN:port>/st/console/api/v1.0/asset/scantemplates/01234567-89AB-CDEF-0123-456789ABCDEF/usedby

Sample Response

Copy

{
    "count": 1,
    "value": [
        {
            "name": "Sample Agent Policy",
            "usageType": "AgentPolicy"
        }
    ]
}

Other Request Examples

Output Models

AssetScanTemplate

Name	Type	Description
configurations	AssetScanWmiOption[]	Specifies the list of hardware categories and if this template will scan for it.
creator	String	The name of the person who created the template.
description	String	Provides a description that explains the purpose of the template.
id	Guid	Provides an ID for the template.
includeHardwareAnd WmiConfigurations	Boolean	Denotes if this template will scan for installed hardware and configuration.
includeSoftware	Boolean	Denotes if this template will scan for installed software.
isSystem	Boolean	Indicates if this is a system template.
links	Links	Shows the related URLs for self, machines and template.
name	String	Provides a name for the template that describes exactly where it should be used.

AssetScanWmiOption

Name	Type	Description
category	String	The name of the category (Motherboard, BIOS, Processor, etc).
enabled	Boolean	Indicates if the template will scan for the associated hardware category.

UsedBy

Name	Type	Description
name	String	The name of the item using the scan template.
usageType	Enum	The type of component using the scan template.