Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Clarify how to remove software installer and script run automations for a policy #22497

Merged
merged 2 commits into from
Sep 30, 2024
Merged

Clarify how to remove software installer and script run automations for a policy #22497

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
c952d71
Clarify how to remove software installer and script run automations f…
iansltx Sep 28, 2024
af695ef
Minor formatting tweak
rachaelshaw Sep 30, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 12 additions & 12 deletions docs/REST API/rest-api.md
View file
Open in desktop
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. |
rachaelshaw marked this conversation as resolved.
Show resolved Hide resolved
| script_id | integer | body | _Available in Fleet Premium_. ID of script to run if the policy fails. Set to 0 to remove the automation. |
rachaelshaw marked this conversation as resolved.
Show resolved Hide resolved

#### Example

Expand Down
Loading