Skip to content
Merged
Show file tree
Hide file tree
Changes from all 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
2 changes: 1 addition & 1 deletion docs/Configuration/yaml-files.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down
86 changes: 82 additions & 4 deletions docs/REST API/rest-api.md
Original file line number Diff line number Diff line change
Expand Up @@ -9988,6 +9988,30 @@ Get a list of all software.
"vulnerabilities": []
}
]

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 note:

↓ Fields that are not supported by the .ipa package should be null.

},
{
"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": {
Expand Down Expand Up @@ -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"

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

this looks new? do we have a platform field for all software_package.platform? ios ipados others?

cc: @jahzielv

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

@RachelElysia I do see the software_package.platform field on existing software packages fwiw

"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.
Expand Down Expand Up @@ -10477,16 +10556,15 @@ 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`

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 note

  • When the user uploads an .ipa file type and they specify unsupported fields (install_script, uninstall_script, post_install_script, pre_install_query, categories, self_service, and automatic_install), Fleet will ignore them and won't throw an error or warning.

This means that GitOps will run successfully. The .ipa package is added to Fleet without any of the unsupported fields.


#### Parameters

| 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). |
Expand Down Expand Up @@ -10584,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**. |
Expand Down
Loading