Skip to content

[API] Add multiple custom packages for the same software title in the same fleet #48265

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
marko-lisica merged 4 commits into from
Jul 1, 2026
Merged

[API] Add multiple custom packages for the same software title in the same fleet #48265

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
be2ca95
[API] Add multiple custom packages for the same software title in the…
marko-lisica Jun 25, 2026
ff522da
Apply suggestion from @marko-lisica
marko-lisica Jun 25, 2026
4c8bf8e
Apply suggestion from @marko-lisica
marko-lisica Jun 25, 2026
d26525a
Apply suggestion from @marko-lisica
marko-lisica Jun 25, 2026
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
98 changes: 98 additions & 0 deletions docs/REST API/rest-api.md
View file
Open in desktop

@marko-lisica marko-lisica Jun 25, 2026 •
edited
Loading

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Dev notes

  • Add a packages array to the List software (GET /api/v1/fleet/software/titles) and Get software (GET /api/v1/fleet/software/titles/:id) responses. The array lists all packages added for a title.
    • GET /api/v1/fleet/software/titles: Don't include last_install and last_uninstall fields, as those are only relevant for the host.
  • software_package is kept for backwards compatibility and it contains the oldest (first added) package.
  • Per-package self_service, categories, and labels (labels_include_any, labels_exclude_any, labels_include_all.
  • GET /api/v1/fleet/hosts/:id/software
    • Keep the software_package object in the response. If multiple packages are added to the software title, it will include info about the package that is installed/available for install for that host.
    • In case there are multiple packages that are in scope on the host, we rely on the fallback (the package that is first added).

Original file line number Diff line number Diff line change
Expand Up @@ -10848,6 +10848,24 @@ Get a list of all software.
"vulnerabilities": null
}
],
"packages": [
{
"name": "Slack-4.50.128-macOS.pkg",
"automatic_install_policies": null,
"version": "4.50.128",
"platform": "darwin",
"self_service": false,
"package_url": ""
},
{
"name": "Slack-4.51.133-macOS.pkg",
"automatic_install_policies": null,
"version": "4.51.133",
"platform": "darwin",
"self_service": true,
"package_url": ""
}
],
"software_package": {
"name": "Slack-4.50.128-macOS.pkg",
"automatic_install_policies": null,
Expand Down Expand Up @@ -10879,6 +10897,7 @@ Get a list of all software.
"vulnerabilities": null
}
],
"packages": null,
"software_package": null,
"app_store_app": null,
"bundle_identifier": "com.raycast.macos",
Expand All @@ -10894,6 +10913,8 @@ Get a list of all software.

`browser` and `extension_for` fields are included when set and when empty. `extension_for` will show the browser or Visual Studio Code fork associated with the extension, allowing for differentiation between e.g. an extension installed on Visual Studio Code and one installed on Cursor. `browser` is deprecated, and only shows this information for browser plugins.

A software title can have more than one package. The `packages` array lists all packages added for the title. `software_package` is kept for backwards compatibility and contains the oldest (first added) package; it's `null` when no package is available.

### List software versions

Get a list of all software versions.
Expand Down Expand Up @@ -11099,6 +11120,79 @@ Returns information about the specified software. By default, `versions` are sor
}
],
"counts_updated_at": "2026-06-04T17:23:45Z",
"packages": [
{
"team_id": 310,
"title_id": 2792,
"name": "Slack-4.50.128-macOS.pkg",
"icon_url": null,
"version": "4.50.128",
"platform": "darwin",
"uploaded_at": "2026-06-04T17:29:09.155424Z",
"installer_id": 36817,
"install_script": "#!/bin/sh\n\ninstaller -pkg \"$INSTALLER_PATH\" -target /\n",
"pre_install_query": "",
"post_install_script": "",
"uninstall_script": "#!/bin/sh\n\n# Fleet extracts and saves package IDs.\npkg_ids=(\n 'com.tinyspeck.slackmacgap'\n)\n",
"hash_sha256": "f7e4cba7676dacb03ac4cdbe5a99cc1d80ef751c484a13c6a7cf6a93de4a494e",
"status": {
"installed": 0,
"pending_install": 1,
"failed_install": 0,
"pending_uninstall": 0,
"failed_uninstall": 0
},
"self_service": false,
"url": "",
"fleet_maintained_app_id": null,
"automatic_install_policies": null,
"labels_include_any": null,
"labels_exclude_any": null,
"labels_include_all": null,
"categories": null,
"display_name": "",
"patch_policy": null,
"fleet_id": 310
},
{
"team_id": 310,
"title_id": 2792,
"name": "Slack-4.51.133-macOS.pkg",
"icon_url": null,
"version": "4.51.133",
"platform": "darwin",
"uploaded_at": "2026-06-10T09:14:51.482217Z",
"installer_id": 36901,
"install_script": "#!/bin/sh\n\ninstaller -pkg \"$INSTALLER_PATH\" -target /\n",
"pre_install_query": "",
"post_install_script": "",
"uninstall_script": "#!/bin/sh\n\n# Fleet extracts and saves package IDs.\npkg_ids=(\n 'com.tinyspeck.slackmacgap'\n)\n",
"hash_sha256": "a1b2c3d4e5f60718293a4b5c6d7e8f901a2b3c4d5e6f70819203a4b5c6d7e8f9",
"status": {
"installed": 0,
"pending_install": 0,
"failed_install": 0,
"pending_uninstall": 0,
"failed_uninstall": 0
},
"self_service": true,
"url": "",
"fleet_maintained_app_id": null,
"automatic_install_policies": null,
"labels_include_any": null,
"labels_exclude_any": null,
"labels_include_all": [
{
"id": 12,
"name": "IT test team"
}
],
"categories": null,
"display_name": "",
"patch_policy": null,
"fleet_id": 310
}
],
"software_package": {
"team_id": 310,
"title_id": 2792,
Expand Down Expand Up @@ -11141,6 +11235,10 @@ Returns information about the specified software. By default, `versions` are sor

`browser` and `extension_for` fields are included when set and when empty, at the same level as `source`. `extension_for` will show the browser or Visual Studio Code fork associated with the extension, allowing for differentiation between e.g. an extension installed on Visual Studio Code and one installed on Cursor. `browser` is deprecated, and only shows this information for browser plugins.

A software title can have more than one package. The `packages` array lists all packages added for the title, including per-package `self_service`, `categories`, and labels (`labels_include_any`, `labels_exclude_any`, `labels_include_all`). `software_package` is kept for backwards compatibility and contains the oldest (first added) package.

> Install, pending, and failed counts in `packages.status` are combined across policy automations, setup experience, and manual installs.

For in-house iOS apps, the `software_package` field is populated with package information.

For Apple App Store and Google Play apps, the `software_package` field is `null` and `app_store_app` is populated with information from the store. For example:
Expand Down
Loading