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 reports on Windows services. Specifically, the "Get Windows Services Report" operation fetches detailed information about Windows services running on devices managed by NinjaOne. This is useful for IT administrators and support teams who want to monitor service states across their infrastructure, troubleshoot issues, or generate compliance and operational reports.
Practical examples include:
- Listing all running or stopped services on a set of devices.
- Filtering services by name or state to identify problematic or critical services.
- Paginating through large sets of service data using cursors and page size parameters.
Properties
| Name | Meaning |
|---|---|
| Additional Query Parameters | Optional filters and pagination controls for the query: |
| - Df | Device filter: specify device(s) to limit the report scope. |
| - Name | Service name: filter results to services matching this name. |
| - State | Service state: filter by service status. Options: UNKNOWN, STOPPED, START PENDING, RUNNING, STOP PENDING, PAUSE PENDING, PAUSED, CONTINUE PENDING. |
| - Cursor | Cursor name: used for paginating through large result sets. |
| - Page Size | Limit number of records per page (default 1000). |
These parameters are passed as query parameters in the API request to refine and control the returned data.
Output
The node outputs JSON data representing the Windows services report retrieved from the NinjaOne API. The structure typically includes an array of service objects, each containing details such as service name, state, device association, and other metadata provided by the API.
If the API supports pagination, the output may also include cursor information to fetch 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 the API key credential is correctly configured and has sufficient permissions.
- Invalid query parameters: Verify that filter values like service state match one of the allowed options.
- Pagination issues: If using cursors, ensure the cursor value is valid and not expired.
- Empty results: Check that device filters and service names are correct; no matches will return empty arrays.
- API connectivity: Confirm network access to the NinjaOne API endpoint and that the base URL is correct.
Links and References
- AvantGuard NinjaOne API Documentation (general reference)
- Windows Services Monitoring Concepts (for understanding service states)