NinjaOne icon

NinjaOne

Consume NinjaOne API

Actions158

Backup → Get Integrity Check Jobs

AI-generated

Overview

This node interacts with the NinjaOne API to retrieve integrity check job records related to backups. It allows filtering these jobs based on various criteria such as device status, backup job status, plan type, and time filters. This is useful for IT administrators or automation workflows that need to monitor or audit backup integrity checks across devices managed by NinjaOne.

Practical examples include:

  • Fetching all active integrity check jobs for a specific device or set of devices.
  • Filtering integrity check jobs by their status to identify failed or pending jobs.
  • Paginating through large sets of integrity check job records using cursor and page size parameters.

Properties

Name Meaning
Df Device filter: filter results by specific device identifier or criteria.
Ddf Deleted device filter: filter results by deleted devices.
Sf Backup job status filter: filter jobs by their current status (e.g., success, failed).
Ptf Backup job planType filter: filter jobs by the type of backup plan used.
Stf Backup job startTime filter: filter jobs by the start time of the backup job.
Include Which devices to include in results: options are active, deleted, or all. Default is active.
Cursor Cursor name for pagination: used to fetch subsequent pages of results.
Page Size Limit number of records per page: controls how many records are returned in one request.

Output

The node outputs an array of JSON objects representing the integrity check jobs retrieved from the NinjaOne API. Each object contains details about a single integrity check job, including its associated device, status, plan type, start time, and other relevant metadata as provided by the API.

No binary data output is indicated for this operation.

Dependencies

  • Requires an API authentication token credential configured in n8n to authenticate requests against the NinjaOne API.
  • The node uses the NinjaOne OAuth2 API credential for secure access.
  • No additional external dependencies beyond the NinjaOne API and n8n's HTTP request helpers.

Troubleshooting

  • Common issues:

    • Missing or invalid API credentials will cause authentication failures.
    • Providing invalid filter values may result in empty responses or API errors.
    • Large page sizes might lead to timeouts or performance issues depending on the API limits.
  • Error messages:

    • Errors returned from the NinjaOne API will be surfaced in the node output if "Continue On Fail" is enabled.
    • Typical error messages include authentication errors, invalid parameter errors, or rate limiting notices.
  • Resolutions:

    • Verify that the API key or OAuth2 credentials are correctly configured and valid.
    • Check filter values for correctness and adherence to expected formats.
    • Reduce page size or use cursors to paginate through large datasets.

Links and References

Discussion