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

Backup → Create an integrity check job

AI-generated

Summary

Create a new integrity check job in the NinjaOne Backup system by submitting a request with optional parameters to specify the target device or backup plan.

Inputs

  • Device Id — The numeric identifier of the device on which to run the integrity check job.
  • Plan Uid — The unique string identifier of the backup plan for which to run the integrity check job.
  • Custom Body — A JSON object to send arbitrary additional fields in the request body, which will override the standard parameters if conflicts occur.
  • Custom Headers — One or more HTTP headers to include in the API request, specified as key-value pairs.
  • Query Filters — Custom query-string parameters to include in the request URL.
  • Batching — Settings to group input items into batches for sequential API requests with optional delays.
  • Debug — Enable to include detailed request data (URL, headers, body) in the output for troubleshooting.
  • Pagination — Configure pagination behavior when multiple pages of data might be retrieved, though typically irrelevant for job creation.
  • Timeout — Milliseconds to wait for the server response before aborting the request. Defaults to 300000 (5 minutes).

Output shape

a single JSON object representing the server's response to the creation of the integrity check job.

The output includes the newly created integrity check job details. When debug is enabled, the output also contains the exact HTTP request details made to the API.

Examples

Example 1: Run an integrity check job for a specific device

Set 'Device Id' to the target device's numeric ID and leave other fields as default or empty. Execute to submit the job.

Example 2: Run an integrity check job linked to a specific backup plan

Set 'Plan Uid' to the backup plan's unique identifier to target that plan in the request.

Links

Discussion