Docs: Update get host example (#25310)

+ Update "Get host" example response to be a macOS host (in advance of API design for #23235, since certificates will be available for macOS/iOS/iPadOS) + Update formatting of "Get host by identifier" to move weightier items to the bottom
fleetdm · Jan 9, 2025 · d1a564e · d1a564e
1 parent 52fbb23
commit d1a564e
Showing 1 changed file with 58 additions and 80 deletions.
diff --git a/docs/REST API/rest-api.md b/docs/REST API/rest-api.md
@@ -2267,41 +2267,41 @@ If `after` is being used with `created_at` or `updated_at`, the table must be sp
       "policy_updated_at": "2023-06-26T18:33:15Z",
       "last_enrolled_at": "2023-02-26T22:33:12Z",
       "seen_time": "2020-11-05T06:03:39Z",
-      "hostname": "2ceca32fe484",
+      "hostname": "Annas-MacBook-Pro.local",
       "uuid": "392547dc-0000-0000-a87a-d701ff75bc65",
-      "platform": "centos",
-      "osquery_version": "2.7.0",
-      "os_version": "CentOS Linux 7",
-      "build": "",
-      "platform_like": "rhel fedora",
+      "platform": "darwin",
+      "osquery_version": "5.15.0",
+      "os_version": "macOS 15.2",
+      "build": "24C101",
+      "platform_like": "darwin",
       "code_name": "",
       "uptime": 8305000000000,
       "memory": 2084032512,
-      "cpu_type": "6",
-      "cpu_subtype": "142",
-      "cpu_brand": "Intel(R) Core(TM) i5-8279U CPU @ 2.40GHz",
-      "cpu_physical_cores": 4,
-      "cpu_logical_cores": 4,
-      "hardware_vendor": "",
-      "hardware_model": "",
+      "cpu_type": "arm64e",
+      "cpu_subtype": "ARM64E",
+      "cpu_brand": "Apple M1",
+      "cpu_physical_cores": 8,
+      "cpu_logical_cores": 8,
+      "hardware_vendor": "Apple Inc.",
+      "hardware_model": "MacBookPro17,1",
       "hardware_version": "",
-      "hardware_serial": "",
-      "computer_name": "2ceca32fe484",
-      "display_name": "2ceca32fe484",
-      "public_ip": "",
-      "primary_ip": "",
-      "primary_mac": "",
+      "hardware_serial": "C0124FXASD6G",
+      "computer_name": "Anna's MacBook Pro",
+      "display_name": "Anna's MacBook Pro",
+      "public_ip": "123.45.678.910",
+      "primary_ip": "192.12.345.678",
+      "primary_mac": "36:34:a5:6b:7b:5c",
       "distributed_interval": 10,
       "config_tls_refresh": 10,
       "logger_tls_period": 8,
-      "additional": {},
       "status": "offline",
-      "display_text": "2ceca32fe484",
+      "display_text": "Annas-MacBook-Pro.local",
       "team_id": null,
       "team_name": null,
       "gigs_disk_space_available": 174.98,
       "percent_disk_space_available": 71,
       "gigs_total_disk_space": 246,
+      "additional": {},
       "pack_stats": [
         {
           "pack_id": 0,
@@ -2684,9 +2684,9 @@ Returns the information of the specified host.
     "status": "online",
     "display_text": "23cfc9caacf0",
     "issues": {
-        "failing_policies_count": 1,
-        "critical_vulnerabilities_count": 2, // Available in Fleet Premium
-        "total_issues_count": 3
+      "failing_policies_count": 1,
+      "critical_vulnerabilities_count": 2, // Available in Fleet Premium
+      "total_issues_count": 3
     },
     "batteries": [
       {
@@ -2791,25 +2791,6 @@ Returns the information of the specified host.
       }
     ],
     "software": [
-      {
-        "id": 408,
-        "name": "osquery",
-        "version": "4.5.1",
-        "source": "rpm_packages",
-        "browser": "",
-        "generated_cpe": "",
-        "vulnerabilities": null,
-        "installed_paths": ["/usr/lib/some-path-1"]
-      },
-      {
-        "id": 1146,
-        "name": "tar",
-        "version": "1.30",
-        "source": "rpm_packages",
-        "browser": "",
-        "generated_cpe": "",
-        "vulnerabilities": null
-      },
       {
         "id": 321,
         "name": "SomeApp.app",
@@ -2832,7 +2813,7 @@ Returns the information of the specified host.
       "device_status": "unlocked",
       "pending_action": "",
       "macos_settings": {
-        "disk_encryption": null,
+        "disk_encryption": "verified",
         "action_required": null
       },
       "macos_setup": {
@@ -2842,7 +2823,7 @@ Returns the information of the specified host.
       },
       "os_settings": {
         "disk_encryption": {
-          "status": null,
+          "status": "verified",
           "detail": ""
         }
       },
@@ -2900,18 +2881,6 @@ If `hostname` is specified when there is more than one host with the same hostna
   "host": {
     "created_at": "2022-02-10T02:29:13Z",
     "updated_at": "2022-10-14T17:07:11Z",
-    "software": [
-      {
-        "id": 16923,
-        "name": "Automat",
-        "version": "0.8.0",
-        "source": "python_packages",
-        "browser": "",
-        "generated_cpe": "",
-        "vulnerabilities": null,
-        "installed_paths": ["/usr/lib/some_path/"]
-      }
-    ],
     "id": 33,
     "detail_updated_at": "2022-10-14T17:07:12Z",
     "label_updated_at": "2022-10-14T17:07:12Z",
@@ -2947,6 +2916,29 @@ If `hostname` is specified when there is more than one host with the same hostna
     "config_tls_refresh": 60,
     "logger_tls_period": 10,
     "team_id": 2,
+    "team_name": null,
+    "gigs_disk_space_available": 19.29,
+    "percent_disk_space_available": 74,
+    "gigs_total_disk_space": 192,
+    "issues": {
+      "failing_policies_count": 1,
+      "critical_vulnerabilities_count": 2, // Fleet Premium only
+      "total_issues_count": 3
+    },
+    "batteries": [
+      {
+        "cycle_count": 999,
+        "health": "Normal"
+      }
+    ],
+    "geolocation": {
+      "country_iso": "US",
+      "city_name": "New York",
+      "geometry": {
+        "type": "point",
+        "coordinates": [40.6799, -74.0028]
+      }
+    },
     "pack_stats": [
       {
         "pack_id": 1,
@@ -2972,15 +2964,6 @@ If `hostname` is specified when there is more than one host with the same hostna
         ]
       }
     ],
-    "team_name": null,
-    "gigs_disk_space_available": 19.29,
-    "percent_disk_space_available": 74,
-    "gigs_total_disk_space": 192,
-    "issues": {
-        "failing_policies_count": 1,
-        "critical_vulnerabilities_count": 2, // Fleet Premium only
-        "total_issues_count": 3
-    },
     "labels": [
       {
         "created_at": "2021-09-14T05:11:02Z",
@@ -3029,23 +3012,18 @@ If `hostname` is specified when there is more than one host with the same hostna
         "critical": false
       }
     ],
-    "batteries": [
+    "software": [
       {
-        "cycle_count": 999,
-        "health": "Normal"
+        "id": 16923,
+        "name": "Automat",
+        "version": "0.8.0",
+        "source": "python_packages",
+        "browser": "",
+        "generated_cpe": "",
+        "vulnerabilities": null,
+        "installed_paths": ["/usr/lib/some_path/"]
       }
     ],
-    "geolocation": {
-      "country_iso": "US",
-      "city_name": "New York",
-      "geometry": {
-        "type": "point",
-        "coordinates": [40.6799, -74.0028]
-      }
-    },
-    "status": "online",
-    "display_text": "dogfood-ubuntu-box",
-    "display_name": "dogfood-ubuntu-box",
     "mdm": {
       "encryption_key_available": false,
       "enrollment_status": null,