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.

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

4.61 documentation changes #24833

Merged
merged 28 commits into from
Dec 17, 2024
Merged
Changes from 1 commit
Commits
Show all changes
28 commits
Select commit Hold shift + click to select a range
3dbb0e9
#23314 docs changes (#23375)
rachaelshaw Oct 29, 2024
9e92ba6
#23241 API design: Include host data in lock/wipe responses (#23374)
rachaelshaw Oct 31, 2024
3c18929
Merge branch 'main' into docs-v4.61.0
rachaelshaw Nov 1, 2024
dfd80c9
Merge branch 'main' into docs-v4.61.0
rachaelshaw Nov 4, 2024
d20fca9
Add `numQueries` to usage stats docs (#23463)
rachaelshaw Nov 4, 2024
7a31b39
Merge branch 'main' into docs-v4.61.0
rachaelshaw Nov 7, 2024
61550c8
Merge branch 'main' into docs-v4.61.0
rachaelshaw Nov 8, 2024
1d29521
Merge branch 'main' into docs-v4.61.0
rachaelshaw Nov 11, 2024
02e8c4e
Merge branch 'main' into docs-v4.61.0
rachaelshaw Nov 11, 2024
c6f57b5
Merge branch 'main' into docs-v4.61.0
rachaelshaw Nov 11, 2024
b4fb04f
Merge branch 'main' into docs-v4.61.0
rachaelshaw Nov 14, 2024
6c5400f
Merge branch 'main' into docs-v4.61.0
rachaelshaw Nov 18, 2024
0e22a7c
Remove docs for #23241 (Include host data in lock/wipe responses) (#2…
rachaelshaw Nov 18, 2024
fd6ee7f
REST API changes for #23239 (#23635)
rachaelshaw Nov 26, 2024
c28e84e
Merge branch 'main' into docs-v4.61.0
rachaelshaw Dec 2, 2024
2a3931c
#21795 API design (#24233)
iansltx Dec 4, 2024
fd4de13
Add documentation for authenticated deployment of YARA rules (#24015)
zwass Dec 5, 2024
285ea1e
Updated docs around new label(s) validation (#24049)
ksykulev Dec 5, 2024
42aa660
Document new without_vulnerability_details option for software versio…
ksykulev Dec 5, 2024
e3bfdb8
Update API docs for MFA support (#24168)
iansltx Dec 6, 2024
f152c35
Merge branch 'main' into docs-v4.61.0
rachaelshaw Dec 11, 2024
7d188d1
Merge branch 'main' into docs-v4.61.0
rachaelshaw Dec 11, 2024
1448c18
Team ID is no longer required on FMA list endpoint (#24597)
iansltx Dec 12, 2024
1211a29
[API design] Create policies automatically for Fleet-maintained apps …
marko-lisica Dec 12, 2024
2ee27ba
Merge branch 'main' into docs-v4.61.0
rachaelshaw Dec 12, 2024
ed8c0c9
Update docs/guides to reference MFA (#24689)
iansltx Dec 12, 2024
4f1442d
Merge branch 'main' into docs-v4.61.0
rachaelshaw Dec 17, 2024
9b1394d
Update docs/REST API/rest-api.md
rachaelshaw Dec 17, 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
Prev Previous commit
Next Next commit
Remove docs for #23241 (Include host data in lock/wipe responses) (#2…
…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
commit 0e22a7ccf59a53ccdbc34b4846347c259c8b8f99
41 changes: 5 additions & 36 deletions docs/REST API/rest-api.md
Original file line number Diff line number Diff line change
@@ -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

@@ -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_
@@ -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
rachaelshaw marked this conversation as resolved.
Show resolved Hide resolved
}
```

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