Discharge7443/fleet
1
0
Fork 0
Code Issues Pull Requests Actions 5 Packages Projects Releases Wiki Activity

Fix docs to refer to "hash_sha256" as field name on software packages (#31175)

Browse Source 
This matches the implementation (and a version of the spec that I
thought got merged).
This commit is contained in:
Ian Littman
2025-07-29 17:24:41 -05:00
committed by GitHub
parent fd3baa5732
commit beba3278d9
1 changed files with 11 additions and 11 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/REST API/rest-api.md
+11 -11
View File
@@ -2835,7 +2835,7 @@ Returns the information of the specified host.
"policy_updated_at": "2023-06-26T18:33:15Z",
"last_enrolled_at": "2021-08-19T02:02:22Z",
"last_mdm_checked_in_at": "2023-02-26T22:33:12Z",
"last_mdm_enrolled_at": "2023-02-26T22:33:12Z",
"last_mdm_enrolled_at": "2023-02-26T22:33:12Z",
"seen_time": "2021-08-19T21:14:58Z",
"refetch_requested": false,
"hostname": "Annas-MacBook-Pro.local",
@@ -3111,7 +3111,7 @@ If `hostname` is specified when there is more than one host with the same hostna
"policy_updated_at": "2022-10-14T17:07:12Z",
"last_enrolled_at": "2022-02-10T02:29:13Z",
"last_mdm_checked_in_at": "2023-02-26T22:33:12Z",
"last_mdm_enrolled_at": "2023-02-26T22:33:12Z",
"last_mdm_enrolled_at": "2023-02-26T22:33:12Z",
"software_updated_at": "2020-11-05T05:09:44Z",
"seen_time": "2022-10-14T17:45:41Z",
"refetch_requested": false,
@@ -3322,7 +3322,7 @@ This is the API route used by the **My device** page in Fleet desktop to display
"label_updated_at": "2021-08-19T21:07:53Z",
"last_enrolled_at": "2021-08-19T02:02:22Z",
"last_mdm_checked_in_at": "2023-02-26T22:33:12Z",
"last_mdm_enrolled_at": "2023-02-26T22:33:12Z",
"last_mdm_enrolled_at": "2023-02-26T22:33:12Z",
"seen_time": "2021-08-19T21:14:58Z",
"refetch_requested": false,
"hostname": "Annas-MacBook-Pro.local",
@@ -4900,7 +4900,7 @@ Updates the specified label. Note: Label queries and platforms are immutable. To
| name | string | body | The label's name. |
| description | string | body | The label's description. |
| hosts | array | body | If updating a manual label: the list of host identifiers (`hardware_serial`, `uuid`, or `hostname`) the label will apply to. The provided list fully replaces the previous list. Only one of either `hosts` or `host_ids` can be included in the request. |
| host_ids | array | body | If updating a manual label: the list of Fleet host IDs the label will apply to. The provided list fully replaces the previous list. Only one of either `hosts` or `host_ids` can be included in the request.
| host_ids | array | body | If updating a manual label: the list of Fleet host IDs the label will apply to. The provided list fully replaces the previous list. Only one of either `hosts` or `host_ids` can be included in the request.
@@ -8941,7 +8941,7 @@ The script will be added to each host's list of upcoming activities.
| query | string | Search query keywords. Searchable fields include `hostname`, `hardware_serial`, `uuid`, and `ipv4`. |
| status | string | Host status. Can either be `new`, `online`, `offline`, `mia` or `missing`. |
| label_id | number | ID of a label to filter by. |
| team_id | number | ID of the team to filter by. |
| team_id | number | ID of the team to filter by. |
#### Example
@@ -9716,7 +9716,7 @@ Returns information about the specified software. By default, `versions` are sor
"installer_id": 23,
"team_id": 3,
"uploaded_at": "2024-04-01T14:22:58Z",
"sha256": "0123456789abcdef0123456789abcdef0123456789abcdef0123456789abcdef",
"hash_sha256": "0123456789abcdef0123456789abcdef0123456789abcdef0123456789abcdef",
"install_script": "sudo installer -pkg '$INSTALLER_PATH' -target /",
"pre_install_query": "SELECT 1 FROM macos_profiles WHERE uuid='c9f4f0d5-8426-4eb8-b61b-27c543c9d3db';",
"post_install_script": "sudo /Applications/Falcon.app/Contents/Resources/falconctl license 0123456789ABCDEFGHIJKLMNOPQRSTUV-WX",
@@ -9807,7 +9807,7 @@ Returns information about the specified software. By default, `versions` are sor
"id": 345,
"name": "[Install software] Logic Pro",
"fleet_maintained": false
}
}
],
"status": {
"installed": 3,
@@ -10028,7 +10028,7 @@ Content-Type: application/octet-stream
"installer_id": 23,
"team_id": 3,
"uploaded_at": "2024-04-01T14:22:58Z",
"sha256": "0123456789abcdef0123456789abcdef0123456789abcdef0123456789abcdef",
"hash_sha256": "0123456789abcdef0123456789abcdef0123456789abcdef0123456789abcdef",
"install_script": "sudo installer -pkg /temp/FalconSensor-6.44.pkg -target /",
"pre_install_query": "SELECT 1 FROM macos_profiles WHERE uuid='c9f4f0d5-8426-4eb8-b61b-27c543c9d3db';",
"post_install_script": "sudo /Applications/Falcon.app/Contents/Resources/falconctl license 0123456789ABCDEFGHIJKLMNOPQRSTUV-WX",
@@ -10126,7 +10126,7 @@ Content-Type: application/octet-stream
"installer_id": 23,
"team_id": 3,
"uploaded_at": "2024-04-01T14:22:58Z",
"sha256": "0123456789abcdef0123456789abcdef0123456789abcdef0123456789abcdef",
"hash_sha256": "0123456789abcdef0123456789abcdef0123456789abcdef0123456789abcdef",
"install_script": "sudo installer -pkg /temp/FalconSensor-6.44.pkg -target /",
"pre_install_query": "SELECT 1 FROM macos_profiles WHERE uuid='c9f4f0d5-8426-4eb8-b61b-27c543c9d3db';",
"post_install_script": "sudo /Applications/Falcon.app/Contents/Resources/falconctl license 0123456789ABCDEFGHIJKLMNOPQRSTUV-WX",
@@ -10308,7 +10308,7 @@ Only one of `labels_include_any` or `labels_exclude_any` can be specified. If ne
"id": 345,
"name": "[Install software] Logic Pro",
"fleet_maintained": false
}
}
],
"status": {
"installed": 3,
@@ -11489,7 +11489,7 @@ _Available in Fleet Premium_
| Name | Type | Description |
| --------------------- | ------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| enable_disk_encryption | boolean | Hosts that belong to this team will have disk encryption enabled if set to true. |
| enable_disk_encryption | boolean | Hosts that belong to this team will have disk encryption enabled if set to true. |
| custom_settings | array | Only intended to be used by [Fleet's YAML](https://fleetdm.com/docs/configuration/yaml-files). To add macOS configuration profiles using Fleet's API, use the [Add configuration profile endpoint](https://fleetdm.com/docs/rest-api/rest-api#add-custom-os-setting-configuration-profile) instead. |
<br/>