Elgato_dark/fleet
1
0
Fork 0
mirror of https://github.com/fleetdm/fleet synced 2026-05-23 00:49:03 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 106

Add missing docs for batch apply VPP apps (#22265)

Browse source 
#22069
This commit is contained in:
Lucas Manuel Rodriguez 2024-09-23 18:24:08 -03:00 committed by GitHub
parent 1fdd127f6c
commit dfc7289a6d
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
1 changed files with 39 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

39
docs/Contributing/API-for-contributors.md
View file

@ -3371,6 +3371,45 @@ If both `team_id` and `team_name` parameters are included, this endpoint will re
}
```
### Batch-apply VPP apps
_Available in Fleet Premium._
`POST /api/latest/fleet/software/app_store_apps/batch`
#### Parameters
| Name | Type | In | Description |
| --------- | ------ | ----- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| team_name | string | query | The name of the team to add the software package to. Ommitting this parameter will add software to 'No Team'. |
| dry_run | bool | query | If `true`, will validate the provided VPP apps and return any validation errors, but will not apply the changes. |
| app_store_apps | list | body | An array of objects. Each object contains `app_store_id` and `self_service`. |
| app_store_apps.app_store_id | string | body | ID of the App Store app. |
| app_store_apps.self_service | boolean | body | Whether the VPP app is "Self-service" or not. |
#### Example
`POST /api/latest/fleet/software/app_store_apps/batch`
```json
{
"team_name": "Foobar",
"app_store_apps": {
{
"app_store_id": "597799333",
"self_service": false,
},
{
"app_store_id": "497799835",
"self_service": true,
}
}
}
```
##### Default response
`Status: 204`
### Run live script
Run a live script and get results back (5 minute timeout). Live scripts only runs on the host if it has no other scripts running.