NinjaOne n8n Node

Ninja One Public API documentation. See also: Device Filter syntaxWebhooks

Table of Contents

• Installation
• Authentication
• Resources & Operations
• Compatibility
• License

Installation

Follow the n8n community node installation guide.

Or install directly via npm:

npm install @avantguardllc/n8n-nodes-ninjaone

Authentication

This node authenticates using OAuth 2.0.

| Setting | Value | |---------|-------| | Type | OAuth2 | | Base URL | https://api.example.com (editable in credentials) |

Tip: The Base URL can be changed in the credential settings if your instance uses a different host.

Resources & Operations

Base URL: https://api.example.com

System

| | Endpoint | Description | |---|----------|-------------| | 🔵 GET | /v2/contacts | Contact list | | 🔵 GET | /v2/contact/{id} | Contact details | | 🔵 GET | /v2/organizations | List organizations | | 🔵 GET | /v2/policies | List policies | | 🔵 GET | /v2/jobs | List active jobs | | 🔵 GET | /v2/activities | List activities | | 🔵 GET | /v2/alerts | List active alerts (triggered conditions) | | 🔵 GET | /v2/automation/scripts | List all available automation scripts | | 🔵 GET | /v2/device-custom-fields | Device Custom Fields | | 🔵 GET | /v2/devices | List devices | | 🔵 GET | /v2/devices-detailed | List devices (detailed) | | 🔵 GET | /v2/notification-channels/enabled | List enabled notification channels | | 🔵 GET | /v2/groups | List groups (saved searches) | | 🔵 GET | /v2/locations | List locations | | 🔵 GET | /v2/roles | List device roles | | 🔵 GET | /v2/notification-channels | List notification channels | | 🔵 GET | /v2/organizations-detailed | List organizations (Detailed) | | 🔵 GET | /v2/tasks | List scheduled tasks | | 🔵 GET | /v2/software-products | List supported 3rd party software | | 🔵 GET | /v2/users | List users | | 🔵 GET | /v2/devices/search | Find devices | | 🔵 GET | /v2/user/end-users | End user list | | 🔵 GET | /v2/user/technicians | Technicians list | | 🔵 GET | /v2/user/roles | Get user roles |

Management

| | Endpoint | Description | |---|----------|-------------| | 🟢 POST | /v2/contacts | Create a contact | | 🟣 PATCH | /v2/contact/{id} | Update a contact | | 🔴 DELETE | /v2/contact/{id} | Delete a contact | | 🔵 GET | /v2/policies/{policy_id}/condition/custom-fields | Get custom fields policy conditions | | 🟢 POST | /v2/policies/{policy_id}/condition/custom-fields | Create custom fields policy condition | | 🔵 GET | /v2/policies/{policy_id}/condition/windows-event | Get windows event conditions | | 🟢 POST | /v2/policies/{policy_id}/condition/windows-event | Create windows event condition | | 🔴 DELETE | /v2/policies/{policy_id}/condition/{condition_id} | Delete policy condition | | 🔵 GET | /v2/policies/{policy_id}/condition/custom-fields/{condition_id} | Get custom fields policy condition | | 🔵 GET | /v2/policies/{policy_id}/condition/windows-event/{condition_id} | Get windows event condition | | 🟢 POST | /v2/organizations | Create new organization | | 🟢 POST | /v2/devices/approval/{mode} | Approve/Reject devices | | 🔴 DELETE | /v2/alert/{uid} | Reset alert/condition | | 🟢 POST | /v2/alert/{uid}/reset | Reset alert/condition and provide custom data for activity | | 🟡 PUT | /v2/device/{id}/maintenance | Schedule maintenance | | 🔴 DELETE | /v2/device/{id}/maintenance | Cancel maintenance | | 🟢 POST | /v2/device/{id}/windows-service/{serviceId}/control | Windows service control | | 🟣 PATCH | /v2/device/{id} | Update device information | | 🔵 GET | /v2/device/{id}/dashboard-url | Device link | | 🔴 DELETE | /v2/device/{id}/policy/overrides | Reset device policy overrides | | 🟢 POST | /v2/device/{id}/reboot/{mode} | Reboot device | | 🔴 DELETE | /v2/device/{id}/owner | Remove device owner | | 🔵 GET | /v2/device/{id}/scripting/options | Device scripting options | | 🟢 POST | /v2/device/{id}/script/run | Run script or built-in action | | 🟢 POST | /v2/device/{id}/owner/{ownerUid} | Set device owner | | 🟢 POST | /v2/device/{id}/windows-service/{serviceId}/configure | Modify Windows Service configuration | | 🟢 POST | /v2/device/{id}/patch/os/apply | Run OS patch apply | | 🟢 POST | /v2/device/{id}/patch/os/scan | Run OS patch scan | | 🟢 POST | /v2/device/{id}/patch/software/apply | Run Software patch apply | | 🟢 POST | /v2/device/{id}/patch/software/scan | Run Software patch scan | | 🟢 POST | /v2/organization/{id}/locations | Add new location to organization | | 🟢 POST | /v2/organization/generate-installer | Generate installer | | 🔵 GET | /v2/organization/{id}/location/{location_id}/installer/{installer_type} | Generate installer | | 🟣 PATCH | /v2/organization/{id} | Update organization | | 🟣 PATCH | /v2/organization/{id}/locations/{locationId} | Update location | | 🟡 PUT | /v2/organization/{id}/policies | Change organization policy mappings | | 🟢 POST | /v2/policies | Creates new Policy | | 🟢 POST | /v2/user/end-users | Create end user | | 🟣 PATCH | /v2/user/end-user/{id} | Update a specific end user | | 🔴 DELETE | /v2/user/end-user/{id} | Delete end user | | 🟢 POST | /v2/user/technicians | Create a technician | | 🟣 PATCH | /v2/user/technician/{id} | Update a technician | | 🔴 DELETE | /v2/user/technician/{id} | Delete a technician | | 🟣 PATCH | /v2/user/role/{roleId}/add-members | Add user role members | | 🟣 PATCH | /v2/user/role/{roleId}/remove-members | Remove users from user role |

NodeRoles

| | Endpoint | Description | |---|----------|-------------| | 🟢 POST | /v2/noderole | Create node roles | | 🟣 PATCH | /v2/noderole | Update node roles | | 🟢 POST | /v2/noderole/delete | Delete node roles | | 🔵 GET | /v2/noderole/list | Get all node roles |

Webhooks

| | Endpoint | Description | |---|----------|-------------| | 🟡 PUT | /v2/webhook | Update API Webhook configuration | | 🔴 DELETE | /v2/webhook | Remove Webhook API channel |

KnowledgeBaseArticles

| | Endpoint | Description | |---|----------|-------------| | 🟢 POST | /v2/attachments/temp/upload | Upload temporary attachments | | 🟢 POST | /v2/knowledgebase/articles/archive | Archive knowledge base articles | | 🟢 POST | /v2/knowledgebase/folders/archive | Archive knowledge base folders | | 🟢 POST | /v2/knowledgebase/articles | Create knowledge base articles | | 🟣 PATCH | /v2/knowledgebase/articles | Update knowledge base articles | | 🟢 POST | /v2/knowledgebase/articles/delete | Delete knowledge base articles | | 🟢 POST | /v2/knowledgebase/folders/delete | Delete knowledge base folders | | 🔵 GET | /v2/knowledgebase/article/{articleId}/download | Download knowledge base article | | 🔵 GET | /v2/knowledgebase/organization/articles | Lists organization knowledge base articles | | 🔵 GET | /v2/knowledgebase/global/articles | Lists global knowledge base articles | | 🔵 GET | /v2/knowledgebase/article/{articleId}/signed-urls | Get knowledge base article signed urls | | 🔵 GET | /v2/knowledgebase/folder/{folderId} | Returns knowledge base folder | | 🔵 GET | /v2/knowledgebase/folder | Returns knowledge base folder | | 🟣 PATCH | /v2/knowledgebase/folders/move | Move knowledge base items | | 🟢 POST | /v2/knowledgebase/articles/restore | Restore archive knowledge base articles | | 🟢 POST | /v2/knowledgebase/folders/restore | Restore archived knowledge base folders | | 🟢 POST | /v2/knowledgebase/articles/upload | Upload knowledge base articles | | 🔵 GET | /v2/related-items/{relatedItemId}/attachment/download | Download related item attachment | | 🔵 GET | /v2/related-items/with-entity/{entityType}/{entityId}/attachments/signed-urls | Get related item attachments signed urls |

ChecklistTemplates

| | Endpoint | Description | |---|----------|-------------| | 🟢 POST | /v2/checklist/archive | Archive a checklist template | | 🔵 GET | /v2/checklist/templates | List checklist templates | | 🟢 POST | /v2/checklist/templates | Create checklist templates | | 🟡 PUT | /v2/checklist/templates | Update checklist templates | | 🔴 DELETE | /v2/checklist/template/{checklistTemplateId} | Delete a checklist template | | 🟢 POST | /v2/checklist/templates/delete | Delete checklist templates | | 🟢 POST | /v2/checklist/restore | Restore a checklist template |

OrganizationChecklists

| | Endpoint | Description | |---|----------|-------------| | 🟢 POST | /v2/organization/archive | Archive organization checklists | | 🔵 GET | /v2/organization/checklists | List client checklists | | 🟢 POST | /v2/organization/checklists | Create organization checklists | | 🟡 PUT | /v2/organization/checklists | Update organization checklists | | 🟢 POST | /v2/organization/{organizationId}/checklists-from-templates | Create organization checklists from templates | | 🔵 GET | /v2/organization/checklist/{checklistId} | Get client checklist | | 🔴 DELETE | /v2/organization/checklist/{checklistId} | Delete an organization checklist | | 🟢 POST | /v2/organization/checklists/delete | Delete organization checklists | | 🔵 GET | /v2/organization/checklist/{checklistId}/signed-urls | Get organization checklist signed urls | | 🟢 POST | /v2/organization/checklists/promote-with-name | Promote organization checklists | | 🟢 POST | /v2/organization/checklists/promote | Promote organization checklists | | 🟢 POST | /v2/organization/restore | Restore organization checklists |

OrganizationDocuments

| | Endpoint | Description | |---|----------|-------------| | 🟢 POST | /v2/organization/document/{clientDocumentId}/archive | Archive an organization document | | 🟢 POST | /v2/organization/documents/archive | Archives organization documents | | 🟢 POST | /v2/organization/{organizationId}/template/{documentTemplateId}/document | Create organization document | | 🔵 GET | /v2/organization/documents | List all organization documents with field values | | 🟢 POST | /v2/organization/documents | Create organization documents | | 🟣 PATCH | /v2/organization/documents | Update organization documents | | 🔴 DELETE | /v2/organization/document/{clientDocumentId} | Delete an archived organization document | | 🔵 GET | /v2/organization/document/{clientDocumentId}/signed-urls | Get organization document signed urls | | 🔵 GET | /v2/organization/{organizationId}/documents | List organization documents with field values | | 🟢 POST | /v2/organization/document/{clientDocumentId}/restore | Restore an organization document | | 🟢 POST | /v2/organization/documents/restore | Restore multiple multi page organization documents | | 🟢 POST | /v2/organization/{organizationId}/document/{clientDocumentId} | Update organization document |

DocumentTemplates

| | Endpoint | Description | |---|----------|-------------| | 🟢 POST | /v2/document-templates/{documentTemplateId}/archive | Archive a document template | | 🟢 POST | /v2/document-templates/archive | Archive multiple document templates | | 🔵 GET | /v2/document-templates | List document templates with fields | | 🟢 POST | /v2/document-templates | Create document template | | 🔵 GET | /v2/document-templates/{documentTemplateId} | Get document template | | 🟡 PUT | /v2/document-templates/{documentTemplateId} | Update document template | | 🔴 DELETE | /v2/document-templates/{documentTemplateId} | Delete a document template | | 🟢 POST | /v2/document-templates/{documentTemplateId}/restore | Restore a document template | | 🟢 POST | /v2/document-templates/restore | Restore a document template |

AssetTags

| | Endpoint | Description | |---|----------|-------------| | 🟢 POST | /v2/tag/{assetType} | Batch tag assets | | 🔵 GET | /v2/tag | Get Asset Tags | | 🟢 POST | /v2/tag | Create an Asset Tag | | 🟡 PUT | /v2/tag/{tagId} | Update an Asset Tag | | 🔴 DELETE | /v2/tag/{tagId} | Delete an Asset Tag | | 🟢 POST | /v2/tag/delete | Delete several Asset Tags | | 🟢 POST | /v2/tag/merge | Merge existing tags | | 🟡 PUT | /v2/tag/{assetType}/{assetId} | Set tags for an asset |

CustomFields

| | Endpoint | Description | |---|----------|-------------| | 🔵 GET | /v2/custom-fields/entity-type/{entityType}/{entityId}/signed-urls | Get custom field signed urls |

RelatedItems

| | Endpoint | Description | |---|----------|-------------| | 🟢 POST | /v2/related-items/entity/{entityType}/{entityId}/attachment | Create Attachment Relation | | 🟢 POST | /v2/related-items/entity/{entityType}/{entityId}/relation | Create entity relation | | 🟢 POST | /v2/related-items/entity/{entityType}/{entityId}/relations | Create entity relations | | 🟢 POST | /v2/related-items/entity/{entityType}/{entityId}/secure | Create Secure Relation | | 🔴 DELETE | /v2/related-items/{relatedItemId} | Delete related item | | 🔴 DELETE | /v2/related-items/{entityType}/{entityId} | Delete related items | | 🔵 GET | /v2/related-items | List all related items | | 🔵 GET | /v2/related-items/with-entity/{entityType}/{entityId} | List host entity related items by scope | | 🔵 GET | /v2/related-items/with-related-entity/{relEntityType}/{relEntityId} | List related entity related items | | 🔵 GET | /v2/related-items/with-related-entity-type/{relatedEntityType} | List related entity type related items | | 🔵 GET | /v2/related-items/with-entity-type/{entityType} | List host entity type related items |

SoftwareLicenses

| | Endpoint | Description | |---|----------|-------------| | 🟢 POST | /v2/software-license | Create a Software License | | 🔵 GET | /v2/software-license/{licenseId} | Get Software License | | 🟡 PUT | /v2/software-license/{licenseId} | Update a Software License | | 🔴 DELETE | /v2/software-license/{licenseId} | Delete a Software License | | 🟢 POST | /v2/software-license/upsert | Create or Update a Software License |

UnmanagedDevices

| | Endpoint | Description | |---|----------|-------------| | 🟢 POST | /v2/itam/unmanaged-device | Create an Unmanaged Device | | 🟡 PUT | /v2/itam/unmanaged-device/{nodeId} | Update an Unmanaged Device | | 🔴 DELETE | /v2/itam/unmanaged-device/{nodeId} | Delete an Unmanaged Device |

Backup

| | Endpoint | Description | |---|----------|-------------| | 🟢 POST | /v2/backup/bandwidth-throttle | Sets the bandwidth throttle for a device | | 🔵 GET | /v2/backup/integrity-check-jobs | Integrity check jobs. | | 🟢 POST | /v2/backup/integrity-check-jobs | Create an integrity check job | | 🔵 GET | /v2/backup/jobs | Backup jobs |

CustomTabs

| | Endpoint | Description | |---|----------|-------------| | 🟢 POST | /v2/tab | Create a new Custom Tab | | 🔵 GET | /v2/tab/{tabId} | Retrieve a Custom Tab | | 🟣 PATCH | /v2/tab/{tabId} | Update a Custom Tab | | 🔴 DELETE | /v2/tab/{tabId} | Delete a Custom Tab | | 🔵 GET | /v2/tab/{tabId}/end-user | Retrieve the requested tab along with any extensions for end-user tabs | | 🔵 GET | /v2/tab/{tabId}/organization | Retrieve the requested tab along with any extensions for organization and location tabs | | 🔵 GET | /v2/tab/{tabId}/role/{roleId} | Retrieve the requested tab along with any extensions based on the supplied roleId | | 🔵 GET | /v2/tab/summary/end-user | Retrieve all of the custom tabs available to end user views | | 🔵 GET | /v2/tab/summary/organization | Retrieve all of the custom tabs available to organizations and locations | | 🔵 GET | /v2/tab/summary/role/{roleId} | Retrieve all of the custom tabs that would appear for the given role | | 🟣 PATCH | /v2/tab/rename | Rename a Custom Tab | | 🟣 PATCH | /v2/tab/role/{roleId}/visibility | Set the tab visibility of the specified tab | | 🟣 PATCH | /v2/tab/end-user/order | Update the order of custom tabs for end-user tabs | | 🟣 PATCH | /v2/tab/organization/order | Update the order of custom tabs for organizations and locations | | 🟣 PATCH | /v2/tab/role/{roleId}/order | Update the order of custom tabs for a specific role |

Ticketing

| | Endpoint | Description | |---|----------|-------------| | 🟢 POST | /v2/ticketing/ticket | Create ticket | | 🟢 POST | /v2/ticketing/ticket/{ticketId}/comment | Add comment to ticket | | 🔵 GET | /v2/ticketing/ticket/{ticketId} | Ticket | | 🟡 PUT | /v2/ticketing/ticket/{ticketId} | Update ticket | | 🔵 GET | /v2/ticketing/ticket/{ticketId}/log-entry | List ticket log entries | | 🔵 GET | /v2/ticketing/attributes | List ticket attributes | | 🔵 GET | /v2/ticketing/contact/contacts | List contacts | | 🔵 GET | /v2/ticketing/ticket-form/{id} | Ticket form | | 🔵 GET | /v2/ticketing/ticket-form | List ticket forms | | 🔵 GET | /v2/ticketing/statuses | Get list of ticket status | | 🔵 GET | /v2/ticketing/trigger/boards | List boards | | 🟢 POST | /v2/ticketing/trigger/board/{boardId}/run | List of tickets for board | | 🔵 GET | /v2/ticketing/app-user-contact | List of users by user type |

VulnerabilityManagement

| | Endpoint | Description | |---|----------|-------------| | 🔵 GET | /v2/vulnerability/scan-groups | Fetch all Scan Groups | | 🔵 GET | /v2/vulnerability/scan-groups/{scan-group-id} | Fetch Scan Group | | 🟢 POST | /v2/vulnerability/scan-groups/{scan-group-id}/upload | Upload CSV |

Devices

| | Endpoint | Description | |---|----------|-------------| | 🔵 GET | /v2/device/{id} | Device details | | 🔵 GET | /v2/device/{id}/jobs | Device currently running (active) jobs | | 🔵 GET | /v2/device/{id}/activities | Device activities | | 🔵 GET | /v2/device/{id}/alerts | Device alerts (triggered conditions) | | 🔵 GET | /v2/device/{id}/disks | Device disk drives | | 🔵 GET | /v2/device/{id}/os-patch-installs | OS Patch installation report for device | | 🔵 GET | /v2/device/{id}/software-patch-installs | Software Patch history for device | | 🔵 GET | /v2/device/{id}/last-logged-on-user | Last logged-on user information | | 🔵 GET | /v2/device/{id}/network-interfaces | Device network interfaces | | 🔵 GET | /v2/device/{id}/os-patches | OS Patches | | 🔵 GET | /v2/device/{id}/software-patches | Pending, Failed and Rejected Software patches for device | | 🔵 GET | /v2/device/{id}/processors | Device processors | | 🔵 GET | /v2/device/{id}/windows-services | Windows services | | 🔵 GET | /v2/device/{id}/software | Device software inventory | | 🔵 GET | /v2/device/{id}/volumes | Device storage volumes | | 🔵 GET | /v2/device/{id}/custom-fields | Device custom fields | | 🟣 PATCH | /v2/device/{id}/custom-fields | Update Field Values | | 🔵 GET | /v2/device/{id}/policy/overrides | Get summary of device policy overrides |

Groups

| | Endpoint | Description | |---|----------|-------------| | 🔵 GET | /v2/group/{id}/device-ids | Group members |

Organization

| | Endpoint | Description | |---|----------|-------------| | 🔵 GET | /v2/organization/{id}/locations | Organization locations | | 🔵 GET | /v2/organization/{id}/end-users | List users | | 🔵 GET | /v2/organization/{id}/locations/{locationId}/backup/usage | Organization location backup usage | | 🔵 GET | /v2/organization/{id}/custom-fields | Organization custom fields | | 🟣 PATCH | /v2/organization/{id}/custom-fields | Update Field Values | | 🔵 GET | /v2/organization/{id} | Organization information | | 🔵 GET | /v2/organization/{id}/devices | Organization devices | | 🔵 GET | /v2/organization/{id}/locations/backup/usage | Organization locations backup usage |

Location

| | Endpoint | Description | |---|----------|-------------| | 🔵 GET | /v2/organization/{id}/location/{locationId}/custom-fields | Location custom fields | | 🟣 PATCH | /v2/organization/{id}/location/{locationId}/custom-fields | Update Field Values |

Queries

| | Endpoint | Description | |---|----------|-------------| | 🔵 GET | /v2/queries/antivirus-status | Antivirus status report | | 🔵 GET | /v2/queries/antivirus-threats | Antivirus threats report | | 🔵 GET | /v2/queries/computer-systems | Computer systems report | | 🔵 GET | /v2/queries/custom-fields-detailed | Custom fields detailed report | | 🔵 GET | /v2/queries/custom-fields | Custom fields report | | 🔵 GET | /v2/queries/device-health | Device health report | | 🔵 GET | /v2/queries/backup/usage | Device backup usage | | 🔵 GET | /v2/queries/disks | Disk drives report | | 🔵 GET | /v2/queries/os-patch-installs | OS Patch installation report | | 🔵 GET | /v2/queries/software-patch-installs | Software Patch history report | | 🔵 GET | /v2/queries/logged-on-users | Last logged-on user report | | 🔵 GET | /v2/queries/network-interfaces | List Network Interfaces | | 🔵 GET | /v2/queries/operating-systems | Operating systems report | | 🔵 GET | /v2/queries/os-patches | Pending, Failed and Rejected OS patches report | | 🔵 GET | /v2/queries/software-patches | Pending, Failed and Rejected Software patches report | | 🔵 GET | /v2/queries/policy-overrides | Get summary of device policy overrides | | 🔵 GET | /v2/queries/processors | Processor report | | 🔵 GET | /v2/queries/raid-controllers | RAID controller report | | 🔵 GET | /v2/queries/raid-drives | RAID drive report | | 🔵 GET | /v2/queries/scoped-custom-fields-detailed | Scoped custom fields detailed report | | 🔵 GET | /v2/queries/scoped-custom-fields | Scoped custom fields report | | 🔵 GET | /v2/queries/software | Software inventory | | 🔵 GET | /v2/queries/volumes | Disk volumes report | | 🔵 GET | /v2/queries/windows-services | Windows services report |

Users

| | Endpoint | Description | |---|----------|-------------| | 🔵 GET | /v2/user/end-user/{id} | End user details | | 🔵 GET | /v2/user/end-user/{id}/custom-fields | End user custom fields | | 🟣 PATCH | /v2/user/end-user/{id}/custom-fields | Update Field Values | | 🔵 GET | /v2/user/technician/{id} | Technician details |

Compatibility

• n8n version: 1.0+ (tested on 2.x)
• Node.js version: 18+

License

MIT