NinjaOne icon

NinjaOne

Consume NinjaOne API

Actions158

Backup → Get Backup Jobs

AI-generated

Overview

This node interacts with the NinjaOne API to retrieve backup job information. Specifically, the "Get Backup Jobs" operation under the "Backup" resource fetches a list of backup jobs filtered by various criteria such as device, status, plan type, and time. This is useful for IT administrators or automation workflows that need to monitor backup statuses, audit backup activities, or integrate backup job data into other systems.

Practical examples include:

  • Automatically retrieving recent backup jobs to verify successful backups.
  • Filtering backup jobs by device or status to generate reports or trigger alerts.
  • Paginating through large sets of backup jobs using cursor and page size parameters.

Properties

Name Meaning
Df Device filter: filter backup jobs by specific device identifier or name.
Ddf Deleted device filter: filter backup jobs related to deleted devices.
Sf Backup job status filter: filter jobs by their 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 based on their start time.
Include Which devices to include in results: options are active, deleted, or all. Default is active.
Cursor Cursor name: used for pagination to continue fetching from a specific point.
Page Size Limit number of records per page: controls how many backup job records are returned per request. Default is 10000.

Output

The node outputs an array of JSON objects representing backup jobs matching the specified filters. Each item in the output contains the raw JSON response from the NinjaOne API for backup jobs.

The structure of each JSON object corresponds directly to the NinjaOne API's backup job schema, including details such as job ID, device info, status, plan type, start time, and other metadata.

No binary data output is produced by this operation.

Dependencies

  • Requires an active NinjaOne API OAuth2 credential configured in n8n for authentication.
  • The node uses the NinjaOne REST API endpoint /v2/backup/jobs (implied by query parameters) to fetch backup job data.
  • No additional external dependencies beyond the NinjaOne API and n8n's HTTP request capabilities.

Troubleshooting

  • Common issues:

    • Invalid or expired 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:

    • Authentication errors typically indicate misconfigured or missing API credentials; re-authenticate or update credentials.
    • Request errors due to invalid parameters should be resolved by verifying filter values conform to expected formats.
    • Network or timeout errors can be mitigated by reducing page size or retrying later.

Links and References

Discussion