Fetch Asset Data using Asset

For API version information, refer to the API Version History section.

Non-Versioned

This API retrieves a large number of search results in smaller sections or batches.

GET/ioc/assets/{assetId}

Input Parameters for Fetch Asset DataInput Parameters for Fetch Asset Data

Input Parameters	Mandatory/Optional	Format	Description
Authorization	Mandatory	String	Authorization parameter authenticates the Qualys Enterprise TruRisk™ Platform. Prepend token with "Bearer" and a space. For example: Bearer authToken.
assetId	Mandatory	String	Use the assetId paramter to retrieve the asset details.

Sample - Fetch Asset DataSample - Fetch Asset Data

API request

curl -X GET "<qualys_base_url>/ioc/asset/XXX44XX6-XXf8-4XX2-bfXXXX8ba6XX2ebX" --header "accept: */*" --header "Authorization: Bearer <token>"

Response

 {
  "criticalityScore": 2,
  "avWorkflow": "UPDATE",
  "avStatus": true,
  "isAVUpToDate": false,
  "downloadPercent": 100,
  "isEPPEnabled": true,
  "isEDREnabled": true,
  "avErrorCode": "ERROR_SUCCESS",
  "avProfile": {
    "id": "XXX8a87X-XXbb-4XX9-XX74-XXX08f6XX54X",
    "name": "NewAVProfile",
    "status": "ASSIGNED"
  },
  "lastUpdatedTime": 1729502952,
  "licenseStatus": "registered",
  "agentVersion": "6.0.0.13",
  "avProductVersion": "7.9.14.430",
  "id": "XXX8a87X-XXbb-4XX9-XX74-XXX08f6XX54X",
  "assetId": 50299224,
  "timeStamp": "2025-02-25T06:21:50.873+0000",
  "state": "ACTIVE",
  "name": "Win11-x64-ATN02",
  "platform": "Windows",
  "hostName": "Win11-x64-ATN02",
  "operatingSystem": "Microsoft Windows 11 Pro 10.0.22631 64-bit N/A Build 22631",
  "tags": [
    {
      "uuid": "XXX676fX-cXX8-XX32-bfXX-XXX8XbcXXX1b",
      "name": "Dynamic-test-EDR"
    },
    {
      "uuid": "XXX676fX-cXX8-XX32-bfXX-XXX8XbcXXX1b",
      "name": "test45"
    },
    {
      "uuid": "XXX676fX-cXX8-XX32-bfXX-XXX8XbcXXX1b",
      "name": "epp_dm"
    },
    {
      "uuid": "XXX676fX-cXX8-XX32-bfXX-XXX8XbcXXX1b",
      "name": "Cloud Agent"
    },
    {
      "uuid": "XXX676fX-cXX8-XX32-bfXX-XXX8XbcXXX1b",
      "name": "TestMadhuri"
    }
  ],
  "lastLoggedOnUser": "admin",
  "interfaces": [
    {
      "interfaceName": "Intel(R) 82574L Gigabit Network Connection",
      "macAddress": "00:X0:XX:0X:00:00",
      "gatewayAddress": "XX.XX.X0X.X",
      "ipAddress": "X0.1X.XX1.00"
    },
    {
      "interfaceName": "Intel(R) 82574L Gigabit Network Connection",
      "macAddress": "00:X0:XX:0X:00:00",
      "gatewayAddress": "XX.XX.X0X.X",
      "ipAddress": "fXX0:0:0:0:XXX9:1XX9:2XXb:XXed"
    }
  ],
  "indicator2": [],
  "createdOnDate": "2024-10-21T05:45:40.000+0000",
  "edrActivatedOnDate": "2024-10-21T05:46:09.000+0000",
  "lastCheckedIn": "2025-02-11T11:10:27.000+0000",
  "lastReportedTime": "2025-02-11T11:09:59.174+0000",
  "avEngines": {
    "version": "7.97704",
    "errorCode": 0,
    "lastUpdatedTime": 1729502904
  },
  "antimalwareStatus": "Anti-malware Not Updated",
  "avStatusCategory": "Update Failed",
  "productUpdateErrorCode": "0",
  "restartReason": [],
  "edrFunctionalStatus": "Inactive"
}

Response Field DescriptionsResponse Field Descriptions

Dataset Name	Field Name	Data Type	Description
Asset	criticalityScore	Integer	Indicates the asset's criticality score to your business infrastructure.
	avStatus	Boolean	Indicates whether the AV installation was successful (true or false).
	isAVUpToDate	Boolean	Indicates whether the anti-malware is up to date (true or false).
	downloadPercent	Integer	The download status of AV updates or installation, expressed as a percentage.
	isEPPEnabled	Boolean	Indicates whether EPP is enabled on the endpoint (true or false).
	isEDREnabled	Boolean	Indicates whether EDR is enabled on the endpoint (true or false)
	avErrorCode	String	Indicates the error codes associated with AV installation or updates.
	lastUpdatedTime	Timestamp	The time when the asset was last updated.
	agentVersion	String	The version of the Qualys Cloud Agent.
	avProductVersion	String	The product version of AV.
	id	String	The unique identifier of the asset.
	state	String	Indicates the state of the asset (e.g. "ACTIVE").
	name	String	The hostname of the asset.
	platform	String	The platform of the asset (Windows or Linux or Mac).
	hostName	String	The hostname of the asset.
	operatingSystem	String	The operating system and version of the asset.
	lastLoggedOnUser	String	Indicates the most recent user who logged in to the endpoint.
	createdOnDate	Timestamp	The date and time when the asset was created (as shown in Agent Activity within the Asset Summary).
	edrActivatedOnDate	Timestamp	The date and time when EDR was activated on the asset.
	lastCheckedIn	Timestamp	The date and time when the endpoint last checked in with the platform (as shown in Agent Activity within the Asset Summary).
	lastReportedTime	Timestamp	The date and time when the agent last reported events.
	antimalwareStatus	String	Indicates the current AV status for each asset or endpoint (e.g., Anti-malware Updated, Not Updated, Update Error, Failed to Install, etc.).
	avStatusCategory	String	Displays the category or reason for the above-specified AV status.
	productUpdateErrorCode	Integer	AV update/installation error codes.
	edrFunctionalStatus	String	EDR status of the asset. Active: EDR is enabled , and the Last Reported Time is within 24 hours. Inactive: EDR is enabled, but the Last Reported Time exceeds 24 hours. Disabled: EDR is turned off. You can enable EDR from the Qualys Cloud Agent application.
	avProfile	Object	The anti-malware profile associated with the asset. Dataset: avProfile
	tags	Array of Object	List of tags associated with the asset. Dataset: tags
	avEngines	Object	Information about the AV engine. Dataset: avEngines
	interfaces	Array of Object	List of interfaces associated with the asset.
avEngines	version	String	Indicates the engine version of AV.
	errorCode	Integer	Indicates the error codes associated with anti-malware.
	lastUpdatedTime	Timestamp	The date and time when the AV engine was last updated.
AVProfile	name	String	The name of the AV profile.
	id	String	The unique identifier assigned to the AV profile.
	status	String	The assignment status of the AV profile (e.g . ASSIGNED.)
Interfaces	macAddress	String	The MAC address of the network interface.
	ipAddress	String	The IP address of the network interface.
	interfaceName	String	The name of the network interface.
	gatewayAddress	String	The gateway address of the network interface.
Tags	name	String	The name of the tag.
	uuid	String	The unique identifier for the tag.

V1.0

This API retrieves a large number of search results in smaller sections or batches.

GET/ioc/v1/assets/{assetId}

Input Parameters for Fetch Asset DataInput Parameters for Fetch Asset Data

Input Parameters	Mandatory/Optional	Format	Description
Authorization	Mandatory	String	Authorization parameter authenticates the Qualys Enterprise TruRisk™ Platform. Prepend token with "Bearer" and a space. For example: Bearer authToken.
assetId	Mandatory	String	Use the assetId paramter to retrieve the asset details.

Sample - Fetch Asset DataSample - Fetch Asset Data

API request

curl -X GET "<qualys_base_url>/ioc/v1/asset/XXX44XX6-XXf8-4XX2-bfXXXX8ba6XX2ebX" --header "accept: */*" --header "Authorization: Bearer <token>"

Response

 {
  "criticalityScore": 2,
  "avWorkflow": "UPDATE",
  "avStatus": true,
  "isAVUpToDate": false,
  "downloadPercent": 100,
  "isEPPEnabled": true,
  "isEDREnabled": true,
  "avErrorCode": "ERROR_SUCCESS",
  "avProfile": {
    "id": "XXX8a87X-XXbb-4XX9-XX74-XXX08f6XX54X",
    "name": "NewAVProfile",
    "status": "ASSIGNED"
  },
  "lastUpdatedTime": 1729502952,
  "licenseStatus": "registered",
  "agentVersion": "6.0.0.13",
  "avProductVersion": "7.9.14.430",
  "id": "XXX8a87X-XXbb-4XX9-XX74-XXX08f6XX54X",
  "assetId": 50299224,
  "timeStamp": "2025-02-25T06:21:50.873+0000",
  "state": "ACTIVE",
  "name": "Win11-x64-ATN02",
  "platform": "Windows",
  "hostName": "Win11-x64-ATN02",
  "operatingSystem": "Microsoft Windows 11 Pro 10.0.22631 64-bit N/A Build 22631",
  "tags": [
    {
      "uuid": "XXX676fX-cXX8-XX32-bfXX-XXX8XbcXXX1b",
      "name": "Dynamic-test-EDR"
    },
    {
      "uuid": "XXX676fX-cXX8-XX32-bfXX-XXX8XbcXXX1b",
      "name": "test45"
    },
    {
      "uuid": "XXX676fX-cXX8-XX32-bfXX-XXX8XbcXXX1b",
      "name": "epp_dm"
    },
    {
      "uuid": "XXX676fX-cXX8-XX32-bfXX-XXX8XbcXXX1b",
      "name": "Cloud Agent"
    },
    {
      "uuid": "XXX676fX-cXX8-XX32-bfXX-XXX8XbcXXX1b",
      "name": "TestMadhuri"
    }
  ],
  "lastLoggedOnUser": "admin",
  "interfaces": [
    {
      "interfaceName": "Intel(R) 82574L Gigabit Network Connection",
      "macAddress": "00:X0:XX:0X:00:00",
      "gatewayAddress": "XX.XX.X0X.X",
      "ipAddress": "X0.1X.XX1.00"
    },
    {
      "interfaceName": "Intel(R) 82574L Gigabit Network Connection",
      "macAddress": "00:X0:XX:0X:00:00",
      "gatewayAddress": "XX.XX.X0X.X",
      "ipAddress": "fXX0:0:0:0:XXX9:1XX9:2XXb:XXed"
    }
  ],
  "indicator2": [],
  "createdOnDate": "2024-10-21T05:45:40.000+0000",
  "edrActivatedOnDate": "2024-10-21T05:46:09.000+0000",
  "lastCheckedIn": "2025-02-11T11:10:27.000+0000",
  "lastReportedTime": "2025-02-11T11:09:59.174+0000",
  "avEngines": {
    "version": "7.97704",
    "errorCode": 0,
    "lastUpdatedTime": 1729502904
  },
  "antimalwareStatus": "Anti-malware Not Updated",
  "avStatusCategory": "Update Failed",
  "productUpdateErrorCode": "0",
  "restartReason": [],
  "edrFunctionalStatus": "Inactive"
}

Response Field DescriptionsResponse Field Descriptions

Dataset Name	Field Name	Data Type	Description
Asset	criticalityScore	Integer	Indicates the asset's criticality score to your business infrastructure.
	avStatus	Boolean	Indicates whether the AV installation was successful (true or false).
	isAVUpToDate	Boolean	Indicates whether the anti-malware is up to date (true or false).
	downloadPercent	Integer	The download status of AV updates or installation, expressed as a percentage.
	isEPPEnabled	Boolean	Indicates whether EPP is enabled on the endpoint (true or false).
	isEDREnabled	Boolean	Indicates whether EDR is enabled on the endpoint (true or false)
	avErrorCode	String	Indicates the error codes associated with AV installation or updates.
	lastUpdatedTime	Timestamp	The time when the asset was last updated.
	agentVersion	String	The version of the Qualys Cloud Agent.
	avProductVersion	String	The product version of AV.
	id	String	The unique identifier of the asset.
	state	String	Indicates the state of the asset (e.g. "ACTIVE").
	name	String	The hostname of the asset.
	platform	String	The platform of the asset (Windows or Linux or Mac).
	hostName	String	The hostname of the asset.
	operatingSystem	String	The operating system and version of the asset.
	lastLoggedOnUser	String	Indicates the most recent user who logged in to the endpoint.
	createdOnDate	Timestamp	The date and time when the asset was created (as shown in Agent Activity within the Asset Summary).
	edrActivatedOnDate	Timestamp	The date and time when EDR was activated on the asset.
	lastCheckedIn	Timestamp	The date and time when the endpoint last checked in with the platform (as shown in Agent Activity within the Asset Summary).
	lastReportedTime	Timestamp	The date and time when the agent last reported events.
	antimalwareStatus	String	Indicates the current AV status for each asset or endpoint (e.g., Anti-malware Updated, Not Updated, Update Error, Failed to Install, etc.).
	avStatusCategory	String	Displays the category or reason for the above-specified AV status.
	productUpdateErrorCode	Integer	AV update/installation error codes.
	edrFunctionalStatus	String	EDR status of the asset. Active: EDR is enabled , and the Last Reported Time is within 24 hours. Inactive: EDR is enabled, but the Last Reported Time exceeds 24 hours. Disabled: EDR is turned off. You can enable EDR from the Qualys Cloud Agent application.
	avProfile	Object	The anti-malware profile associated with the asset. Dataset: avProfile
	tags	Array of Object	List of tags associated with the asset. Dataset: tags
	avEngines	Object	Information about the AV engine. Dataset: avEngines
	interfaces	Array of Object	List of interfaces associated with the asset.
avEngines	version	String	Indicates the engine version of AV.
	errorCode	Integer	Indicates the error codes associated with anti-malware.
	lastUpdatedTime	Timestamp	The date and time when the AV engine was last updated.
AVProfile	name	String	The name of the AV profile.
	id	String	The unique identifier assigned to the AV profile.
	status	String	The assignment status of the AV profile (e.g . ASSIGNED.)
Interfaces	macAddress	String	The MAC address of the network interface.
	ipAddress	String	The IP address of the network interface.
	interfaceName	String	The name of the network interface.
	gatewayAddress	String	The gateway address of the network interface.
Tags	name	String	The name of the tag.
	uuid	String	The unique identifier for the tag.

API Version History

The following table depicts the information about the different versions of this API along with the status:

API Version	API Status	Release Date
/ioc/assets/{assetId}	Active
/ioc/v1/assets/{assetId}	Active	May 2025