ReferenceWarden API

Applications

Outdated applications across the fleet and the full application inventory.

Method	Path	Summary
GET	`/api/apps`	Application patching: outdated apps across the fleet, one row per app
GET	`/api/apps/inventory`	Application inventory: every app found on devices (device_apps, built by the scanner from each device's report), one row per app, with how many devices have …
GET	`/api/apps/inventory/devices`	Devices that have an app

#Application patching: outdated apps across the fleet, one row per app

GET/api/apps

Application patching: outdated apps across the fleet, one row per app. Apps are kind 'app' updates (winget/<id>, snap/<n>, flatpak/<id>) plus apt/dnf packages that RMM's application catalogue deploys. Each row lists its devices so "Update everywhere" can make a selected job, and says which catalogue app (if any) it belongs to.

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

Response 200

Field	Type	Description
`apps`	array of any
`manual`	array of any
`coverage`	any
`summary`	object
`summary.apps`	integer
`summary.devices`	integer
`summary.updates`	integer

Example response

JSON

{
  "apps": [],
  "manual": [],
  "coverage": null,
  "summary": {
    "apps": 1,
    "devices": 1,
    "updates": 1
  }
}

Example request

JavaScript

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

#Application inventory: every app found on devices (device_apps, built by the scanner from each device's report), one row per app, with how many devices have …

GET/api/apps/inventory

Application inventory: every app found on devices (device_apps, built by the scanner from each device's report), one row per app, with how many devices have it, which versions, and how many are behind.

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

Response 200

Field	Type	Description
`apps`	array of object
`apps[].app_key`	string
`apps[].name`	string
`apps[].publisher`	string, or null
`apps[].sources`	array of any
`apps[].devices`	integer
`apps[].outdated`	integer
`apps[].patchable`	integer
`apps[].unknown`	integer
`apps[].latest`	string, or null
`apps[].version_count`	integer
`apps[].versions`	array of any
`apps[].store`	boolean
`summary`	object
`summary.apps`	integer
`summary.outdated_apps`	integer
`summary.devices`	number
`summary.devices_outdated`	number

Example response

JSON

{
  "apps": [
    {
      "app_key": "…",
      "name": "Example name",
      "publisher": "string",
      "sources": [],
      "devices": 1,
      "outdated": 1,
      "patchable": 1,
      "unknown": 1,
      "latest": "string",
      "version_count": 3,
      "versions": [],
      "store": false
    }
  ],
  "summary": {
    "apps": 1,
    "outdated_apps": 1,
    "devices": 12.5,
    "devices_outdated": 12.5
  }
}

Example request

JavaScript

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

#Devices that have an app

GET/api/apps/inventory/devices

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

Query parameters

Name	Type	Description
`key`	string	The app (from the inventory list).

Response 200

Field	Type	Description
`devices`	array of object
`devices[].device_id`	string
`devices[].name`	string
`devices[].version`	string, or null
`devices[].latest_version`	string, or null
`devices[].status`	string
`devices[].patchable`	boolean
`devices[].update_package`	string, or null
`devices[].scope`	string, or null
`devices[].source`	string
`devices[].device_name`	integer
`devices[].online`	boolean
`devices[].site_name`	any

Example response

JSON

{
  "devices": [
    {
      "device_id": "string",
      "name": "Example name",
      "version": "string",
      "latest_version": "string",
      "status": "active",
      "patchable": false,
      "update_package": "string",
      "scope": "string",
      "source": "string",
      "device_name": 1,
      "online": false,
      "site_name": null
    }
  ]
}

Example request

JavaScript

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

Was this page helpful?