NinjaOne icon

NinjaOne

Ninja One Public API documentation. <br><br>See also: <br> <a href="https://resources.ninjarmm.com/API/Ninja+RMM+Public+API+v2.0.5+Device+Filter+Syntax.pdf">Device Filter syntax</a><br><a href="https://app.ninjarmm.com/apidocs-beta/core-resources/articles/webhooks/overview">Webhooks</a>

Actions309

Devices → OS Patch installation report for device

AI-generated

Summary

Retrieve the list of OS patch installation reports for a specified device, optionally filtered by installation status and date range, with support for pagination and custom request configuration.

Inputs

  • id (required) — The unique identifier of the device for which to fetch OS patch installation reports.
  • returnAll — Boolean flag to indicate whether to return all pages of results or only a single page.
  • status — Filter patches by installation status; valid values are 'FAILED' or 'INSTALLED'.
  • installedBefore — Include patches installed before this date (ISO string).
  • installedAfter — Include patches installed after this date (ISO string).
  • options.customBody — Override or add arbitrary JSON properties in the request body, merged with other parameters.
  • options.headerFilters — Add custom HTTP headers for the API request.
  • options.queryFilters — Add arbitrary query-string filters to the request URL.
  • options.batching — Configure batch request behavior when processing multiple input items.
  • options.debug — Include detailed request data (URL, headers, body) in the output for debugging.
  • options.pagination — Configure pagination mode, page size, cursor, and limits to control data retrieval.
  • options.timeout — Set a timeout in milliseconds for the API request.

Output shape

a list of OS patch installation report records related to the specified device

The results can be paginated based on the 'returnAll' flag and pagination settings. If 'debug' is enabled, the output also contains detailed API request information under a debug property.

Examples

Example 1: Fetch installed OS patches for device ID 123, returning all pages

Set 'id' to 123, 'returnAll' to true, and 'status' filter to 'INSTALLED'.

Links

Discussion