From 090d0df364eac624fbf6bd453b3517c86cb6e4a5 Mon Sep 17 00:00:00 2001 From: Marko Lisica <83164494+marko-lisica@users.noreply.github.com> Date: Tue, 7 Oct 2025 21:36:29 +0200 Subject: [PATCH 1/3] Update rest-api.md --- docs/REST API/rest-api.md | 79 +++++++++++++++++++++++++++++++++++++++ 1 file changed, 79 insertions(+) diff --git a/docs/REST API/rest-api.md b/docs/REST API/rest-api.md index 653b128e2af..22c0fc3340c 100644 --- a/docs/REST API/rest-api.md +++ b/docs/REST API/rest-api.md @@ -9988,6 +9988,30 @@ Get a list of all software. "vulnerabilities": [] } ] + }, + { + "id": 12, + "name": "MyCustomApp", + "software_package": { + "name": "MyCustomApp-1.12.ipa", + "platform": "ios", + "version": "1.12", + "self_service": false, + "automatic_install_policies": null, + "last_install": null, + "last_uninstall": null + }, + "app_store_app": null, + "versions_count": 1, + "source": "ios_apps", + "hosts_count": 48, + "versions": [ + { + "id": 123, + "version": "1.12", + "vulnerabilities": null + } + ], } ], "meta": { @@ -10302,6 +10326,61 @@ Returns information about the specified software. By default, `versions` are sor } ``` +#### Example (in-house iOS app) + +`GET /api/v1/fleet/software/titles/24?team_id=3` + +##### Default response + +`Status: 200` + +```json +{ + "software_title": { + "id": 12, + "name": "MyCustomApp", + "software_package": { + "name": "MyCustomApp-1.12.ipa", + "platform": "ios" + "fleet_maintained_id": null, + "version": "1.12", + "self_service": false, + "automatic_install_policies": null, + "categories": null, + "uploaded_at": "2025-08-15T00:55:03.96954Z", + "hash_sha256": "1e83a94b801db429398b95a11f76fc5ba0e8643cb027b40a2b890592761f48f9", + "title_id": 12, + "team_id": 3, + "status": { + "installed": 0, + "pending_install": 0, + "failed_install": 0, + "pending_uninstall": 0, + "failed_uninstall": 0 + }, + "installer_id": 332, + "install_script": null, + "uninstall_script": null, + "post_install_script": null, + "pre_install_query": null, + "labels_include_any": null, + "labels_exclude_any": null, + }, + "app_store_app": null, + "versions_count": 1, + "source": "ios_apps", + "hosts_count": 48, + "versions": [ + { + "id": 123, + "version": "1.12", + "vulnerabilities": null + } + ], + } +} +``` + ### Get software version Returns information about the specified software version. From 8fa568c916978d144578a679d227c71fb8caf6b9 Mon Sep 17 00:00:00 2001 From: Marko Lisica <83164494+marko-lisica@users.noreply.github.com> Date: Tue, 7 Oct 2025 21:39:15 +0200 Subject: [PATCH 2/3] update --- docs/REST API/rest-api.md | 7 +++---- 1 file changed, 3 insertions(+), 4 deletions(-) diff --git a/docs/REST API/rest-api.md b/docs/REST API/rest-api.md index 22c0fc3340c..b697092474d 100644 --- a/docs/REST API/rest-api.md +++ b/docs/REST API/rest-api.md @@ -10556,8 +10556,7 @@ Operating systems other than Windows, macOS, and Linux do not report vulnerabili _Available in Fleet Premium._ -Add a package (.pkg, .msi, .exe, .deb, .rpm, .tar.gz) to install on macOS, Windows, or Linux hosts. - +Add a package (.pkg, .ipa, .msi, .exe, .deb, .rpm, .tar.gz) to install on Apple (macOS/iOS/iPadOS), Windows, or Linux hosts. `POST /api/v1/fleet/software/package` @@ -10565,7 +10564,7 @@ Add a package (.pkg, .msi, .exe, .deb, .rpm, .tar.gz) to install on macOS, Windo | Name | Type | In | Description | | ---- | ------- | ---- | -------------------------------------------- | -| software | file | form | **Required**. Installer package file. Supported packages are .pkg, .msi, .exe, .deb, and .rpm. | +| software | file | form | **Required**. Installer package file. Supported packages are .pkg, .ipa, .msi, .exe, .deb, and .rpm. | | team_id | integer | form | **Required**. The team ID. Adds a software package to the specified team. | | install_script | string | form | Script that Fleet runs to install software. If not specified Fleet runs the [default install script](https://github.com/fleetdm/fleet/tree/main/pkg/file/scripts) for each package type if one exists. Required for `.tar.gz` and `.exe` (no default script). | | uninstall_script | string | form | Script that Fleet runs to uninstall software. If not specified Fleet runs the [default uninstall script](https://github.com/fleetdm/fleet/tree/main/pkg/file/scripts) for each package type if one exists. Required for `.tar.gz` and `.exe` (no default script). | @@ -10663,7 +10662,7 @@ Update a package to install on macOS, Windows, or Linux (Ubuntu) hosts. | Name | Type | In | Description | | ---- | ------- | ---- | -------------------------------------------- | | 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. | +| software | file | form | Installer package file. Supported packages are .pkg, .ipa, .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**. | From bafb801ee776ac99822b702c7cdaa713f173035e Mon Sep 17 00:00:00 2001 From: Marko Lisica <83164494+marko-lisica@users.noreply.github.com> Date: Tue, 7 Oct 2025 21:40:06 +0200 Subject: [PATCH 3/3] update --- docs/Configuration/yaml-files.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/Configuration/yaml-files.md b/docs/Configuration/yaml-files.md index e58b9b8871b..91d0da3028f 100644 --- a/docs/Configuration/yaml-files.md +++ b/docs/Configuration/yaml-files.md @@ -463,7 +463,7 @@ Can only be configured for all teams (`default.yml`). The `software` section allows you to configure packages, Apple App Store apps, and Fleet-maintained apps that you want to install on your hosts. -- `packages` is a list of paths to custom packages (.pkg, .msi, .exe, .rpm, .deb, or .tar.gz). +- `packages` is a list of paths to custom packages (.pkg, .ipa, .msi, .exe, .rpm, .deb, or .tar.gz). - `app_store_apps` is a list of Apple App Store apps. - `fleet_maintained_apps` is a list of Fleet-maintained apps.