Skip to content

Commit

Permalink
#22075 API docs (revised) (#22420)
Browse files Browse the repository at this point in the history
Updated API docs for #22075
  • Loading branch information
rachaelshaw authored Sep 26, 2024
1 parent 331078d commit 0bbb9a7
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 27 deletions.
9 changes: 1 addition & 8 deletions docs/Configuration/yaml-files.md
Original file line number Diff line number Diff line change
Expand Up @@ -261,8 +261,7 @@ controls:
enable: true
mode: voluntary
webhook_url: https://example.org/webhook_handler
windows_migration: # Available in Fleet Premium
enable: true
windows_migration_enabled: true # Available in Fleet Premium
# paths are relative to default.yml or teams/team-name.yml
```

Expand Down Expand Up @@ -313,12 +312,6 @@ The `macos_migration` section lets you control the [end user migration workflow]

Can only be configured for all teams (`default.yml`).

#### windows_migration

The `windows_migration` section lets you control migration for Windows hosts that enrolled to your old MDM solution.

- `enable` specifies whether or not to enable automatic migration for Windows hosts with fleetd (default: `false`)

### software

> **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
23 changes: 4 additions & 19 deletions docs/REST API/rest-api.md
Original file line number Diff line number Diff line change
Expand Up @@ -941,6 +941,7 @@ None.
"mode": "voluntary",
"webhook_url": "https://webhook.example.com"
},
"windows_migration_enabled": false,
"macos_setup": {
"bootstrap_package": "",
"enable_end_user_authentication": false,
Expand Down Expand Up @@ -1234,9 +1235,7 @@ Modifies the Fleet's configuration with the supplied information.
"mode": "voluntary",
"webhook_url": "https://webhook.example.com"
},
"windows_migration": {
"enable": false
},
"windows_migration_enabled": false,
"macos_setup": {
"bootstrap_package": "",
"enable_end_user_authentication": false,
Expand Down Expand Up @@ -1714,7 +1713,7 @@ _Available in Fleet Premium._
| ipados_updates | object | See [`mdm.ipados_updates`](#mdm-ipados-updates). |
| windows_updates | object | See [`mdm.window_updates`](#mdm-windows-updates). |
| macos_migration | object | See [`mdm.macos_migration`](#mdm-macos-migration). |
| windows_migration | object | See [`mdm.windows_migration`](#mdm-windows-migration). |
| windows_migration_enabled | boolean | Whether to enable automatic migration via fleetd for devices migrating from your old MDM solution. |
| macos_setup | object | See [`mdm.macos_setup`](#mdm-macos-setup). |
| macos_settings | object | See [`mdm.macos_settings`](#mdm-macos-settings). |
| windows_settings | object | See [`mdm.windows_settings`](#mdm-windows-settings). |
Expand Down Expand Up @@ -1787,18 +1786,6 @@ _Available in Fleet Premium._

<br/>

##### mdm.windows_migration

_Available in Fleet Premium._

`mdm.windows_migration` is an object with the following structure:

| Name | Type | Description |
| --------------------- | ------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| enable | boolean | Whether to enable automatic migration via fleetd for devices migrating from your old MDM solution. |

<br/>

##### mdm.macos_setup

_Available in Fleet Premium._
Expand Down Expand Up @@ -1878,9 +1865,7 @@ _Available in Fleet Premium._
"mode": "voluntary",
"webhook_url": "https://webhook.example.com"
},
"windows_migration": {
"enable": false
},
"windows_migration_enabled": false,
"macos_setup": {
"bootstrap_package": "",
"enable_end_user_authentication": false,
Expand Down

0 comments on commit 0bbb9a7

Please sign in to comment.