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
This node interacts with the AvantGuard NinjaOne API to retrieve device health reports. Specifically, the "Get Device Health Report" operation under the "Queries" resource allows users to fetch detailed health status information about devices managed within the NinjaOne platform. This is useful for IT administrators or support teams who want to monitor device conditions, filter devices by health status, and paginate through large sets of device data.
Practical examples include:
- Fetching all devices currently marked as unhealthy to prioritize troubleshooting.
- Filtering devices by specific criteria such as device type or health status.
- Paginating through device health records when dealing with a large number of devices.
Properties
| Name | Meaning |
|---|---|
| Additional Query Parameters | Optional filters and pagination controls for the query: |
| - Df | Device filter (string) to narrow down which devices to include in the report. |
| - Health | Health status filter (string) to select devices based on their health condition. |
| - Cursor | Cursor name (string) used for pagination to continue fetching results from a specific point. |
| - Page Size | Number (integer) limiting how many records are returned per page. |
Output
The node outputs JSON data containing the device health report retrieved from the NinjaOne API. The structure typically includes an array of device health records, each detailing device identifiers, health status, and possibly other metadata depending on the API response.
If the API supports pagination, the output may also include cursor or paging tokens to facilitate 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.
- Relies on the
@avantguardllc/n8n-openapi-nodepackage and the bundled OpenAPI specification (openapi.json) for request construction.
Troubleshooting
- Authentication errors: Ensure that the API key credential is correctly set up and has sufficient permissions.
- Invalid query parameters: Verify that filters like "Df" and "Health" use valid values recognized by the NinjaOne API.
- Pagination issues: When using the "Cursor" parameter, ensure it matches a valid cursor token from a previous response.
- Empty responses: Could indicate no devices match the given filters; try broadening or removing filters.
- Network or API errors: Check connectivity and NinjaOne service status.
Links and References
- AvantGuard NinjaOne API Documentation (general reference for API endpoints and parameters)
- n8n Documentation on Creating Custom Nodes