Skip to content

Commit 724e837

Browse files
committed
updated parameters info
1 parent 69bc855 commit 724e837

9 files changed

+58
-98
lines changed

defender-endpoint/api/export-firmware-hardware-assessment.md

Lines changed: 10 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ ms.topic: reference
1515
ms.subservice: reference
1616
ms.custom: api
1717
search.appverid: met150
18-
ms.date: 11/24/2022
18+
ms.date: 01/08/2025
1919
---
2020

2121
# Export Hardware and firmware assessment inventory per device
@@ -153,39 +153,31 @@ Delegated (work or school account)|Software.Read|'Read Threat and Vulnerability
153153
GET /api/machines/HardwareFirmwareInventoryExport
154154
```
155155

156-
### 2.4 Parameters
157-
158-
- sasValidHours: The number of hours that the download URLs will be valid for (Maximum 24 hours).
159-
160-
### 2.5 Properties (JSON response)
156+
### 2.4 Properties (JSON response)
161157

162158
> [!NOTE]
163-
> The files are gzip compressed & in multiline Json format.
164-
>
165-
> The download URLs are only valid for 3 hours; otherwise, you can use the parameter.
166-
>
167-
> To maximize download speeds, make sure you are downloading the data from the same Azure region where your data resides.
168159
>
169-
> Each record is approximately 1KB of data. You should take this into account when choosing the pageSize parameter that works for you.
170-
>
171-
> Some additional columns might be returned in the response. These columns are temporary and might be removed. Only use the documented columns.
160+
> - The files are gzip compressed & in multiline Json format.
161+
> - The download URLs are only valid for 1 hour.
162+
> - To maximize download speeds, make sure you are downloading the data from the same Azure region where your data resides.
163+
> - Each record is approximately 1KB of data. You should take this into account when choosing the pageSize parameter that works for you.
164+
> - Some additional columns might be returned in the response. These columns are temporary and might be removed. Only use the documented columns.
172165
173166
Property (ID)|Data type|Description
174167
:---|:---|:---
175168
|Export files|String[array]|A list of download URLs for files holding the current snapshot of the organization.
176169
|GeneratedTime|DateTime|The time the export was generated.
177170

178171

172+
## 2.5 Examples
179173

180-
## 2.6 Example
181-
182-
### 2.6.1 Request example
174+
### 2.5.1 Request example
183175

184176
```http
185177
GET https://api.security.microsoft.com/api/machines/HardwareFirmwareInventoryExport
186178
```
187179

188-
### 2.6.2 Response example
180+
### 2.5.2 Response example
189181

190182
```json
191183
{

defender-endpoint/api/export-security-baseline-assessment.md

Lines changed: 10 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ ms.topic: reference
1515
ms.subservice: reference
1616
ms.custom: api
1717
search.appverid: met150
18-
ms.date: 05/02/2022
18+
ms.date: 01/08/2025
1919
---
2020

2121
# Export security baselines assessment per device
@@ -158,35 +158,29 @@ Returns all security baselines assessments for all devices, on a per-device basi
158158
GET /api/machines/BaselineComplianceAssessmentExport
159159
```
160160

161-
### 2.4 Parameters
162-
163-
- sasValidHours: The number of hours that the download URLs will be valid for (Maximum 24 hours).
164-
165-
### 2.5 Properties (via files)
161+
### 2.4 Properties (via files)
166162

167163
> [!NOTE]
168-
> The files are gzip compressed & in multiline Json format.
169-
>
170-
> The download URLs are only valid for 3 hours; otherwise you can use the parameter.
171-
>
172-
> To maximize download speeds, make sure you are downloading the data from the same Azure region where your data resides.
173-
>
174-
> Some additional columns might be returned in the response. These columns are temporary and might be removed. Only use the documented columns.
164+
>
165+
> - The files are gzip compressed & in multiline Json format.
166+
> - The download URLs are only valid for 1 hours.
167+
> - To maximize download speeds, make sure you are downloading the data from the same Azure region where your data resides.
168+
> - Some additional columns might be returned in the response. These columns are temporary and might be removed. Only use the documented columns.
175169

176170
Property (ID)|Data type|Description
177171
:---|:---|:---
178172
|Export files|array[string]|A list of download URLs for files holding the current snapshot of the organization.
179173
|GeneratedTime|String|The time that the export was generated.
180174

181-
## 2.6 Example
175+
## 2.5 Examples
182176

183-
### 2.6.1 Request example
177+
### 2.5.1 Request example
184178

185179
```http
186180
GET https://api.securitycenter.microsoft.com/api/machines/BaselineComplianceAssessmentExport
187181
```
188182

189-
### 2.6.2 Response example
183+
### 2.5.2 Response example
190184

191185
```json
192186
{

defender-endpoint/api/get-assessment-browser-extensions.md

Lines changed: 3 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ ms.topic: reference
1515
ms.subservice: reference
1616
ms.custom: api
1717
search.appverid: met150
18-
ms.date: 06/01/2022
18+
ms.date: 01/08/2025
1919
---
2020

2121
# Export browser extensions assessment per device
@@ -182,16 +182,12 @@ Delegated (work or school account)|Software.Read|'Read Threat and Vulnerability
182182
GET /api/machines/browserextensionsinventoryExport
183183
```
184184

185-
### 2.4 Parameters
186-
187-
- sasValidHours: The number of hours that the download URLs will be valid for (Maximum 24 hours)
188-
189-
### 2.5 Properties
185+
### 2.4 Properties
190186

191187
> [!NOTE]
192188
>
193189
> - The files are gzip compressed & in multiline JSON format.
194-
> - The download URLs are only valid for 3 hours. Otherwise you can use the parameter.
190+
> - The download URLs are only valid for 1 hour.
195191
> - For maximum download speed of your data, you can make sure you are downloading from the same Azure region that your data resides.
196192
197193
<br>

defender-endpoint/api/get-assessment-information-gathering.md

Lines changed: 10 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -15,8 +15,7 @@ ms.topic: reference
1515
ms.subservice: reference
1616
ms.custom: api
1717
search.appverid: met150
18-
19-
ms.date: 07/26/2022
18+
ms.date: 01/08/2025
2019
---
2120

2221
# Information gathering assessment per device
@@ -70,35 +69,29 @@ Delegated (work or school account)|Vulnerability.Read|\'Read Threat and Vulnerab
7069
GET /api/Machines/InfoGatheringExport
7170
```
7271

73-
### 1.4 Parameters
74-
75-
- sasValidHours: The number of hours that the download URLs will be valid for (Maximum 24 hours)
76-
77-
### 1.5 Properties
72+
### 1.4 Properties
7873

7974
> [!NOTE]
80-
> The files are gzip compressed & in multiline Json format.
81-
>
82-
> The download URLs are only valid for 3 hours; otherwise, you can use the parameter.
83-
>
84-
> To maximize download speeds, make sure you are downloading the data from the same Azure region where your data resides.
85-
>
86-
> Some additional columns might be returned in the response. These columns are temporary and might be removed. Only use the documented columns.
75+
>
76+
> - The files are gzip compressed & in multiline Json format.
77+
> - The download URLs are only valid for 1 hour.
78+
> - To maximize download speeds, make sure you are downloading the data from the same Azure region where your data resides.
79+
> - Some additional columns might be returned in the response. These columns are temporary and might be removed. Only use the documented columns.
8780
8881
Property (ID)|Data type|Description
8982
:---|:---|:---
9083
|Export files|String[array]|A list of download URLs for files holding the current snapshot of the organization.
9184
|GeneratedTime|DateTime|The time the export was generated.
9285

93-
### 1.6 Examples
86+
### 1.5 Examples
9487

95-
#### 1.6.1 Request example
88+
#### 1.5.1 Request example
9689

9790
```http
9891
GET https://api.securitycenter.microsoft.com/api/machines/InfoGatheringExport?$sasValidHours=1
9992
```
10093

101-
#### 1.6.2 Response example
94+
#### 1.5.2 Response example
10295

10396
```json
10497
{

defender-endpoint/api/get-assessment-methods-properties.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -105,7 +105,7 @@ Returns all of the installed software and their details on each device.
105105
|Method|Data type|Description|
106106
|:---|:---|:---|
107107
|Export software inventory assessment **(JSON response)**|Software inventory by device collection. See: [2.2 Properties (JSON response)](#22-properties-json-response)|Returns a table with an entry for every unique combination of DeviceId, SoftwareVendor, SoftwareName, SoftwareVersion. The API pulls all data in your organization as JSON responses. This method is best for small organizations with less than 100-K devices. The response is paginated, so you can use the @odata.nextLink field from the response to fetch the next results. |
108-
| Export software inventory assessment **(via files)**|Software inventory by device files. See: [2.3 Properties (via files)](#23-properties-via-files)|Returns a table with an entry for every unique combination of DeviceId, SoftwareVendor, SoftwareName, SoftwareVersion. This API solution enables pulling larger amounts of data faster and more reliably. So, it's recommended for large organizations, with more than 100-K devices. This API pulls all data in your organization as download files. The response contains URLs to download all the data from Azure Storage. This API enables you to download data from Azure Storage as follows: <ol><li>Call the API to get a list of download URLs with your organization data</li><li>Download the files using the download URLs and process the data as you like.</li></ol> |
108+
|Export software inventory assessment **(via files)**|Software inventory by device files. See: [2.3 Properties (via files)](#23-properties-via-files)|Returns a table with an entry for every unique combination of DeviceId, SoftwareVendor, SoftwareName, SoftwareVersion. This API solution enables pulling larger amounts of data faster and more reliably. So, it's recommended for large organizations, with more than 100-K devices. This API pulls all data in your organization as download files. The response contains URLs to download all the data from Azure Storage. This API enables you to download data from Azure Storage as follows: <ol><li>Call the API to get a list of download URLs with your organization data</li><li>Download the files using the download URLs and process the data as you like.</li></ol> |
109109

110110
### 2.2 Properties (JSON response)
111111

defender-endpoint/api/get-assessment-non-cpe-software-inventory.md

Lines changed: 6 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ ms.topic: reference
1515
ms.subservice: reference
1616
ms.custom: api
1717
search.appverid: met150
18-
ms.date: 05/27/2022
18+
ms.date: 01/08/2025
1919
---
2020

2121
# Export non product code software inventory assessment per device
@@ -180,16 +180,12 @@ Delegated (work or school account)|Software.Read|\'Read Threat and Vulnerability
180180
GET /api/machines/SoftwareInventoryNonCpeExport
181181
```
182182

183-
### Parameters
184-
185-
- sasValidHours: The number of hours that the download URLs will be valid for (Maximum 24 hours)
186-
187-
### 2.5 Properties
183+
### 2.4 Properties
188184

189185
> [!NOTE]
190186
>
191187
> - The files are gzip compressed & in multiline JSON format.
192-
> - The download URLs are only valid for 3 hours. Otherwise you can use the parameter.
188+
> - The download URLs are only valid for 1 hour.
193189
> - For maximum download speed of your data, you can make sure you are downloading from the same Azure region that your data resides.
194190
195191
<br>
@@ -202,15 +198,15 @@ Export files|array\[string\]|A list of download URLs for files holding the curre
202198
GeneratedTime|string|The time that the export was generated.|2021-05-20T08:00:00Z
203199
|
204200

205-
### 2.6 Examples
201+
### 2.5 Examples
206202

207-
#### 2.6.1 Request example
203+
#### 2.5.1 Request example
208204

209205
```http
210206
GET https://api.securitycenter.microsoft.com/api/machines/SoftwareInventoryNonCpeExport
211207
```
212208

213-
#### 2.6.2 Response example
209+
#### 2.5.2 Response example
214210

215211
```json
216212
{

defender-endpoint/api/get-assessment-secure-config.md

Lines changed: 6 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -238,15 +238,12 @@ Delegated (work or school account)|Vulnerability.Read|\'Read Threat and Vulnerab
238238
GET /api/machines/SecureConfigurationsAssessmentExport
239239
```
240240

241-
### Parameters
242-
243-
- sasValidHours: The number of hours that the download URLs will be valid for (Maximum 24 hours).
244-
245-
### 2.5 Properties
241+
### 2.4 Properties
246242

247243
> [!NOTE]
244+
>
248245
> - The files are GZIP compressed & in multiline JSON format.
249-
> - The download URLs are only valid for 1 hour; otherwise you can use the parameter.
246+
> - The download URLs are only valid for 1 hour.
250247
> - For maximum download speed of your data, you can make sure you are downloading from the same Azure region in which your data resides.
251248
252249

@@ -260,15 +257,15 @@ Export files|array[string]|A list of download URLs for files holding the current
260257
GeneratedTime|string|The time that the export was generated.|2021-05-20T08:00:00Z
261258
|
262259

263-
### 2.6 Examples
260+
### 2.5 Examples
264261

265-
#### 2.6.1 Request example
262+
#### 2.5.1 Request example
266263

267264
```http
268265
GET https://api.securitycenter.microsoft.com/api/machines/SecureConfigurationsAssessmentExport
269266
```
270267

271-
#### 2.6.2 Response example
268+
#### 2.5.2 Response example
272269

273270
```json
274271
{

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

Lines changed: 6 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ ms.topic: reference
1515
ms.subservice: reference
1616
ms.custom: api
1717
search.appverid: met150
18-
ms.date: 06/04/2021
18+
ms.date: 01/08/2025
1919
---
2020

2121
# Export software inventory assessment per device
@@ -236,16 +236,12 @@ Delegated (work or school account)|Software.Read|\'Read Threat and Vulnerability
236236
GET /api/machines/SoftwareInventoryExport
237237
```
238238

239-
### Parameters
240-
241-
- sasValidHours: The number of hours that the download URLs will be valid for (Maximum 24 hours)
242-
243-
### 2.5 Properties
239+
### 2.4 Properties
244240

245241
> [!NOTE]
246242
>
247243
> - The files are gzip compressed & in multiline JSON format.
248-
> - The download URLs are only valid for 3 hours. Otherwise you can use the parameter.
244+
> - The download URLs are only valid for 1 hour.
249245
> - For maximum download speed of your data, you can make sure you are downloading from the same Azure region that your data resides.
250246
251247
<br>
@@ -258,15 +254,15 @@ Export files|array\[string\]|A list of download URLs for files holding the curre
258254
GeneratedTime|string|The time that the export was generated.|2021-05-20T08:00:00Z
259255
|
260256

261-
### 2.6 Examples
257+
### 2.5 Examples
262258

263-
#### 2.6.1 Request example
259+
#### 2.5.1 Request example
264260

265261
```http
266262
GET https://api.securitycenter.microsoft.com/api/machines/SoftwareInventoryExport
267263
```
268264

269-
#### 2.6.2 Response example
265+
#### 2.5.2 Response example
270266

271267
```json
272268
{

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

Lines changed: 6 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ ms.topic: reference
1515
ms.subservice: reference
1616
ms.custom: api
1717
search.appverid: met150
18-
ms.date: 06/04/2021
18+
ms.date: 01/08/2025
1919
---
2020

2121
# Export software vulnerabilities assessment per device
@@ -288,16 +288,12 @@ Delegated (work or school account)|Vulnerability.Read|\'Read Threat and Vulnerab
288288
GET /api/machines/SoftwareVulnerabilitiesExport
289289
```
290290

291-
### 2.4 Parameters
292-
293-
- sasValidHours: The number of hours that the download URLs will be valid for (Maximum 24 hours).
294-
295-
### 2.5 Properties
291+
### 2.4 Properties
296292

297293
> [!NOTE]
298294
>
299295
> - The files are gzip compressed & in multiline Json format.
300-
> - The download URLs are only valid for 3 hours; otherwise you can use the parameter.
296+
> - The download URLs are only valid for 1 hour.
301297
> - For maximum download speed of your data, you can make sure you are downloading from the same Azure region that your data resides.
302298
>
303299
> - Each record is approximately 1KB of data. You should take this into account when choosing the correct pageSize parameter for you.
@@ -313,15 +309,15 @@ Export files|array\[string\]|A list of download URLs for files holding the curre
313309
GeneratedTime|String|The time that the export was generated.|2021-05-20T08:00:00Z
314310
|
315311

316-
### 2.6 Examples
312+
### 2.5 Examples
317313

318-
#### 2.6.1 Request example
314+
#### 2.5.1 Request example
319315

320316
```http
321317
GET https://api-us.securitycenter.contoso.com/api/machines/SoftwareVulnerabilitiesExport
322318
```
323319

324-
#### 2.6.2 Response example
320+
#### 2.5.2 Response example
325321

326322
```json
327323
{

0 commit comments

Comments
 (0)