Skip to content

Commit ce6376f

Browse files
denisebmsftdenisebmsft
committed
Update device-health-api-methods-properties.md
1 parent 30d7f35 commit ce6376f

File tree

1 file changed

+30
-32
lines changed

1 file changed

+30
-32
lines changed

‎defender-endpoint/api/device-health-api-methods-properties.md‎

Lines changed: 30 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -66,41 +66,39 @@ Data that is collected using either '_JSON response_ or _via files_' is the curr
6666

6767
### 1.3 Export device antivirus health details API properties (JSON response)
6868

69-
> [!NOTE]
70-
>
71-
> - The properties defined in the following table are listed alphabetically, by property ID. When running this API, the resulting output will not necessarily be returned in the same order listed in this table.
72-
> - Note that **rbacgroupname** and **Id** are not supported filter operators.
73-
> - Some additional columns might be returned in the response. These columns can be temporary and might be removed; use only the documented columns.
69+
- The properties defined in the following table are listed alphabetically, by property ID. When running this API, the resulting output won't necessarily be returned in the same order listed in this table.
70+
- Note that **rbacgroupname** and **Id** are not supported filter operators.
71+
- Some additional columns might be returned in the response. These columns can be temporary and might be removed; use only the documented columns.
7472

7573
| Property (ID) | Data type | Description | Example of a returned value |
7674
|---|---|---|---|
77-
| avEngineUpdateTime | DateTimeOffset | Datetime when AV engine was last updated on device | "2022-08-04T12:44:02Z" |
78-
| avEngineVersion | String | Antivirus engine version | "1.1.19400.3" |
79-
| avIsEngineUpToDate | String | Up-to-date status of AV engine | "True", "False", "Unknown" |
80-
| avIsPlatformUpToDate | String | Up-to-date status of AV platform | "True", "False", "Unknown" |
81-
| avIsSignatureUpToDate | String | Up-to-date status of AV signature | "True", "False", "Unknown" |
82-
| avMode | String | Antivirus mode. | Each mode will be a string typed integer value ranging from 0 to 5. Refer to the mapping below to see its value's meaning: <ul><li>'' = Other</li><li> '0' = Active</li><li> '1' = Passive</li><li> '2' = Disabled</li><li> '3' = Other</li><li> '4' = EDRBlocked</li><li>'5' = PassiveAudit</li></ul> |
83-
| avPlatformUpdateTime | DateTimeOffset | Datetime when AV platform was last updated on device | "2022-08-04T12:44:02Z" |
84-
| avPlatformVersion | String | Antivirus platform version | "4.18.2203.5" |
85-
| avSignaturePublishTime | DateTimeOffset | Datetime when AV security intelligence build was released | "2022-08-04T12:44:02Z" |
86-
| avSignatureUpdateTime | DateTimeOffset | Datetime when AV security intelligence was last updated on device | "2022-08-04T12:44:02Z" |
87-
| avSignatureVersion | String | Antivirus security intelligence version | "1.371.1323.0" |
88-
| computerDnsName | String | DNS name | "SampleDns" |
89-
| dataRefreshTimestamp | DateTimeOffset | Datetime when data is refreshed for this report | "2022-08-04T12:44:02Z" |
90-
| fullScanError | String | Error codes from full scan | "0x80508023" |
91-
| fullScanResult | String | Full scan result of this device | "Completed" <br> "Canceled" <br>"Failed" |
92-
| fullScanTime | DateTimeOffset | Datetime when full scan has completed | "2022-08-04T12:44:02Z" |
93-
| id | String | Machine GUID | "30a8fa2826abf24d24379b23f8a44d471f00feab" |
94-
| lastSeenTime | DateTimeOffset | Last seen datetime of this machine | "2022-08-04T12:44:02Z" |
95-
| machineId | String | Machine GUID | "30a8fa2826abf24d24379b23f8a44d471f00feab" |
96-
| osKind | String | Operating system kind | "windows", "mac", "linux" |
97-
| osPlatform | String | Operating system major version name | Windows 10, macOs |
98-
| osVersion | String | Operating system version | 10.0.18363.1440, 12.4.0.0 |
99-
| quickScanError | String | Error codes from quick scan | "0x80508023" |
100-
| quickScanResult | String | Quick scan result of this device | "Completed" <br>"Canceled" <br>"Failed" |
101-
| quickScanTime | DateTimeOffset | Datetime when quick scan has completed | "2022-08-04T12:44:02Z" |
102-
| rbacGroupId | Long | Device group ID that this machine belongs to | 712 |
103-
| rbacGroupName | String | Name of device group that this machine belongs to | "SampleGroup" |
75+
| `avEngineUpdateTime` | DateTimeOffset | Datetime when AV engine was last updated on device | "2022-08-04T12:44:02Z" |
76+
| `avEngineVersion` | String | Antivirus engine version | "1.1.19400.3" |
77+
| `avIsEngineUpToDate` | String | Up-to-date status of AV engine | "True", "False", "Unknown" |
78+
| `avIsPlatformUpToDate` | String | Up-to-date status of AV platform | "True", "False", "Unknown" |
79+
| `avIsSignatureUpToDate` | String | Up-to-date status of AV signature | "True", "False", "Unknown" |
80+
| `avMode` | String | Antivirus mode. | Each mode will be a string typed integer value ranging from 0 to 5. Refer to the mapping below to see its value's meaning: <ul><li>'' = Other</li><li> '0' = Active</li><li> '1' = Passive</li><li> '2' = Disabled</li><li> '3' = Other</li><li> '4' = EDRBlocked</li><li>'5' = PassiveAudit</li></ul> |
81+
| `avPlatformUpdateTime` | DateTimeOffset | Datetime when AV platform was last updated on device | "2022-08-04T12:44:02Z" |
82+
| `avPlatformVersion` | String | Antivirus platform version | "4.18.2203.5" |
83+
| `avSignaturePublishTime` | DateTimeOffset | Datetime when AV security intelligence build was released | "2022-08-04T12:44:02Z" |
84+
| `avSignatureUpdateTime` | DateTimeOffset | Datetime when AV security intelligence was last updated on device | "2022-08-04T12:44:02Z" |
85+
| `avSignatureVersion` | String | Antivirus security intelligence version | "1.371.1323.0" |
86+
| `computerDnsName` | String | DNS name | "SampleDns" |
87+
| `dataRefreshTimestamp` | DateTimeOffset | Datetime when data is refreshed for this report | "2022-08-04T12:44:02Z" |
88+
| `fullScanError` | String | Error codes from full scan | "0x80508023" |
89+
| `fullScanResult` | String | Full scan result of this device | "Completed" <br> "Canceled" <br>"Failed" |
90+
| `fullScanTime` | DateTimeOffset | Datetime when full scan has completed | "2022-08-04T12:44:02Z" |
91+
| `id` | String | Machine GUID | "30a8fa2826abf24d24379b23f8a44d471f00feab" |
92+
| `lastSeenTime` | DateTimeOffset | Last seen datetime of this machine | "2022-08-04T12:44:02Z" |
93+
| `machineId` | String | Machine GUID | "30a8fa2826abf24d24379b23f8a44d471f00feab" |
94+
| `osKind` | String | Operating system kind | "windows", "mac", "linux" |
95+
| `osPlatform` | String | Operating system major version name | Windows 10, macOs |
96+
| `osVersion` | String | Operating system version | 10.0.18363.1440, 12.4.0.0 |
97+
| `quickScanError` | String | Error codes from quick scan | "0x80508023" |
98+
| `quickScanResult` | String | Quick scan result of this device | "Completed" <br>"Canceled" <br>"Failed" |
99+
| `quickScanTime` | DateTimeOffset | Datetime when quick scan has completed | "2022-08-04T12:44:02Z" |
100+
| `rbacGroupId` | Long | Device group ID that this machine belongs to | 712 |
101+
| `rbacGroupName` | String | Name of device group that this machine belongs to | "SampleGroup" |
104102

105103
### 1.4 Export device antivirus health details API properties (via files)
106104

0 commit comments

Comments
 (0)