Skip to content

Commit 43060bf

Browse files
authored
Reference docs: default timeout for scripts and software (#22908)
- We made script timeouts configurable in this user story: #16645 - We added a default timeout for software in this bug: #22558
1 parent e8c0deb commit 43060bf

File tree

1 file changed

+5
-1
lines changed

1 file changed

+5
-1
lines changed

docs/REST API/rest-api.md

+5-1
Original file line numberDiff line numberDiff line change
@@ -8425,6 +8425,8 @@ The script will be added to the host's list of upcoming activities.
84258425

84268426
The new script will run after other activities finish. Failure of one activity won't cancel other activities.
84278427

8428+
By default, script runs time out after 5 minutes. You can modify this default in your [agent configuration](https://fleetdm.com/docs/configuration/agent-configuration#script-execution-timeout).
8429+
84288430
`POST /api/v1/fleet/scripts/run`
84298431

84308432
#### Parameters
@@ -9480,7 +9482,9 @@ Add App Store (VPP) app purchased in Apple Business Manager.
94809482
94819483
_Available in Fleet Premium._
94829484

9483-
Install software (package or App Store app) on a macOS, iOS, iPadOS, Windows, or Linux (Ubuntu) host. Software title must have a `software_package` or `app_store_app` added to be installed.
9485+
Install software (package or App Store app) on a macOS, iOS, iPadOS, Windows, or Linux (Ubuntu) host. Software title must have a `software_package` or `app_store_app` to be installed.
9486+
9487+
Package installs time out after 1 hour.
94849488

94859489
`POST /api/v1/fleet/hosts/:id/software/:software_title_id/install`
94869490

0 commit comments

Comments
 (0)