From 7ab54e65d6a0180d19348a52168e29eddf367c1f Mon Sep 17 00:00:00 2001 From: nulmete Date: Thu, 13 Aug 2026 10:07:43 -0300 Subject: [PATCH] Document that host lists are rejected for dynamic labels The modify label parameter reference implied hosts/host_ids were manual-label only without saying what happens if they are sent for a dynamic label. State that both are rejected, including when the list is empty. --- docs/REST API/rest-api.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/docs/REST API/rest-api.md b/docs/REST API/rest-api.md index 0913116c6d3..879d4df0daf 100644 --- a/docs/REST API/rest-api.md +++ b/docs/REST API/rest-api.md @@ -6475,6 +6475,8 @@ Updates the specified label. Note: Label queries, platforms, and fleets are immu | hosts | array | body | If updating a manual label: the list of host identifiers (`hardware_serial` or `uuid`). The label will apply to any host with a matching identifier. 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. +`hosts` and `host_ids` can only be used to update a manual label. Including either one when updating a dynamic label returns an error, even if the list is empty. + The `hostname` host identifier is deprecated. Please use `host_ids`, `hardware_serial`, or `uuid` instead. #### Example