Skip to content

Commit 644a888

Browse files
committed
Update device-health-api-methods-properties.md
1 parent 13905e2 commit 644a888

File tree

1 file changed

+22
-22
lines changed

1 file changed

+22
-22
lines changed

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

Lines changed: 22 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -67,39 +67,39 @@ Data that is collected using either `JSON response` or by using files is a snaps
6767

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

70-
- 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+
- The properties defined in the following table are listed alphabetically, by property ID. When you use this API, the resulting output won't necessarily be returned in the same order listed in this table.
7171
- Note that **rbacgroupname** and **Id** aren't supported filter operators.
7272
- Some more columns might be returned in the response. These columns can be temporary and might be removed; use only the documented columns.
7373

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

104104
### 1.4 Export device antivirus health details API properties (via files)
105105

0 commit comments

Comments
 (0)