The CloudRadial AutomationAI NinjaOne RMM extensions let a workflow or agent work with your NinjaOne estate: inspect devices and pull estate-wide inventory, patch, and antivirus reports, run scripts, patches, reboots, and other device actions, and manage organizations, locations, policies, custom fields, asset tags, and software licenses. The NinjaOne API is split across three extensions plus a Read-Only version. This article covers which to install, connecting them to a NinjaOne API application, which tools require approval, and the skills that ship with them. It is for workspace users who build automations (Admin or Owner Role).
- Choosing Which Extensions to Install
- What the Extensions Cover
- Creating the NinjaOne API Application
- Providing the Credentials to Your Runner
- Reads and Approval-Gated Changes
- Skills
- Tips for Working With NinjaOne RMM
Choosing Which Extensions to Install
The NinjaOne RMM extensions come in four versions in the catalog:
| Extension | Tools | Install it for |
| NinjaOne RMM — Devices & Inventory | 56 tools: 46 reads and 10 writes | Looking up managed devices and pulling estate-wide reports on OS, disks, software, patches, antivirus, and device health, plus backup jobs, unmanaged devices, and vulnerability scan groups |
| NinjaOne RMM — Management & Automation | 45 tools: 7 reads and 38 writes | Acting on devices: running scripts, patch scans and installs, reboots, maintenance windows, and Windows services, and managing policies, organizations, locations, contacts, end users, and technicians |
| NinjaOne RMM — Organizations, Assets & System | 77 tools: 53 reads and 24 writes | Account structure and data: organizations, locations, groups, device lists and search, alerts, jobs, custom fields and tabs, asset tags and relationships, software licenses, users, and webhooks |
| NinjaOne RMM (Read-Only) | 106 tools, all reads | A strict read-only connection, or a NinjaOne API application that has only the Monitoring scope |
All NinjaOne extensions, including the NinjaOne PSA extensions, use the same three secrets, so you configure them once and every NinjaOne extension you install works. Install the extensions you need from Extensions like any other catalog extension. See Browsing and installing extensions for the general install flow.
Staying Within the Tool Limit
An agent run can load at most 128 tools, which is why NinjaOne is split into several extensions. Scope each agent to only the extensions its task needs. For example, Devices & Inventory and Management & Automation together have 101 tools and fit in one run, but all three RMM extensions together have 178 and do not. See Creating custom agents and using them in workflows.
When to Choose Read-Only
Choose NinjaOne RMM (Read-Only) when agents should only look up and report, or when your NinjaOne API application has only the Monitoring scope. The three standard extensions request the Monitoring, Management, and Control scopes, so they need an API application that allows all three. Read-Only requests only Monitoring, which NinjaOne defines as read-only access to monitoring data and organization structure. It contains every read tool from the three standard extensions, unchanged, and none of their write, delete, or remote-control tools.
Install Read-Only instead of the three standard RMM extensions, not beside them. They share tool names, so an agent scoped to both would call a shared tool with whichever extension's connection settings loaded last. If you do have both in one workspace, never scope an agent to both. Read-Only fits within the tool limit on its own, but not in one run together with NinjaOne PSA (Read-Only).
What the Extensions Cover
The extensions call the NinjaOne Public API v2. The three standard extensions have 178 tools between them; the tables below group each one's tools by area.
NinjaOne RMM — Devices & Inventory
| Area | Tools | What you can automate |
| Device details | 17 | Read one device's details, alerts, activities, active jobs, disks, volumes, processors, network interfaces, Windows services, software inventory, OS and software patch history, pending, failed, or rejected patches, last logged-on user, custom fields, and policy overrides |
| Estate-wide reports | 24 | Report across devices on antivirus status and threats, computer systems, operating systems, device health, disks, volumes, RAID, processors, network interfaces, software, patches, Windows services, last logged-on users, backup usage, policy overrides, and custom fields |
| Unmanaged devices | 6 | Create, update, decommission, and delete unmanaged devices, and create a staged device |
| Backup | 4 | Read backup jobs and integrity check jobs, start an integrity check, and set a device's backup bandwidth throttle |
| Vulnerability management | 3 | Read vulnerability scan groups and upload a CSV to a scan group |
| Node roles | 2 | Read and delete node roles |
NinjaOne RMM — Management & Automation
| Area | Tools | What you can automate |
| Device actions | 15 | Reboot a device, run a script or built-in action, read scripting options, approve or reject devices, reset an alert, schedule or cancel maintenance, control and configure Windows services, update device information, set or remove a device owner, reset policy overrides, decommission a device, and get a device link |
| Patching | 4 | Run OS and software patch scans, and apply OS and software patches |
| Policies | 8 | Create a policy, and read, create, and delete custom-field and Windows event policy conditions |
| Organizations and locations | 6 | Create and update organizations and locations, and generate an agent installer |
| People | 12 | Create, update, and delete contacts, end users, and technicians, change an end user's device access, and add or remove user role members |
NinjaOne RMM — Organizations, Assets & System
| Area | Tools | What you can automate |
| Account-wide lists | 24 | List and search devices, and list organizations, locations, policies, alerts, active jobs, activities, scheduled tasks, automation scripts, groups, device roles, notification channels, users, end users, technicians, contacts, user roles, and supported third-party software |
| Organizations, locations, and groups | 9 | Read an organization's information, locations, devices, users, custom fields, and backup usage, read a location's custom fields, and read a group's member devices |
| Custom fields | 9 | Read custom fields, and create, update, and delete them one at a time or in bulk |
| Custom tabs | 11 | Read the custom tabs for organizations, end users, and roles, and create, update, rename, and delete tabs |
| Asset tags | 7 | Read tags, create, update, delete, and merge tags, and tag assets one at a time or in a batch |
| Asset relationships | 5 | Read relationships and relationship types, create a relationship type, and delete relationships |
| Software licenses | 7 | Read licenses and their assignments, and create, update, and delete licenses |
| Users | 3 | Read end user and technician details and end user custom fields |
| Webhooks | 2 | Configure or remove the API webhook |
NinjaOne RMM (Read-Only)
Read-Only has the 106 read tools from the three tables above: 46 from Devices & Inventory, 7 from Management & Automation, and 53 from Organizations, Assets & System. It covers every area that has reads; unmanaged devices and webhooks have none, so they are not in Read-Only.
Creating the NinjaOne API Application
The extensions sign in with OAuth client credentials. The runner exchanges a NinjaOne API application's Client ID and Client Secret for a short-lived access token and caches it. In NinjaOne, go to Administration > Apps > API, open the Client App IDs tab, and add a client app. For Application Platform, select API Services (machine-to-machine), enable the Client Credentials grant type, and choose its scopes. NinjaOne defines the scopes as:
- Monitoring: read-only access to monitoring data and organization structure
- Management: modification of device and organization information
- Control: remote access through the API
For the three standard extensions, allow all three scopes. For NinjaOne RMM (Read-Only), allow Monitoring only. Copy the application's Client ID and Client Secret. For NinjaOne's own steps, see API OAuth Token Configuration.
Providing the Credentials to Your Runner
Store three secrets in your runner's Key Vault with these exact names. Every NinjaOne extension, RMM and PSA, uses the same secrets.
| Secret | Value |
NinjaOne-ApiUrl |
The NinjaOne host you sign in to, with no trailing slash, for example https://app.ninjarmm.com. Regional hosts are eu.ninjarmm.com, ca.ninjarmm.com, oc.ninjarmm.com, and us2.ninjarmm.com. |
NinjaOne-ClientId |
The Client ID of the API application |
NinjaOne-ClientSecret |
The Client Secret of the same application |
For how to add secrets, see Accessing and updating your runner's Key Vault. The agent reads the credentials from the runner and never asks you for them.
Reads and Approval-Gated Changes
Tools that only read run without interruption. Every tool that changes something in NinjaOne is approval-gated: the run pauses and the request appears as an Action Required item in the Inbox until someone approves it. See Handling Action Required items in the Inbox.
| Extension | Run without approval | Approval-gated |
| Devices & Inventory | 42 reads | 14: the 10 writes and 4 custom-field reports |
| Management & Automation | 7 reads | 38 writes |
| Organizations, Assets & System | 53 reads | 24 writes |
| Read-Only | 102 reads | 4 custom-field reports |
The four custom-field reports (the custom fields report, the detailed report, and their scoped versions) only read, but they ask for approval because they can return secure custom-field values as plain text. Approve one only if it is acceptable for those values to appear in the run's output.
Before a write, check the device or organization and the change the agent names. Take extra care with requests that:
- Reboot a device, run a script or built-in action, or control a Windows service
- Apply OS or software patches
- Decommission a device or delete an unmanaged device
- Delete contacts, end users, technicians, custom fields, tags, or software licenses
- Change a user role's members or an end user's device access
Skills
Each standard extension ships one skill per area of the API, 18 in all:
| Skill | Extension | Use it to |
| NinjaOne — devices | Devices & Inventory | Look up one device's hardware, software, patches, alerts, jobs, activities, and custom fields |
| NinjaOne — queries | Devices & Inventory | Pull estate-wide inventory, patch, antivirus, health, and custom-field reports |
| NinjaOne — Unmanaged Devices | Devices & Inventory | Create, update, decommission, or delete unmanaged devices, and create staged devices |
| NinjaOne — Node Roles | Devices & Inventory | Review or delete node roles |
| NinjaOne — Backup | Devices & Inventory | Review backup and integrity check jobs, start an integrity check, or set a backup bandwidth throttle |
| NinjaOne — Vulnerability Management | Devices & Inventory | Review vulnerability scan groups or upload a scan CSV |
| NinjaOne — management | Management & Automation | Act on devices, run patching, manage policies, and manage organizations, locations, and people |
| NinjaOne — organization | Organizations, Assets & System | Read an organization's information, locations, devices, users, custom fields, and backup usage |
| NinjaOne — Location | Organizations, Assets & System | Read a location's custom fields |
| NinjaOne — groups | Organizations, Assets & System | Read a group's member devices |
| NinjaOne — system | Organizations, Assets & System | List and search devices, organizations, policies, alerts, jobs, scripts, users, and other account-wide data |
| NinjaOne — Custom Fields | Organizations, Assets & System | Read and manage custom fields |
| NinjaOne — Custom Tabs | Organizations, Assets & System | Read and manage custom tabs |
| NinjaOne — Asset Tags | Organizations, Assets & System | Read and manage asset tags |
| NinjaOne — Asset Relationships | Organizations, Assets & System | Read and manage asset relationships and relationship types |
| NinjaOne — Software Licenses | Organizations, Assets & System | Read and manage software licenses and their assignments |
| NinjaOne — Users | Organizations, Assets & System | Read end user and technician details |
| NinjaOne — webhooks | Organizations, Assets & System | Configure or remove the API webhook |
NinjaOne RMM (Read-Only) ships 16 matching skills named NinjaOne: area, for example NinjaOne: devices, one for each area that has reads. Each covers only that area's read tools.
Tips for Working With NinjaOne RMM
- Many list and report tools accept a device filter, such as
org = 123orstatus eq APPROVED. In a large estate, ask the agent to narrow a request to one organization. - The estate-wide report tools and the custom fields list return the complete result in one call, so you don't need to page through them
- The device, organization, and location lists return results in batches. To get the next batch, pass the id of the last item from the previous one.
- Organization, device, location, policy, and node-role ids are numbers; alert and job ids are strings
- If calls fail, check that
NinjaOne-ApiUrlis the host you sign in to, with no trailing slash, and that the API application allows the scopes the extension requests: all three for the standard extensions, Monitoring for Read-Only - To try a prompt against NinjaOne before you build a workflow, see Testing your setup in the AI Playground
If you are still having trouble, we’re here to help! Submit a ticket here for assistance, and don’t forget to check our status page to ensure there are no outages in your area.
Comments
0 comments
Please sign in to leave a comment.