-
Notifications
You must be signed in to change notification settings - Fork 979
[API/YAML] Use API to deploy in-house (enterprise) iOS/iPadOS package #33950
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.
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
Changes from all commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -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" | ||
|
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. this looks new? do we have a platform field for all cc: @jahzielv
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. @RachelElysia I do see the |
||
| "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. | ||
|
|
@@ -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` | ||
|
Member
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Dev note
This means that GitOps will run successfully. The |
||
|
|
||
| #### 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). | | ||
|
|
@@ -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**. | | ||
|
|
||
There was a problem hiding this comment.
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
.ipapackage should be null.