Skip to content

Commit

Permalink
Remove docs for #23241 (Include host data in lock/wipe responses) (#2…
Browse files Browse the repository at this point in the history
…3934)

#23241 is no longer planned for the v4.61.0 release (didn't make it into
the sprint)
  • Loading branch information
rachaelshaw authored Nov 18, 2024
1 parent 6c5400f commit 0e22a7c
Showing 1 changed file with 5 additions and 36 deletions.
41 changes: 5 additions & 36 deletions docs/REST API/rest-api.md
Original file line number Diff line number Diff line change
Expand Up @@ -4585,14 +4585,8 @@ To lock a macOS host, the host must have MDM turned on. To lock a Windows or Lin

##### Default response

`Status: 200`
`Status: 204`

```json
{
"device_status": "unlocked",
"pending_action": "lock"
}
```

#### Example

Expand All @@ -4604,15 +4598,10 @@ To lock a macOS host, the host must have MDM turned on. To lock a Windows or Lin

```json
{
"unlock_pin": "123456",
"device_status": "unlocked",
"pending_action": "lock",
"unlock_pin": "123456"
}
```


> To verify the host successfully locked, you can use the [Get host](https://fleetdm.com/docs/rest-api/rest-api#get-host) endpoint to retrieve the host's `mdm.device_status`.
### Unlock host

_Available in Fleet Premium_
Expand All @@ -4635,30 +4624,19 @@ To unlock a Windows or Linux host, the host must have [scripts enabled](https://

##### Default response (Windows or Linux hosts)

`Status: 200`
`Status: 204`

```json
{
"device_status": "locked",
"pending_action": "unlock"
}
```

##### Default response (macOS hosts)

`Status: 200`

```json
{
"host_id": 8,
"unlock_pin": "123456",
"device_status": "locked",
"pending_action": ""
"host_id": 8
}
```

> To verify the host successfully unlocked, you can use the [Get host](https://fleetdm.com/docs/rest-api/rest-api#get-host) endpoint to retrieve the host's `mdm.device_status`.
### Wipe host

Sends a command to wipe the specified macOS, iOS, iPadOS, Windows, or Linux host. The host is wiped once it comes online.
Expand All @@ -4679,16 +4657,7 @@ To wipe a macOS, iOS, iPadOS, or Windows host, the host must have MDM turned on.

##### Default response

`Status: 200`

```json
{
"device_status": "unlocked",
"pending_action": "wipe"
}
```

> To verify the host was successfully wiped, you can use the [Get host](https://fleetdm.com/docs/rest-api/rest-api#get-host) endpoint to retrieve the host's `mdm.device_status`.
`Status: 204`


### Get host's past activity
Expand Down

0 comments on commit 0e22a7c

Please sign in to comment.