Actions159
- Related Items Actions
- Backup Actions
- Queries Actions
- Get Disk Drives
- Get Operating Systems
- Get RAID Controller Report
- Get Volumes
- Get Computer Systems
- Get Antivirus Status Report
- Get Device Health Report
- Get Custom Fields Report
- Get Installed Software Patches
- Get Custom Fields Detailed Report
- Get Installed OS Patches
- Get Pending Failed Rejected OS Patches
- Get RAID Drive Report
- Get Windows Services Report
- Get Antivirus Threats
- Get Device Usage
- Get Network Interfaces
- Get Processors
- Get Software
- Get Last Logged On Users Report
- Get Policy Overrides 1
- Get Scoped Custom Fields Report
- Get Pending Failed Rejected Software Patches
- Get Scoped Custom Fields Detailed Report
- System Actions
- Knowledge Base Articles Actions
- Get Knowledge Base Article Signed Urls
- Get Related Item Attachments Signed Urls
- Download Knowledge Base Article
- Get Knowledge Base Folder Path Content
- Upload Temp Attachments
- Get Knowledge Base Folder Content
- Get Client Knowledge Base Articles
- Upload Knowledge Base Articles
- Get Global Knowledge Base Articles
- Download Related Item Attachment
- Organization Documents Actions
- Document Templates Actions
- Checklist Templates Actions
- Organization Checklists Actions
- Location Actions
- Management Actions
- Get Custom Fields Policy Condition
- Delete Policy Condition
- Reset Alert
- Update Device
- Request Scripting Options
- Submit OS Patch Scan
- Get Installer For Location
- Get Windows Event Policy Conditions
- Create Organization
- Cancel Device Maintenance
- Reboot Devices
- Set Windows Service Configuration
- Create Location For Organization
- Update Node Role Policy Assignment For Organization
- Create Windows Event Policy Condition
- Node Approval Operation
- Control Windows Service
- Remove Device Owner
- Submit OS Patch Apply
- Get Installer
- Create Policy
- Get Windows Event Policy Condition
- Update Device Maintenance
- Reset Policy Overrides
- Set Device Owner
- Submit Software Patch Scan
- Update Location
- Reset Alert Set Activity Data
- Get Device Link
- Run Script On Device
- Submit Software Patch Apply
- Update Organization
- Create Custom Fields Policy Condition
- Get Custom Fields Policy Conditions
- Custom Fields Actions
- Ticketing Actions
- Organization Actions
- Devices Actions
- Get Device Active Jobs
- Get Device Installed Software Patches
- Get Device Processors
- Update Node Attribute Values
- Get Device Disk Drives
- Get Device Pending Failed Rejected OS Patches
- Get Device Volumes
- Get Device Alerts
- Get Device Network Interfaces
- Get Device Software
- Get Device Activities
- Get Device Last Logged On User
- Get Device Services
- Get Policy Overrides
- Get Device
- Get Device Installed OS Patches
- Get Device Pending Failed Rejected Software Patches
- Get Node Custom Fields
- Groups Actions
- Webhooks Actions
Overview
The node integrates with the AvantGuard NinjaOne API to retrieve backup job information. Specifically, the "Get Backup Jobs" operation under the "Backup" resource allows users to fetch a list of backup jobs with optional filtering and pagination. This is useful for IT administrators or automation workflows that need to monitor backup statuses, audit backup activities, or integrate backup data into reporting dashboards.
Practical examples include:
- Automatically retrieving all recent backup jobs to verify successful backups.
- Filtering backup jobs by device or status to identify failed or pending backups.
- Paginating through large sets of backup jobs for batch processing or archival.
Properties
| Name | Meaning |
|---|---|
| Additional Query Parameters | Optional filters and controls for the backup jobs query: |
| - 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 backup jobs by their status (e.g., completed, failed). |
| - Ptf (Backup job planType filter) | Filter backup jobs by their plan type. |
| - Stf (Backup job startTime filter) | Filter backup jobs based on their start time. |
| - Include | Which devices to include in results: active, deleted, or all. Default is "active". |
| - Cursor | Cursor token for paginated requests to continue from a previous page. |
| - Page Size | Limit the number of records returned per page. Default is 10000. |
These parameters are sent as query parameters to the API endpoint to customize the retrieval of backup jobs.
Output
The node outputs JSON data representing the list of backup jobs retrieved from the API. The structure typically includes details such as job identifiers, device information, status, plan type, start times, and other metadata related to each backup job.
If the API supports pagination, the output may also include cursor tokens or paging information to allow fetching subsequent pages.
No binary data output is indicated for this operation.
Dependencies
- Requires an API key credential for authenticating with the AvantGuard NinjaOne API.
- The base URL for the API must be configured in the node credentials.
- The node depends on the
@avantguardllc/n8n-openapi-nodepackage and the bundled OpenAPI specification (openapi.json) for request building and execution.
Troubleshooting
- Common issues:
- Invalid or missing API credentials will cause authentication failures.
- Incorrect filter values may result in empty responses or errors.
- Large page sizes might lead to timeouts or performance issues.
- Error messages:
- Authentication errors usually indicate invalid API keys or misconfigured credentials.
- Validation errors may occur if query parameters do not conform to expected formats.
- Resolutions:
- Verify API credentials and ensure they have necessary permissions.
- Double-check filter parameter values for correctness.
- Reduce page size if experiencing timeouts or slow responses.
Links and References
- AvantGuard NinjaOne API Documentation
- n8n Documentation on HTTP Request Nodes (for general API integration concepts)