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

Queries → Device backup usage

AI-generated

Summary

Retrieve device backup usage data from the NinjaOne API with optional pagination and filtering.

Inputs

  • returnAll — Boolean flag to determine if all results should be returned or just a single page.
  • additionalFields.cursor — Cursor name used for pagination when Cursor-Based mode is enabled.
  • additionalFields.pageSize — Limit the number of records per page in the response.
  • additionalFields.includeDeletedDevices — Boolean indicating whether to include data for deleted devices.
  • options.customBody — Custom JSON object to merge into the request body, taking priority over other fields.
  • options.headerFilters — Custom HTTP headers to include in the API request.
  • options.queryFilters — Custom query-string filters as key-value pairs to further refine the API request.
  • options.batching — Batch settings controlling how multiple input items are grouped and delays between batches.
  • options.debug — Enable debug output with detailed request information.
  • options.pagination — Configure pagination handling, including mode (offset, cursor, or URL), parameter names, page size, and maximum pages.
  • options.timeout — Timeout in milliseconds to wait for the server response headers before aborting the request.

Output shape

a JSON object or array representing device backup usage data, potentially paginated according to input parameters.

Supports multiple pagination modes (offset-based, cursor-based, or next URL). When 'returnAll' is false, returns a single page of results. Debug mode adds request details to output. User can override or add custom headers, query filters, and request body fields.

Links

Discussion