Skip to content
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

[API design] Create policies automatically for Fleet-maintained apps #22609

Closed
wants to merge 16 commits into from
Closed

[API design] Create policies automatically for Fleet-maintained apps #22609

Changes from 6 commits
Commits
Show all changes
16 commits
Select commit Hold shift + click to select a range
ee47928
Update rest-api.md
marko-lisica Oct 3, 2024
06600aa
Update rest-api.md
marko-lisica Oct 3, 2024
9c83a33
Merge branch 'docs-v4.59.0' into 22077-api-design
marko-lisica Oct 18, 2024
41ec901
Update - expedited drafting
marko-lisica Oct 18, 2024
210d658
Merge branch 'docs-v4.59.0' into 22077-api-design
marko-lisica Oct 18, 2024
1e58d43
Update docs/REST API/rest-api.md
marko-lisica Oct 18, 2024
729155e
Update docs/REST API/rest-api.md
marko-lisica Oct 18, 2024
f32097e
Update docs/REST API/rest-api.md
marko-lisica Oct 18, 2024
b7429f2
Update docs/REST API/rest-api.md
marko-lisica Oct 18, 2024
c2f6ffd
Update docs/REST API/rest-api.md
marko-lisica Oct 18, 2024
7dcef8a
Update docs/REST API/rest-api.md
marko-lisica Oct 18, 2024
2acc5bf
Update docs/REST API/rest-api.md
marko-lisica Oct 18, 2024
06a7945
Update docs/REST API/rest-api.md
marko-lisica Oct 18, 2024
1ce7b01
Update rest-api.md
marko-lisica Oct 22, 2024
636a366
Update rest-api.md
marko-lisica Nov 5, 2024
9f9feb0
Update docs/REST API/rest-api.md
marko-lisica Nov 6, 2024
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
13 changes: 10 additions & 3 deletions docs/REST API/rest-api.md
View file
Open in desktop
marko-lisica marked this conversation as resolved.
Show resolved Hide resolved
Original file line number Diff line number Diff line change
Expand Up @@ -8881,7 +8881,9 @@ Get a list of all software.
"software_package": {
"name": "FirefoxInsall.pkg",
"version": "125.6",
"self_service": true
"self_service": true,
Copy link
Member

Choose a reason for hiding this comment

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

the final item in an object typically doesn't have the trailing comma. It was more correct before.

marko-lisica marked this conversation as resolved.
Show resolved Hide resolved
"automatic_install": true,
marko-lisica marked this conversation as resolved.
Show resolved Hide resolved
"fleet_maintained": false
marko-lisica marked this conversation as resolved.
Show resolved Hide resolved
},
"app_store_app": null,
"versions_count": 3,
Expand Down Expand Up @@ -9139,8 +9141,8 @@ Returns information about the specified software. By default, `versions` are sor
{
"software_title": {
"id": 12,
"name": "Firefox.app",
"bundle_identifier": "org.mozilla.firefox",
"name": "Falcon.app",
"bundle_identifier": "crowdstrike.falcon.Agent",
"software_package": {
"name": "FalconSensor-6.44.pkg",
"version": "6.44",
Expand All @@ -9152,6 +9154,8 @@ Returns information about the specified software. By default, `versions` are sor
"post_install_script": "sudo /Applications/Falcon.app/Contents/Resources/falconctl license 0123456789ABCDEFGHIJKLMNOPQRSTUV-WX",
"uninstall_script": "/Library/CS/falconctl uninstall",
"self_service": true,
"automatic_install_policy_id": 343,
"fleet_maintained": true,
marko-lisica marked this conversation as resolved.
Show resolved Hide resolved
"status": {
"installed": 3,
"pending_install": 1,
Expand Down Expand Up @@ -9586,6 +9590,7 @@ Add App Store (VPP) app purchased in Apple Business Manager.

> **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.


marko-lisica marked this conversation as resolved.
Show resolved Hide resolved
List available Fleet-maintained apps.

`GET /api/v1/fleet/software/fleet_maintained_apps`
Expand Down Expand Up @@ -9691,6 +9696,7 @@ Add Fleet-maintained app so it's available for install.
| post_install_script | string | body | The contents of the script to run after install. If the specified script fails (exit code non-zero) software install will be marked as failed and rolled back. |
| self_service | boolean | body | Self-service software is optional and can be installed by the end user. |


marko-lisica marked this conversation as resolved.
Show resolved Hide resolved
#### Example

`POST /api/v1/fleet/software/fleet_maintained_apps`
Expand All @@ -9708,6 +9714,7 @@ Add Fleet-maintained app so it's available for install.

`Status: 204`


marko-lisica marked this conversation as resolved.
Show resolved Hide resolved
### Download package

> **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.
Expand Down
Loading