Skip to content

[API/YAML] Use API to deploy in-house (enterprise) iOS/iPadOS package - #33950

Merged
marko-lisica merged 3 commits into
docs-v4.76.0from
30936-ipa-api
Oct 8, 2025
Merged

[API/YAML] Use API to deploy in-house (enterprise) iOS/iPadOS package#33950
marko-lisica merged 3 commits into
docs-v4.76.0from
30936-ipa-api

Conversation

@marko-lisica

Copy link
Copy Markdown
Member

Comment thread docs/REST API/rest-api.md

> **Experimental feature**. This feature is undergoing rapid improvement, which may result in breaking changes to the API or configuration surface. It is not recommended for use in automated workflows.

`GET /api/v1/fleet/hosts/:id/software`

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:

GET /api/v1/fleet/hosts/:id/software should returns software_package object for in-house (.ipa package) app.

"software_package": {
  "name": "MyCustomApp-1.12.ipa",
  "automatic_install_policies": null,
  "version": "1.12",
  "platform": "ios",
  "self_service": false,
  "icon_url": null,
  "last_install": {
    "install_uuid": "e4e31e89-7f43-4f18-8f12-d5dd09ee0d68",
    "installed_at": "2025-08-29T10:06:55.424525Z"
  },
  "last_uninstall": null,
  "package_url": null,
  "categories": null
}

install_uuid is UUID of MDM command that is used to install .ipa

Comment thread docs/REST API/rest-api.md
@@ -9988,6 +9988,30 @@
"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.

Comment thread docs/REST API/rest-api.md

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.

@marko-lisica
marko-lisica merged commit c257897 into docs-v4.76.0 Oct 8, 2025
6 checks passed
@marko-lisica
marko-lisica deleted the 30936-ipa-api branch October 8, 2025 10:55
Comment thread docs/REST API/rest-api.md
"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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants