Skip to content

Commit 9e6b563

Browse files
committed
Changes related to 'Fleet app library' -> 'Fleet-maintaned apps'
1 parent b2de7fa commit 9e6b563

File tree

1 file changed

+23
-23
lines changed

1 file changed

+23
-23
lines changed

docs/REST API/rest-api.md

Lines changed: 23 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -8485,9 +8485,9 @@ Deletes the session specified by ID. When the user associated with the session n
84858485
- [Add package](#add-package)
84868486
- [List App Store apps](#list-app-store-apps)
84878487
- [Add App Store app](#add-app-store-app)
8488-
- [List Fleet library apps](#list-fleet-library-apps)
8489-
- [Get Fleet library app](#get-fleet-library-app)
8490-
- [Add Fleet library app](#add-fleet-library-app)
8488+
- [List Fleet maintained apps](#list-fleet-maintained-apps)
8489+
- [Get Fleet maintained app](#get-fleet-maintained-app)
8490+
- [Add Fleet maintained app](#add-fleet-maintained-app)
84918491
- [Install package or App Store app](#install-package-or-app-store-app)
84928492
- [Get package install result](#get-package-install-result)
84938493
- [Download package](#download-package)
@@ -9141,23 +9141,23 @@ Add App Store (VPP) app purchased in Apple Business Manager.
91419141

91429142
`Status: 200`
91439143

9144-
### List Fleet library apps
9144+
### List Fleet maintained apps
91459145

91469146
> **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.
91479147
9148-
List available Fleet library apps.
9148+
List available Fleet maintained apps.
91499149

9150-
`GET /api/v1/fleet/software/fleet_library_apps`
9150+
`GET /api/v1/fleet/software/fleet_maintained_apps`
91519151

91529152
#### Parameters
91539153

91549154
| Name | Type | In | Description |
91559155
| ---- | ---- | -- | ----------- |
9156-
| team_id | integer | query | **Required**. The team ID. Filters Fleet library apps to only include apps available for the specified team. |
9156+
| team_id | integer | query | **Required**. The team ID. Filters Fleet maintained apps to only include apps available for the specified team. |
91579157

91589158
#### Example
91599159

9160-
`GET /api/v1/fleet/software/fleet_library_apps?team_id=3`
9160+
`GET /api/v1/fleet/software/fleet_maintained_apps?team_id=3`
91619161

91629162

91639163
##### Default response
@@ -9166,7 +9166,7 @@ List available Fleet library apps.
91669166

91679167
```json
91689168
{
9169-
"fleet_library_apps": [
9169+
"fleet_maintained_apps": [
91709170
{
91719171
"id": "1",
91729172
"name": "1Password",
@@ -9193,32 +9193,32 @@ List available Fleet library apps.
91939193
}
91949194
```
91959195

9196-
### Get Fleet library app
9196+
### Get Fleet maintained app
91979197

91989198
> **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.
91999199
9200-
Returns information about the specified Fleet library app.
9200+
Returns information about the specified Fleet maintained app.
92019201

9202-
`GET /api/v1/fleet/software/fleet_library_apps/:id`
9202+
`GET /api/v1/fleet/software/fleet_maintained_apps/:id`
92039203

92049204
#### Parameters
92059205

92069206
| Name | Type | In | Description |
92079207
| ---- | ---- | -- | ----------- |
9208-
| id | integer | path | **Required.** The Fleet library app's ID. |
9208+
| id | integer | path | **Required.** The Fleet maintained app's ID. |
92099209

92109210

92119211
#### Example
92129212

9213-
`GET /api/v1/fleet/software/fleet_library_apps/1`
9213+
`GET /api/v1/fleet/software/fleet_maintained_apps/1`
92149214

92159215
##### Default response
92169216

92179217
`Status: 200`
92189218

92199219
```json
92209220
{
9221-
"fleet_library_app": {
9221+
"fleet_maintained_app": {
92229222
"id": 1,
92239223
"name": "1Password",
92249224
"file_name": "1Password-8.10.44-aarch64.zip",
@@ -9230,36 +9230,36 @@ Returns information about the specified Fleet library app.
92309230
}
92319231
```
92329232

9233-
### Add Fleet library app
9233+
### Add Fleet maintained app
92349234

92359235
> **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.
92369236
92379237
_Available in Fleet Premium._
92389238

9239-
Add app from Fleet library.
9239+
Add Fleet maintained app so it's available for install.
92409240

9241-
`POST /api/v1/fleet/software/fleet_library_apps`
9241+
`POST /api/v1/fleet/software/fleet_maintained`
92429242

92439243
#### Parameters
92449244

92459245
| Name | Type | In | Description |
92469246
| ---- | ---- | -- | ----------- |
9247-
| fleet_library_app_id | string | body | **Required.** The ID of Fleet library app. |
9248-
| team_id | integer | body | **Required**. The team ID. Adds Fleet library app to the specified team. |
9249-
| install_script | string | form | Command that Fleet runs to install software. If not specified Fleet runs default install command for each library app. |
9247+
| fleet_maintained_app_id | string | body | **Required.** The ID of Fleet maintained app. |
9248+
| team_id | integer | body | **Required**. The team ID. Adds Fleet maintained app to the specified team. |
9249+
| install_script | string | form | Command that Fleet runs to install software. If not specified Fleet runs default install command for each maintained app. |
92509250
| 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. |
92519251
| 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. |
92529252
| self_service | boolean | form | Self-service software is optional and can be installed by the end user. |
92539253

92549254
#### Example
92559255

9256-
`POST /api/v1/fleet/software/fleet_library_apps`
9256+
`POST /api/v1/fleet/software/fleet_maintained`
92579257

92589258
##### Request body
92599259

92609260
```json
92619261
{
9262-
"fleet_library_app_id": "3",
9262+
"fleet_maintained_app_id": "3",
92639263
"team_id": 2,
92649264
}
92659265
```

0 commit comments

Comments
 (0)