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

Organization → Organization locations backup usage

AI-generated

Summary

Retrieve backup usage data for all locations of a specified organization, with support for pagination and filtering options.

Inputs

  • id (required) — The identifier of the organization to fetch backup usage data for its locations.
  • returnAll — Flag to determine if all results should be returned across pages or just a single page of results.
  • options — Optional settings including custom request body JSON, custom HTTP headers, query filters for filtering results, batching settings to control request pacing, debug flag to include detailed request data, pagination configuration for handling paged results, and request timeout in milliseconds.

Output shape

An array of backup usage records for organization's locations, or a single page of such records depending on pagination settings.

Output structure corresponds to the API response for backup usage per organization location. When 'Debug' is enabled, additional debug information is included. Pagination is configurable via the 'options.pagination' parameter. If 'Return All' is false, only the first page is returned without pagination parameters.

Examples

Example 1: Fetch backup usage for organization with ID '12345', returning only the first page

Set 'id' to '12345', 'returnAll' to false (default), no additional options.

Example 2: Fetch all backup usage records for organization 'abcde' with a page size of 100

Set 'id' to 'abcde', 'returnAll' to true, and under 'options.pagination', set 'pageSize' to 100.

Links

Discussion