ReferenceWarden API

Agent updates

Managed Bramble agent updates — the update window and running updates now.

Method	Path	Summary
GET	`/api/agent-updates`	List agent updates
PUT	`/api/agent-updates/policy`	Set the agent update window
POST	`/api/agent-updates/run`	Update agents now

#List agent updates

GET/api/agent-updates

Address: https://<your-org>.brambleit.cloud/warden/api/agent-updates
Requires: Signed-in browser session (the sso_session / session_id cookies from Bramble sign-in).
Licence: Warden.

Response 200

Example request

JavaScript

// From a page served by Bramble (uses the signed-in session)
const res = await fetch('/warden/api/agent-updates', {
  method: 'GET',
  credentials: 'include',
});
const data = await res.json();

#Set the agent update window

PUT/api/agent-updates/policy

Address: https://<your-org>.brambleit.cloud/warden/api/agent-updates/policy
Requires: Signed-in browser session (the sso_session / session_id cookies from Bramble sign-in).
Licence: Warden.

Request body JSON

Name	Type	Description
`schedule_days`	integer	Days to update on.
`window_start`	any	When the window opens, `HH:MM`.
`window_minutes`	integer	How long it lasts.
`timezone`	any	Its time zone.
`max_parallel`	integer	How many devices at once.
`excluded_devices`	array of any	Devices never to update.
`enabled`	boolean	Update agents automatically.
`update_rmm`	any	Update the RMM agent.
`update_remote`	any	Update the Remote agent.

Response 200

Field	Type	Description
`policy`	any

Example response

JSON

{
  "policy": null
}

Example request

JavaScript

// From a page served by Bramble (uses the signed-in session)
const res = await fetch('/warden/api/agent-updates/policy', {
  method: 'PUT',
  credentials: 'include',
  headers: { 'Content-Type': 'application/json' },
  body: JSON.stringify({"schedule_days":1,"window_start":"…","window_minutes":1,"timezone":"…","max_parallel":1,"excluded_devices":[],"enabled":true,"update_rmm":"…","update_remote":"…"}),
});
const data = await res.json();

#Update agents now

POST/api/agent-updates/run

Address: https://<your-org>.brambleit.cloud/warden/api/agent-updates/run
Requires: Signed-in browser session (the sso_session / session_id cookies from Bramble sign-in).
Licence: Warden.

Request body JSON

Name	Type	Description
`device_ids`	array of any
`component`	any

Response 201

Field	Type	Description
`queued`	integer

Example response

JSON

{
  "queued": 1
}

Example request

JavaScript

// From a page served by Bramble (uses the signed-in session)
const res = await fetch('/warden/api/agent-updates/run', {
  method: 'POST',
  credentials: 'include',
  headers: { 'Content-Type': 'application/json' },
  body: JSON.stringify({"device_ids":[],"component":"…"}),
});
const data = await res.json();

Was this page helpful?