From 249189fc0cc21860486cae1d3f6df2195937c254 Mon Sep 17 00:00:00 2001 From: Rachael Shaw Date: Mon, 18 Nov 2024 18:08:55 -0600 Subject: [PATCH] Remove docs for #22464 (#23936) Missed this one when updating v4.59 docs branch: #22464 is still on the drafting board. --- docs/REST API/rest-api.md | 55 +-------------------------------------- 1 file changed, 1 insertion(+), 54 deletions(-) diff --git a/docs/REST API/rest-api.md b/docs/REST API/rest-api.md index 3d19833e02..579dd9772d 100644 --- a/docs/REST API/rest-api.md +++ b/docs/REST API/rest-api.md @@ -2545,8 +2545,6 @@ the `software` table. | os_settings_disk_encryption | string | query | Filters the hosts by the status of the disk encryption setting applied to the hosts. Valid options are 'verified', 'verifying', 'action_required', 'enforcing', 'failed', or 'removing_enforcement'. **Note: If this filter is used in Fleet Premium without a team ID filter, the results include only hosts that are not assigned to any team.** | | populate_software | boolean | query | If `true`, the response will include a list of installed software for each host, including vulnerability data. (Note that software lists can be large, so this may cause significant CPU and RAM usage depending on page size and request concurrency.) | | populate_policies | boolean | query | If `true`, the response will include policy data for each host. | -| populate_users | boolean | query | If `true`, the response will include user data for each host. | -| populate_labels | boolean | query | If `true`, the response will include labels for each host. | > `software_id` is deprecated as of Fleet 4.42. It is maintained for backwards compatibility. Please use the `software_version_id` instead. @@ -2566,7 +2564,7 @@ If `after` is being used with `created_at` or `updated_at`, the table must be sp #### Example -`GET /api/v1/fleet/hosts?page=0&per_page=100&order_key=hostname&query=2ce&populate_software=true&populate_policies=true&populate_users=true&populate_labels=true` +`GET /api/v1/fleet/hosts?page=0&per_page=100&order_key=hostname&query=2ce&populate_software=true&populate_policies=true` ##### Request query parameters @@ -2712,57 +2710,6 @@ If `after` is being used with `created_at` or `updated_at`, the table must be sp "response": "fail", "critical": false } - ], - "users": [ - { - "uid": 0, - "username": "root", - "type": "", - "groupname": "root", - "shell": "/bin/bash" - }, - { - "uid": 1, - "username": "bin", - "type": "", - "groupname": "bin", - "shell": "/sbin/nologin" - } - ], - "labels": [ - { - "created_at": "2021-08-19T02:02:17Z", - "updated_at": "2021-08-19T02:02:17Z", - "id": 6, - "name": "All Hosts", - "description": "All hosts which have enrolled in Fleet", - "query": "SELECT 1;", - "platform": "", - "label_type": "builtin", - "label_membership_type": "dynamic" - }, - { - "created_at": "2021-08-19T02:02:17Z", - "updated_at": "2021-08-19T02:02:17Z", - "id": 9, - "name": "CentOS Linux", - "description": "All CentOS hosts", - "query": "SELECT 1 FROM os_version WHERE platform = 'centos' OR name LIKE '%centos%'", - "platform": "", - "label_type": "builtin", - "label_membership_type": "dynamic" - }, - { - "created_at": "2021-08-19T02:02:17Z", - "updated_at": "2021-08-19T02:02:17Z", - "id": 12, - "name": "All Linux", - "description": "All Linux distributions", - "query": "SELECT 1 FROM osquery_info WHERE build_platform LIKE '%ubuntu%' OR build_distro LIKE '%centos%';", - "platform": "", - "label_type": "builtin", - "label_membership_type": "dynamic" - } ] } ]