Skip to content

Commit 2d73a2c

Browse files
committed
Learn Editor: Update get-assessment-software-vulnerabilities.md
1 parent 71a8135 commit 2d73a2c

File tree

1 file changed

+17
-3
lines changed

1 file changed

+17
-3
lines changed

defender-endpoint/api/get-assessment-software-vulnerabilities.md

Lines changed: 17 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -342,7 +342,19 @@ GET https://api-us.securitycenter.contoso.com/api/machines/SoftwareVulnerabiliti
342342
Returns a table with an entry for every unique combination of DeviceId, SoftwareVendor, SoftwareName, SoftwareVersion, CveId. The API pulls data in your organization as Json responses. The response is paginated, so you can use the @odata.nextLink field from the response to fetch the next results. Unlike the full software vulnerabilities assessment (JSON response), which is used to obtain an entire snapshot of the software vulnerabilities assessment of your organization by device, the delta export JSON response API call is used to fetch only the changes that happened between a selected date and the current date (the "delta" API call). Instead of getting a full export with a large amount of data every time, you only get specific information on new, fixed, and updated vulnerabilities. Delta export JSON response API call can also be used to calculate different KPIs such as "how many vulnerabilities were fixed?" or "how many new vulnerabilities were added to my organization?"
343343

344344
> [!NOTE]
345-
> It's highly recommended you use the full export software vulnerabilities assessment by device API call at least once a week and this extra export software vulnerabilities changes by device (delta) API call all the other days of the week. Unlike the other Assessments JSON response APIs, the "delta export" isn't a full export. The delta export includes only the changes that happened between a selected date and the current date (the "delta" API call).
345+
> We refresh the __Full _Software Vulnerabilities Assessment(Flat/Full VA) by Device___ export every __six hours__ and store each snapshot in blob storage; the API always serves the latest snapshot, to emphasize  calling the Get Endpoint won't to trigger a generation, call get endpoint  will just read latest Flat from blob.
346+
> A successful completion of Full VA export will trigger __delta export__ that captures the changes from latest Flat VA processed by Delta to new Flat VA.
347+
> > __RBAC-scoped duplicates__
348+
> > Because exports are scoped by __RBACGroup__, a device that moves from one RBAC group to another will appear __twice__ in a Delta export when you query with the global view (`RBACGroup=*`): once under its previous group with status "Fixed" and once under its current group with status "New". Use the `rbacGroupId` and device identifiers together (or de-duplicate on your side) if you need a single authoritative record per device.
349+
>
350+
> Recommended pull pattern
351+
>
352+
1. __Baseline__ – Download the full VA(Flat VA) export on your preferred cadence (weekly is often sufficient).
353+
354+
1. __Stay current__ – delta export between full snapshots(Delta can be queried up to 14 days into the past).
355+
356+
1. __Handle RBAC moves__ – When processing a Delta, de-duplicate entries where the same `Id(deviceId_software_` version _ cve`)`appears under multiple `rbacGroupId` values.
357+
346358

347359
#### 3.1.1 Limitations
348360

@@ -391,13 +403,14 @@ Each returned record contains all the data from the full export software vulnera
391403
|DeviceId|String|Unique identifier for the device in the service.|9eaf3a8b5962e0e6b1af9ec756664a9b823df2d1|
392404
|DeviceName|String|Fully qualified domain name (FQDN) of the device.|johnlaptop.europe.contoso.com|
393405
|DiskPaths|Array[string]|Disk evidence that the product is installed on the device.|["C:\Program Files (x86)\Microsoft\Silverlight\Application\silverlight.exe"]|
394-
|EventTimestamp|String|The time this delta event was found.|2021-01-11T11:06:08.291Z|
406+
|EventTimestamp|String|The time this delta event was found.|2020-11-03 10:13:34.8476880|
395407
|ExploitabilityLevel|String|The exploitability level of this vulnerability (NoExploit, ExploitIsPublic, ExploitIsVerified, ExploitIsInKit)|ExploitIsInKit|
408+
|IsOnboarded |Boolean|Indicates whether a device is onboarded or not.| Possible values are true or false.|
396409
|FirstSeenTimestamp|String|First time the CVE of this product was seen on the device.|2020-11-03 10:13:34.8476880|
397410
|ID|String|Unique identifier for the record.|123ABG55_573AG&mnp!|
398411
|LastSeenTimestamp|String|Last time the software was reported on the device.|2020-11-03 10:13:34.8476880|
399412
|OSPlatform|String|Platform of the operating system running on the device; specific operating systems with variations within the same family, such as Windows 10 and Windows 11. See Microsoft Defender Vulnerability Management supported operating systems and platforms for details.|Windows10 and Windows 11|
400-
|RbacGroupName|String|The role-based access control (RBAC) group. If this device isn't assigned to any RBAC group, the value is "Unassigned." If the organization doesn't contain any RBAC groups, the value is "None."|Servers|
413+
|RbacGroupName|String|The role-based access control (RBAC) group. If this device isn't assigned to any RBAC group, the value is "Unassigned." |Servers|
401414
|RecommendationReference|string|A reference to the recommendation ID related to this software.|va--microsoft--silverlight|
402415
|RecommendedSecurityUpdate |String|Name or description of the security update provided by the software vendor to address the vulnerability.|April 2020 Security Updates|
403416
|RecommendedSecurityUpdateId |String|Identifier of the applicable security updates or identifier for the corresponding guidance or knowledge base (KB) articles|4550961|
@@ -588,5 +601,6 @@ GET https://api.securitycenter.microsoft.com/api/machines/SoftwareVulnerabilityC
588601
Other related
589602

590603
- [Microsoft Defender Vulnerability Management](/defender-vulnerability-management/defender-vulnerability-management)
604+
591605
- [Vulnerabilities in your organization](/defender-vulnerability-management/tvm-weaknesses)
592606
[!INCLUDE [Microsoft Defender for Endpoint Tech Community](../../includes/defender-mde-techcommunity.md)]

0 commit comments

Comments
 (0)