From 8295ad93084ace2ae8aad9a03f0fb319bcad7519 Mon Sep 17 00:00:00 2001 From: Marko Lisica <83164494+marko-lisica@users.noreply.github.com> Date: Wed, 4 Sep 2024 15:22:59 +0200 Subject: [PATCH 01/13] Update rest-api.md --- docs/REST API/rest-api.md | 1 + 1 file changed, 1 insertion(+) diff --git a/docs/REST API/rest-api.md b/docs/REST API/rest-api.md index c4ad4e385814..1c39f0c47d0b 100644 --- a/docs/REST API/rest-api.md +++ b/docs/REST API/rest-api.md @@ -8485,6 +8485,7 @@ Deletes the session specified by ID. When the user associated with the session n - [Add package](#add-package) - [List App Store apps](#list-app-store-apps) - [Add App Store app](#add-app-store-app) +- [Add Fleet library app](#add-fleet-library-app) - [Install package or App Store app](#install-package-or-app-store-app) - [Get package install result](#get-package-install-result) - [Download package](#download-package) From 27d0734aa400e0effcf4082450e21935b323fa90 Mon Sep 17 00:00:00 2001 From: Marko Lisica Date: Wed, 4 Sep 2024 16:10:40 +0200 Subject: [PATCH 02/13] API design - adding new endpoints for Fleet app library story --- docs/REST API/rest-api.md | 123 +++++++++++++++++++++++++++++++++++++- 1 file changed, 122 insertions(+), 1 deletion(-) diff --git a/docs/REST API/rest-api.md b/docs/REST API/rest-api.md index 1c39f0c47d0b..4f9ab97c858c 100644 --- a/docs/REST API/rest-api.md +++ b/docs/REST API/rest-api.md @@ -8485,6 +8485,8 @@ Deletes the session specified by ID. When the user associated with the session n - [Add package](#add-package) - [List App Store apps](#list-app-store-apps) - [Add App Store app](#add-app-store-app) +- [List Fleet library apps](#list-fleet-library-apps) +- [Get Fleet library app](#get-fleet-library-app) - [Add Fleet library app](#add-fleet-library-app) - [Install package or App Store app](#install-package-or-app-store-app) - [Get package install result](#get-package-install-result) @@ -9123,7 +9125,7 @@ Add App Store (VPP) app purchased in Apple Business Manager. #### Example -`POST /api/v1/fleet/software/app_store_apps?team_id=3` +`POST /api/v1/fleet/software/app_store_apps` ##### Request body @@ -9139,6 +9141,125 @@ Add App Store (VPP) app purchased in Apple Business Manager. `Status: 200` +### List Fleet library apps + +> **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. + +List available Fleet library apps. + +`GET /api/v1/fleet/software/fleet_library_apps` + +#### Parameters + +| Name | Type | In | Description | +| ---- | ---- | -- | ----------- | +| team_id | integer | query | **Required**. The team ID. Filters Fleet library apps to only include apps available for the specified team. | + +#### Example + +`GET /api/v1/fleet/software/fleet_library_apps?team_id=3` + + +##### Default response + +`Status: 200` + +```json +{ + "fleet_library_apps": [ + { + "id": "1", + "name": "1Password", + "version": "8.10.40", + "platform": "darwin" + }, + { + "id": "2", + "name": "Adobe Acrobat Reader", + "version": "24.002.21005", + "platform": "darwin" + }, + { + "id": "3", + "name": "Box Drive", + "version": "2.39.179", + "platform": "darwin" + }, + ] +} +``` + +### Get Fleet library app + +> **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. + +Returns information about the specified Fleet library app. + +`GET /api/v1/fleet/software/fleet_library_apps/:id` + +#### Parameters + +| Name | Type | In | Description | +| ---- | ---- | -- | ----------- | +| id | integer | path | **Required.** The Fleet library app's ID. | +| team_id | integer | query | _Available in Fleet Premium_. Filters response data to the specified team. Use `0` to filter by hosts assigned to "No team" (default: 0). | + +#### Example + +`GET /api/v1/fleet/software/fleet_library_apps/1?team_id=3` + +##### Default response + +`Status: 200` + +```json +{ + "fleet_library_app": { + "id": 1, + "name": "1Password", + "file_name": "1Password-8.10.44-aarch64.zip", + "version": "8.10.40", + "platform": "darwin", + "install_script": "#!/bin/sh\ninstaller -pkg \"$INSTALLER_PATH\" -target /", + "uninstall_script": "#!/bin/sh\npkg_ids=$PACKAGE_ID\nfor pkg_id in '${pkg_ids[@]}'...", + } +} +``` + +### Add Fleet library app + +> **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. + +_Available in Fleet Premium._ + +Add app from Fleet library. + +`POST /api/v1/fleet/software/fleet_library_apps` + +#### Parameters + +| Name | Type | In | Description | +| ---- | ---- | -- | ----------- | +| fleet_library_app_id | string | body | **Required.** The ID of Fleet library app. | +| team_id | integer | body | **Required**. The team ID. Adds Fleet library app to the specified team. | + +#### Example + +`POST /api/v1/fleet/software/fleet_library_apps` + +##### Request body + +```json +{ + "fleet_library_app_id": "3", + "team_id": 2, +} +``` + +##### Default response + +`Status: 200` + ### 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. From 84207ac288fe593fa6c7503f81f3fd158773983e Mon Sep 17 00:00:00 2001 From: Marko Lisica Date: Wed, 4 Sep 2024 17:36:41 +0200 Subject: [PATCH 03/13] Remove team_id for get Fleet library app endpoint --- docs/REST API/rest-api.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/REST API/rest-api.md b/docs/REST API/rest-api.md index 4f9ab97c858c..5246780ca7c5 100644 --- a/docs/REST API/rest-api.md +++ b/docs/REST API/rest-api.md @@ -9202,11 +9202,11 @@ Returns information about the specified Fleet library app. | Name | Type | In | Description | | ---- | ---- | -- | ----------- | | id | integer | path | **Required.** The Fleet library app's ID. | -| team_id | integer | query | _Available in Fleet Premium_. Filters response data to the specified team. Use `0` to filter by hosts assigned to "No team" (default: 0). | + #### Example -`GET /api/v1/fleet/software/fleet_library_apps/1?team_id=3` +`GET /api/v1/fleet/software/fleet_library_apps/1` ##### Default response From b2de7fa4a32e0c18463c4bd32e46eeeedb2086f9 Mon Sep 17 00:00:00 2001 From: Marko Lisica Date: Thu, 5 Sep 2024 12:58:18 +0200 Subject: [PATCH 04/13] Changes discussed during estimation --- docs/REST API/rest-api.md | 10 +++++++++- 1 file changed, 9 insertions(+), 1 deletion(-) diff --git a/docs/REST API/rest-api.md b/docs/REST API/rest-api.md index 5246780ca7c5..4e9d21f385bc 100644 --- a/docs/REST API/rest-api.md +++ b/docs/REST API/rest-api.md @@ -9185,7 +9185,11 @@ List available Fleet library apps. "version": "2.39.179", "platform": "darwin" }, - ] + ], + "meta": { + "has_next_results": false, + "has_previous_results": false + } } ``` @@ -9242,6 +9246,10 @@ Add app from Fleet library. | ---- | ---- | -- | ----------- | | fleet_library_app_id | string | body | **Required.** The ID of Fleet library app. | | team_id | integer | body | **Required**. The team ID. Adds Fleet library app to the specified team. | +| install_script | string | form | Command that Fleet runs to install software. If not specified Fleet runs default install command for each library app. | +| pre_install_query | string | form | Query that is pre-install condition. If the query doesn't return any result, Fleet won't proceed to install. | +| post_install_script | string | form | 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 | form | Self-service software is optional and can be installed by the end user. | #### Example From 9e6b5638f5f116e59b6254da03dcaa1dd21ed473 Mon Sep 17 00:00:00 2001 From: Marko Lisica Date: Fri, 6 Sep 2024 13:19:44 +0200 Subject: [PATCH 05/13] Changes related to 'Fleet app library' -> 'Fleet-maintaned apps' --- docs/REST API/rest-api.md | 46 +++++++++++++++++++-------------------- 1 file changed, 23 insertions(+), 23 deletions(-) diff --git a/docs/REST API/rest-api.md b/docs/REST API/rest-api.md index 4e9d21f385bc..2aa8bfcbe991 100644 --- a/docs/REST API/rest-api.md +++ b/docs/REST API/rest-api.md @@ -8485,9 +8485,9 @@ Deletes the session specified by ID. When the user associated with the session n - [Add package](#add-package) - [List App Store apps](#list-app-store-apps) - [Add App Store app](#add-app-store-app) -- [List Fleet library apps](#list-fleet-library-apps) -- [Get Fleet library app](#get-fleet-library-app) -- [Add Fleet library app](#add-fleet-library-app) +- [List Fleet maintained apps](#list-fleet-maintained-apps) +- [Get Fleet maintained app](#get-fleet-maintained-app) +- [Add Fleet maintained app](#add-fleet-maintained-app) - [Install package or App Store app](#install-package-or-app-store-app) - [Get package install result](#get-package-install-result) - [Download package](#download-package) @@ -9141,23 +9141,23 @@ Add App Store (VPP) app purchased in Apple Business Manager. `Status: 200` -### List Fleet library apps +### List Fleet maintained apps > **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. -List available Fleet library apps. +List available Fleet maintained apps. -`GET /api/v1/fleet/software/fleet_library_apps` +`GET /api/v1/fleet/software/fleet_maintained_apps` #### Parameters | Name | Type | In | Description | | ---- | ---- | -- | ----------- | -| team_id | integer | query | **Required**. The team ID. Filters Fleet library apps to only include apps available for the specified team. | +| team_id | integer | query | **Required**. The team ID. Filters Fleet maintained apps to only include apps available for the specified team. | #### Example -`GET /api/v1/fleet/software/fleet_library_apps?team_id=3` +`GET /api/v1/fleet/software/fleet_maintained_apps?team_id=3` ##### Default response @@ -9166,7 +9166,7 @@ List available Fleet library apps. ```json { - "fleet_library_apps": [ + "fleet_maintained_apps": [ { "id": "1", "name": "1Password", @@ -9193,24 +9193,24 @@ List available Fleet library apps. } ``` -### Get Fleet library app +### Get Fleet maintained app > **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. -Returns information about the specified Fleet library app. +Returns information about the specified Fleet maintained app. -`GET /api/v1/fleet/software/fleet_library_apps/:id` +`GET /api/v1/fleet/software/fleet_maintained_apps/:id` #### Parameters | Name | Type | In | Description | | ---- | ---- | -- | ----------- | -| id | integer | path | **Required.** The Fleet library app's ID. | +| id | integer | path | **Required.** The Fleet maintained app's ID. | #### Example -`GET /api/v1/fleet/software/fleet_library_apps/1` +`GET /api/v1/fleet/software/fleet_maintained_apps/1` ##### Default response @@ -9218,7 +9218,7 @@ Returns information about the specified Fleet library app. ```json { - "fleet_library_app": { + "fleet_maintained_app": { "id": 1, "name": "1Password", "file_name": "1Password-8.10.44-aarch64.zip", @@ -9230,36 +9230,36 @@ Returns information about the specified Fleet library app. } ``` -### Add Fleet library app +### Add Fleet maintained app > **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. _Available in Fleet Premium._ -Add app from Fleet library. +Add Fleet maintained app so it's available for install. -`POST /api/v1/fleet/software/fleet_library_apps` +`POST /api/v1/fleet/software/fleet_maintained` #### Parameters | Name | Type | In | Description | | ---- | ---- | -- | ----------- | -| fleet_library_app_id | string | body | **Required.** The ID of Fleet library app. | -| team_id | integer | body | **Required**. The team ID. Adds Fleet library app to the specified team. | -| install_script | string | form | Command that Fleet runs to install software. If not specified Fleet runs default install command for each library app. | +| fleet_maintained_app_id | string | body | **Required.** The ID of Fleet maintained app. | +| team_id | integer | body | **Required**. The team ID. Adds Fleet maintained app to the specified team. | +| install_script | string | form | Command that Fleet runs to install software. If not specified Fleet runs default install command for each maintained app. | | pre_install_query | string | form | Query that is pre-install condition. If the query doesn't return any result, Fleet won't proceed to install. | | post_install_script | string | form | 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 | form | Self-service software is optional and can be installed by the end user. | #### Example -`POST /api/v1/fleet/software/fleet_library_apps` +`POST /api/v1/fleet/software/fleet_maintained` ##### Request body ```json { - "fleet_library_app_id": "3", + "fleet_maintained_app_id": "3", "team_id": 2, } ``` From f0aa19edfdbd17e426fa8d1b1bd40c02ddf4d426 Mon Sep 17 00:00:00 2001 From: Marko Lisica <83164494+marko-lisica@users.noreply.github.com> Date: Mon, 9 Sep 2024 11:35:16 +0200 Subject: [PATCH 06/13] Update docs/REST API/rest-api.md Co-authored-by: Noah Talerman <47070608+noahtalerman@users.noreply.github.com> --- docs/REST API/rest-api.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/REST API/rest-api.md b/docs/REST API/rest-api.md index 2aa8bfcbe991..30cc1ae79a32 100644 --- a/docs/REST API/rest-api.md +++ b/docs/REST API/rest-api.md @@ -8485,7 +8485,7 @@ Deletes the session specified by ID. When the user associated with the session n - [Add package](#add-package) - [List App Store apps](#list-app-store-apps) - [Add App Store app](#add-app-store-app) -- [List Fleet maintained apps](#list-fleet-maintained-apps) +- [List Fleet-maintained apps](#list-fleet-maintained-apps) - [Get Fleet maintained app](#get-fleet-maintained-app) - [Add Fleet maintained app](#add-fleet-maintained-app) - [Install package or App Store app](#install-package-or-app-store-app) From 6293fc392f4427e7712ff3bea8ff7c25fd6b4d92 Mon Sep 17 00:00:00 2001 From: Marko Lisica Date: Mon, 9 Sep 2024 11:40:34 +0200 Subject: [PATCH 07/13] Add hyphen to all places mentioning Fleet maintained apps --- docs/REST API/rest-api.md | 26 +++++++++++++------------- 1 file changed, 13 insertions(+), 13 deletions(-) diff --git a/docs/REST API/rest-api.md b/docs/REST API/rest-api.md index 30cc1ae79a32..2b8f78668dd2 100644 --- a/docs/REST API/rest-api.md +++ b/docs/REST API/rest-api.md @@ -8486,8 +8486,8 @@ Deletes the session specified by ID. When the user associated with the session n - [List App Store apps](#list-app-store-apps) - [Add App Store app](#add-app-store-app) - [List Fleet-maintained apps](#list-fleet-maintained-apps) -- [Get Fleet maintained app](#get-fleet-maintained-app) -- [Add Fleet maintained app](#add-fleet-maintained-app) +- [Get Fleet-maintained app](#get-fleet-maintained-app) +- [Add Fleet-maintained app](#add-fleet-maintained-app) - [Install package or App Store app](#install-package-or-app-store-app) - [Get package install result](#get-package-install-result) - [Download package](#download-package) @@ -9141,11 +9141,11 @@ Add App Store (VPP) app purchased in Apple Business Manager. `Status: 200` -### List Fleet maintained apps +### List Fleet-maintained apps > **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. -List available Fleet maintained apps. +List available Fleet-maintained apps. `GET /api/v1/fleet/software/fleet_maintained_apps` @@ -9153,7 +9153,7 @@ List available Fleet maintained apps. | Name | Type | In | Description | | ---- | ---- | -- | ----------- | -| team_id | integer | query | **Required**. The team ID. Filters Fleet maintained apps to only include apps available for the specified team. | +| team_id | integer | query | **Required**. The team ID. Filters Fleet-maintained apps to only include apps available for the specified team. | #### Example @@ -9193,11 +9193,11 @@ List available Fleet maintained apps. } ``` -### Get Fleet maintained app +### Get Fleet-maintained app > **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. -Returns information about the specified Fleet maintained app. +Returns information about the specified Fleet-maintained app. `GET /api/v1/fleet/software/fleet_maintained_apps/:id` @@ -9205,7 +9205,7 @@ Returns information about the specified Fleet maintained app. | Name | Type | In | Description | | ---- | ---- | -- | ----------- | -| id | integer | path | **Required.** The Fleet maintained app's ID. | +| id | integer | path | **Required.** The Fleet-maintained app's ID. | #### Example @@ -9230,13 +9230,13 @@ Returns information about the specified Fleet maintained app. } ``` -### Add Fleet maintained app +### Add Fleet-maintained app > **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. _Available in Fleet Premium._ -Add Fleet maintained app so it's available for install. +Add Fleet-maintained app so it's available for install. `POST /api/v1/fleet/software/fleet_maintained` @@ -9244,9 +9244,9 @@ Add Fleet maintained app so it's available for install. | Name | Type | In | Description | | ---- | ---- | -- | ----------- | -| fleet_maintained_app_id | string | body | **Required.** The ID of Fleet maintained app. | -| team_id | integer | body | **Required**. The team ID. Adds Fleet maintained app to the specified team. | -| install_script | string | form | Command that Fleet runs to install software. If not specified Fleet runs default install command for each maintained app. | +| fleet_maintained_app_id | string | body | **Required.** The ID of Fleet-maintained app. | +| team_id | integer | body | **Required**. The team ID. Adds Fleet-maintained app to the specified team. | +| install_script | string | form | Command that Fleet runs to install software. If not specified Fleet runs default install command for each Fleet-maintained app. | | pre_install_query | string | form | Query that is pre-install condition. If the query doesn't return any result, Fleet won't proceed to install. | | post_install_script | string | form | 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 | form | Self-service software is optional and can be installed by the end user. | From 97b7fb1d4dc99207a1135a324f4badb53a9aacdd Mon Sep 17 00:00:00 2001 From: Marko Lisica Date: Tue, 10 Sep 2024 15:20:14 +0200 Subject: [PATCH 08/13] remove underscore from file_name key --- docs/REST API/rest-api.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/REST API/rest-api.md b/docs/REST API/rest-api.md index 2b8f78668dd2..141b2f4d7a3e 100644 --- a/docs/REST API/rest-api.md +++ b/docs/REST API/rest-api.md @@ -9221,7 +9221,7 @@ Returns information about the specified Fleet-maintained app. "fleet_maintained_app": { "id": 1, "name": "1Password", - "file_name": "1Password-8.10.44-aarch64.zip", + "filename": "1Password-8.10.44-aarch64.zip", "version": "8.10.40", "platform": "darwin", "install_script": "#!/bin/sh\ninstaller -pkg \"$INSTALLER_PATH\" -target /", From e1fda54d9b43b66b8e1d498372e425dff641bf63 Mon Sep 17 00:00:00 2001 From: Marko Lisica Date: Thu, 12 Sep 2024 18:33:02 +0200 Subject: [PATCH 09/13] Update --- docs/REST API/rest-api.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/docs/REST API/rest-api.md b/docs/REST API/rest-api.md index 141b2f4d7a3e..4d636c2a4b7d 100644 --- a/docs/REST API/rest-api.md +++ b/docs/REST API/rest-api.md @@ -9246,10 +9246,10 @@ Add Fleet-maintained app so it's available for install. | ---- | ---- | -- | ----------- | | fleet_maintained_app_id | string | body | **Required.** The ID of Fleet-maintained app. | | team_id | integer | body | **Required**. The team ID. Adds Fleet-maintained app to the specified team. | -| install_script | string | form | Command that Fleet runs to install software. If not specified Fleet runs default install command for each Fleet-maintained app. | -| pre_install_query | string | form | Query that is pre-install condition. If the query doesn't return any result, Fleet won't proceed to install. | -| post_install_script | string | form | 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 | form | Self-service software is optional and can be installed by the end user. | +| install_script | string | body | Command that Fleet runs to install software. If not specified Fleet runs default install command for each Fleet-maintained app. | +| pre_install_query | string | bodybody | Query that is pre-install condition. If the query doesn't return any result, Fleet won't proceed to 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. | #### Example From f41a3b855c6a29622cb211b21e2113c76e04a362 Mon Sep 17 00:00:00 2001 From: Marko Lisica Date: Thu, 12 Sep 2024 19:08:26 +0200 Subject: [PATCH 10/13] Update --- docs/REST API/rest-api.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/docs/REST API/rest-api.md b/docs/REST API/rest-api.md index 4d636c2a4b7d..b76e333e4a8a 100644 --- a/docs/REST API/rest-api.md +++ b/docs/REST API/rest-api.md @@ -9154,6 +9154,8 @@ List available Fleet-maintained apps. | Name | Type | In | Description | | ---- | ---- | -- | ----------- | | team_id | integer | query | **Required**. The team ID. Filters Fleet-maintained apps to only include apps available for the specified team. | +| page | integer | query | Page number of the results to fetch. | +| per_page | integer | query | Results per page. | #### Example From b5063f96269ed32ee8c36d89e8e30cdc2736d2e8 Mon Sep 17 00:00:00 2001 From: Marko Lisica Date: Wed, 18 Sep 2024 14:15:55 +0200 Subject: [PATCH 11/13] Update --- docs/REST API/rest-api.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/REST API/rest-api.md b/docs/REST API/rest-api.md index b76e333e4a8a..bbda89985140 100644 --- a/docs/REST API/rest-api.md +++ b/docs/REST API/rest-api.md @@ -9240,7 +9240,7 @@ _Available in Fleet Premium._ Add Fleet-maintained app so it's available for install. -`POST /api/v1/fleet/software/fleet_maintained` +`POST /api/v1/fleet/software/fleet_maintained_apps` #### Parameters @@ -9249,13 +9249,13 @@ Add Fleet-maintained app so it's available for install. | fleet_maintained_app_id | string | body | **Required.** The ID of Fleet-maintained app. | | team_id | integer | body | **Required**. The team ID. Adds Fleet-maintained app to the specified team. | | install_script | string | body | Command that Fleet runs to install software. If not specified Fleet runs default install command for each Fleet-maintained app. | -| pre_install_query | string | bodybody | Query that is pre-install condition. If the query doesn't return any result, Fleet won't proceed to install. | +| pre_install_query | string | body | Query that is pre-install condition. If the query doesn't return any result, Fleet won't proceed to 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. | #### Example -`POST /api/v1/fleet/software/fleet_maintained` +`POST /api/v1/fleet/software/fleet_maintained_apps` ##### Request body From 46aada247367ac6719d445dd3d25e7f958063bf1 Mon Sep 17 00:00:00 2001 From: Marko Lisica Date: Wed, 18 Sep 2024 14:51:15 +0200 Subject: [PATCH 12/13] Update --- docs/REST API/rest-api.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/REST API/rest-api.md b/docs/REST API/rest-api.md index bbda89985140..19e1e756290a 100644 --- a/docs/REST API/rest-api.md +++ b/docs/REST API/rest-api.md @@ -9261,7 +9261,7 @@ Add Fleet-maintained app so it's available for install. ```json { - "fleet_maintained_app_id": "3", + "fleet_maintained_app_id": 3, "team_id": 2, } ``` From 484446aa67ffa8e315e610058dbabb836c7b4b01 Mon Sep 17 00:00:00 2001 From: Marko Lisica Date: Wed, 18 Sep 2024 14:53:24 +0200 Subject: [PATCH 13/13] Update --- docs/REST API/rest-api.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/docs/REST API/rest-api.md b/docs/REST API/rest-api.md index 19e1e756290a..fc34393ae1be 100644 --- a/docs/REST API/rest-api.md +++ b/docs/REST API/rest-api.md @@ -9170,19 +9170,19 @@ List available Fleet-maintained apps. { "fleet_maintained_apps": [ { - "id": "1", + "id": 1, "name": "1Password", "version": "8.10.40", "platform": "darwin" }, { - "id": "2", + "id": 2, "name": "Adobe Acrobat Reader", "version": "24.002.21005", "platform": "darwin" }, { - "id": "3", + "id": 3, "name": "Box Drive", "version": "2.39.179", "platform": "darwin" @@ -9246,7 +9246,7 @@ Add Fleet-maintained app so it's available for install. | Name | Type | In | Description | | ---- | ---- | -- | ----------- | -| fleet_maintained_app_id | string | body | **Required.** The ID of Fleet-maintained app. | +| fleet_maintained_app_id | integer | body | **Required.** The ID of Fleet-maintained app. | | team_id | integer | body | **Required**. The team ID. Adds Fleet-maintained app to the specified team. | | install_script | string | body | Command that Fleet runs to install software. If not specified Fleet runs default install command for each Fleet-maintained app. | | pre_install_query | string | body | Query that is pre-install condition. If the query doesn't return any result, Fleet won't proceed to install. |