Skip to content
Open
Show file tree
Hide file tree
Changes from 2 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions docs/Configuration/yaml-files.md
Original file line number Diff line number Diff line change
Expand Up @@ -494,6 +494,7 @@ Currently, for Fleet-maintained apps and App Store (VPP) apps, the `labels_` and

> You can specify a hash alone to reference a software package that was previously uploaded to Fleet, whether via the UI or the API,. If a package with that hash isn't already in Fleet and visible to the user performing the GitOps run, the GitOps run will error.

- `display_name` is the package name that will be displayed in the UI. If not set, `name` will be used instead.
- `pre_install_query.path` is the osquery query Fleet runs before installing the software. Software will be installed only if the [query returns results](https://fleetdm.com/tables).
- `install_script.path` specifies the command Fleet will run on hosts to install software. The [default script](https://github.com/fleetdm/fleet/tree/main/pkg/file/scripts) is dependent on the software type (i.e. .pkg).
- `uninstall_script.path` is the script Fleet will run on hosts to uninstall software. The [default script](https://github.com/fleetdm/fleet/tree/main/pkg/file/scripts) is dependent on the software type (i.e. .pkg).
Expand Down
16 changes: 16 additions & 0 deletions docs/REST API/rest-api.md
Original file line number Diff line number Diff line change
Expand Up @@ -9449,6 +9449,7 @@ Get a list of all software.
{
"id": 12,
"name": "Firefox.app",
"display_name": "Firefox",
"software_package": {
"platform": "darwin",
"fleet_maintained_app_id": 42,
Expand Down Expand Up @@ -9489,6 +9490,7 @@ Get a list of all software.
{
"id": 22,
"name": "Google Chrome.app",
"display_name": "Chrome",
"software_package": null,
"app_store_app": null,
"versions_count": 5,
Expand Down Expand Up @@ -9521,6 +9523,7 @@ Get a list of all software.
{
"id": 32,
"name": "1Password – Password Manager",
"display_name": "",
"software_package": null,
"app_store_app": null,
"versions_count": 1,
Expand Down Expand Up @@ -9583,6 +9586,7 @@ Get a list of all software versions.
{
"id": 1,
"name": "glibc",
"display_name": "",
"version": "2.12",
"source": "rpm_packages",
"release": "1.212.el6",
Expand All @@ -9606,6 +9610,7 @@ Get a list of all software versions.
{
"id": 2,
"name": "1Password – Password Manager",
"display_name": "",
"version": "2.10.0",
"source": "chrome_extensions",
"browser": "chrome",
Expand Down Expand Up @@ -9722,6 +9727,7 @@ Returns information about the specified software. By default, `versions` are sor
"software_title": {
"id": 12,
"name": "Falcon.app",
"display_name": "Crowdstrike Falcon",
"bundle_identifier": "crowdstrike.falcon.Agent",
"available_software": {
"fleet_maintained_app": {
Expand Down Expand Up @@ -9806,6 +9812,7 @@ Returns information about the specified software. By default, `versions` are sor
"software_title": {
"id": 15,
"name": "Logic Pro",
"display_name": "",
"bundle_identifier": "com.apple.logic10",
"available_software": {
"fleet_maintained_app": null,
Expand Down Expand Up @@ -9876,6 +9883,7 @@ Returns information about the specified software version.
"software": {
"id": 425224,
"name": "Firefox.app",
"display_name": "Firefox",
"version": "117.0",
"bundle_identifier": "org.mozilla.firefox",
"source": "apps",
Expand Down Expand Up @@ -10040,6 +10048,7 @@ Content-Type: application/octet-stream
"software_package": {
"title_id": 123,
"name": "FalconSensor-6.44.pkg",
"display_name": "",
"version": "6.44",
"platform": "darwin",
"fleet_maintained_app_id": 42,
Expand Down Expand Up @@ -10081,6 +10090,7 @@ Update a package to install on macOS, Windows, or Linux (Ubuntu) hosts.
| id | integer | path | ID of the software title being updated. |
| software | file | form | Installer package file. Supported packages are .pkg, .msi, .exe, .deb, and .rpm. |
| team_id | integer | form | **Required**. The team ID. Updates a software package in the specified team. |
| display_name | string | form | Optional override for the default `name`. |
| categories | string[] | form | Zero or more of the [supported categories](https://fleetdm.com/docs/configuration/yaml-files#supported-software-categories), used to group self-service software on your end users' **Fleet Desktop > My device** page. Software with no categories will be still be shown under **All**. |
| install_script | string | form | Command that Fleet runs to install software. If not specified Fleet runs the [default install command](https://github.com/fleetdm/fleet/tree/main/pkg/file/scripts) for each package type. |
| pre_install_query | string | form | Query that is pre-install condition. If the query doesn't return any result, the package will not be installed. |
Expand Down Expand Up @@ -10137,6 +10147,7 @@ Content-Type: application/octet-stream
{
"software_package": {
"name": "FalconSensor-6.44.pkg",
"display_name": "",
"categories": [],
"version": "6.44",
"platform": "darwin",
Expand Down Expand Up @@ -10185,20 +10196,23 @@ Returns the list of Apple App Store (VPP) that can be added to the specified tea
"app_store_apps": [
{
"name": "Xcode",
"display_name": "",
"icon_url": "https://is1-ssl.mzstatic.com/image/thumb/Purple211/v4/f1/65/1e/a4844ccd-486d-455f-bb31-67336fe46b14/AppIcon-1x_U007emarketing-0-7-0-85-220-0.png/512x512bb.jpg",
"latest_version": "15.4",
"app_store_id": "497799835",
"platform": "darwin"
},
{
"name": "Logic Pro",
"display_name": "",
"icon_url": "https://is1-ssl.mzstatic.com/image/thumb/Purple211/v4/f1/65/1e/a4844ccd-486d-455f-bb31-67336fe46b14/AppIcon-1x_U007emarketing-0-7-0-85-220-0.png/512x512bb.jpg",
"latest_version": "2.04",
"app_store_id": "634148309",
"platform": "ios"
},
{
"name": "Logic Pro",
"display_name": "",
"icon_url": "https://is1-ssl.mzstatic.com/image/thumb/Purple211/v4/f1/65/1e/a4844ccd-486d-455f-bb31-67336fe46b14/AppIcon-1x_U007emarketing-0-7-0-85-220-0.png/512x512bb.jpg",
"latest_version": "2.04",
"app_store_id": "634148309",
Expand Down Expand Up @@ -10273,6 +10287,7 @@ Modify App Store (VPP) app's options.
| Name | Type | In | Description |
| ---- | ---- | -- | ----------- |
| team_id | integer | body | **Required**. The team ID. Edits App Store apps from the specified team. |
| display_name | string | form | Optional override for the default `name`. |
| categories | string[] | body | Zero or more of the [supported categories](https://fleetdm.com/docs/configuration/yaml-files#supported-software-categories), used to group self-service software on your end users' **Fleet Desktop > My device** page. Software with no categories will be still be shown under **All**. |
| self_service | boolean | body | Self-service software is optional and can be installed by the end user. |
| labels_include_any | array | form | Target hosts that have any label in the array. |
Expand Down Expand Up @@ -10306,6 +10321,7 @@ Only one of `labels_include_any` or `labels_exclude_any` can be specified. If ne
{
"app_store_app": {
"name": "Logic Pro",
"display_name": "",
"app_store_id": 1091189122,
"categories": ["Browser"],
"latest_version": "2.04",
Expand Down
Loading