Skip to content

Commit

Permalink
Clarify how to remove software installer and script run automations f…
Browse files Browse the repository at this point in the history 
…or a policy (#22497)

#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".

This reflects existing behavior on the software installer side, and
upcoming behavior (consistent with installer behavior) on the script
side.

---------

Co-authored-by: Rachael Shaw <r@rachael.wtf>
  • Loading branch information
@iansltx @rachaelshaw
iansltx and rachaelshaw authored Sep 30, 2024
1 parent 1bcf73e commit 44b659b
Showing 1 changed file with 12 additions and 12 deletions.
24 changes: 12 additions & 12 deletions docs/REST API/rest-api.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down

0 comments on commit 44b659b

Please sign in to comment.