Skip to content

Commit 872c37f

Browse files
committed
Fix inventory machine apps & snapshots export docs
The URL parameter to filter the source is `source_name`
1 parent 82b4681 commit 872c37f

File tree

1 file changed

+8
-8
lines changed

1 file changed

+8
-8
lines changed

docs/apps/inventory.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -162,16 +162,16 @@ Response:
162162
* required permission:
163163
* `inventory.view_androidapp`
164164
* optional parameter:
165-
* `source`: The name of an inventory source. Only machines with Android apps collected via this source will be included in the export.
165+
* `source_name`: The name of an inventory source. Only machines with Android apps collected via this source will be included in the export.
166166

167167
Use this endpoint to trigger a machine Android apps export task. The result of this task will be a Zip archive containing a CSV file for each source.
168168

169-
Example:
169+
Example of an export limited to the `Workspace ONE` source:
170170

171171
```bash
172172
curl -XPOST \
173173
-H "Authorization: Token $ZTL_API_TOKEN" \
174-
https://zentral.example.com/api/inventory/machines/export_android_apps/\
174+
"https://zentral.example.com/api/inventory/machines/export_android_apps/?source_name=Workspace%20ONE" \
175175
|python3 -m json.tool
176176
```
177177

@@ -189,7 +189,7 @@ Response:
189189
* required permission:
190190
* `inventory.view_debpackage`
191191
* optional parameter:
192-
* `source`: The name of an inventory source. Only machines with Debian packages collected via this source will be included in the export.
192+
* `source_name`: The name of an inventory source. Only machines with Debian packages collected via this source will be included in the export.
193193

194194
Use this endpoint to trigger a machine Debian packages export task. The result of this task will be a Zip archive containing a CSV file for each source.
195195

@@ -217,7 +217,7 @@ Response:
217217
* required permission:
218218
* `inventory.view_iosapp`
219219
* optional parameter:
220-
* `source`: The name of an inventory source. Only machines with iOS apps collected via this source will be included in the export.
220+
* `source_name`: The name of an inventory source. Only machines with iOS apps collected via this source will be included in the export.
221221

222222
Use this endpoint to trigger a machine iOS apps export task. The result of this task will be a Zip archive containing a CSV file for each source.
223223

@@ -246,7 +246,7 @@ Response:
246246
* `inventory.view_osxapp`
247247
* `inventory.view_osxappinstance`
248248
* optional parameter:
249-
* `source`: The name of an inventory source. Only machines with macOS apps collected via this source will be included in the export.
249+
* `source_name`: The name of an inventory source. Only machines with macOS apps collected via this source will be included in the export.
250250

251251
Use this endpoint to trigger a machine macOS app instances export task. The result of this task will be a Zip archive containing a CSV file for each source.
252252

@@ -275,7 +275,7 @@ Response:
275275
* `inventory.view_program`
276276
* `inventory.view_programinstance`
277277
* optional parameter:
278-
* `source`: The name of an inventory source. Only machines with Windows programs collected via this source will be included in the export.
278+
* `source_name`: The name of an inventory source. Only machines with Windows programs collected via this source will be included in the export.
279279

280280
Use this endpoint to trigger a machine Windows program instances export task. The result of this task will be a Zip archive containing a CSV file for each source.
281281

@@ -303,7 +303,7 @@ Response:
303303
* required permissions:
304304
* `inventory.view_machinesnapshot`
305305
* optional parameter:
306-
* `source`: The name of an inventory source. Only machine snapshots collected via this source will be included in the export.
306+
* `source_name`: The name of an inventory source. Only machine snapshots collected via this source will be included in the export.
307307

308308
Use this endpoint to trigger a machine snapshots export task. The result of this task will be a Zip archive containing a JSONL file for each source.
309309

0 commit comments

Comments
 (0)