From c952d71c2b14b0c9323ce5dfc367b2c5a6a1cd05 Mon Sep 17 00:00:00 2001 From: Ian Littman Date: Sat, 28 Sep 2024 18:20:18 -0500 Subject: [PATCH] Clarify how to remove software installer and script run automations for a policy #17129 "null" won't do it due to disambiguation issues on the backend between "they omitted the field when PATCHing" and "they provided a null value when PATCHing". --- docs/REST API/rest-api.md | 24 ++++++++++++------------ 1 file changed, 12 insertions(+), 12 deletions(-) diff --git a/docs/REST API/rest-api.md b/docs/REST API/rest-api.md index e35be8b76e29..0e1bcc5a16a5 100644 --- a/docs/REST API/rest-api.md +++ b/docs/REST API/rest-api.md @@ -7202,19 +7202,19 @@ Either `query` or `query_id` must be provided. #### Parameters -| Name | Type | In | Description | -|-------------------------| ------- | ---- | ------------------------------------ | -| team_id | integer | path | The team's ID. | -| policy_id | integer | path | The policy's ID. | -| name | string | body | The query's name. | -| query | string | body | The query in SQL. | -| description | string | body | The query's description. | -| resolution | string | body | The resolution steps for the policy. | +| Name | Type | In | Description | +|-------------------------| ------- | ---- |---------------------------------------------------------------------------------------------------------------------------------------------------------| +| team_id | integer | path | The team's ID. | +| policy_id | integer | path | The policy's ID. | +| name | string | body | The query's name. | +| query | string | body | The query in SQL. | +| description | string | body | The query's description. | +| resolution | string | body | The resolution steps for the policy. | | platform | string | body | Comma-separated target platforms, currently supported values are "windows", "linux", "darwin". The default, an empty string means target all platforms. | -| critical | boolean | body | _Available in Fleet Premium_. Mark policy as critical/high impact. | -| calendar_events_enabled | boolean | body | _Available in Fleet Premium_. Whether to trigger calendar events when policy is failing. | -| software_title_id | integer | body | _Available in Fleet Premium_. ID of software title to install if the policy fails. | -| script_id | integer | body | _Available in Fleet Premium_. ID of script to run if the policy fails. | +| critical | boolean | body | _Available in Fleet Premium_. Mark policy as critical/high impact. | +| calendar_events_enabled | boolean | body | _Available in Fleet Premium_. Whether to trigger calendar events when policy is failing. | +| software_title_id | integer | body | _Available in Fleet Premium_. ID of software title to install if the policy fails. Set to 0 to remove the automation. | +| script_id | integer | body | _Available in Fleet Premium_. ID of script to run if the policy fails. Set to 0 to remove the automation. | #### Example