read thedocs.

[ docs // guides & reference ]

Connector setup guides, tool references, auth flows, and platform concepts — everything you need to run StackJack, in one place.

Browse the Docs All Connectors
34 connectors documented // 6,712 tools referenced // setup, auth & platform guides
↓

No pages match that search. Clear it

← All documentation

NinjaRMM Tools

ninja_ · 130 tools · Free 60 · Pro 70 OAuth2; max page size 1000; raw JSON passthrough.

Organizations

Tool Plan Access Description
ninja_add_organization_location Pro Write [NinjaRMM] Add a new location to an organization. Side effect: creates a new location.
ninja_get_organization Free Read-only [NinjaRMM] Get detailed information for a single organization including name, description, custom fields, and settings. Use ninja_list_organizations first to find valid organization IDs.
ninja_get_organization_devices Free Read-only [NinjaRMM] List all devices belonging to a specific organization. Returns device IDs, names, OS, and status. Use ninja_list_organizations first to find valid organization IDs. Use ninja_list_devices with 'org=ID' filter for pagination support.
ninja_get_organization_end_users Free Read-only [NinjaRMM] List end users belonging to an organization.
ninja_get_organization_locations Free Read-only [NinjaRMM] List all locations (offices/sites) for a specific organization. Returns location IDs, names, and addresses. Use ninja_list_organizations first to find valid organization IDs.
ninja_list_organizations Free Read-only [NinjaRMM] List all organizations (clients/customers) in your NinjaOne instance with cursor-based pagination. Returns organization ID, name, description, and device count. Use organization IDs with ninja_get_organization_devices and ninja_get_organization_locations.
ninja_list_organizations_detailed Free Read-only [NinjaRMM] List organizations with full detail including custom fields and policy mappings.
ninja_update_organization Pro Write [NinjaRMM] Update organization properties. Side effect: modifies organization information.
ninja_update_organization_location Pro Write [NinjaRMM] Update a location within an organization. Side effect: modifies location properties.
ninja_add_organization_location parameters
Param Type Required Default Description
address string no null Address of the location. Optional.
description string no null Description of the location. Optional.
name string yes Name of the new location.
organizationId integer yes The organization ID to add the location to. Use ninja_list_organizations to find valid IDs.
ninja_get_organization parameters
Param Type Required Default Description
organizationId integer yes The organization ID. Use ninja_list_organizations to find valid IDs.
ninja_get_organization_devices parameters
Param Type Required Default Description
after integer no null Last device ID from previous page for cursor pagination. Omit for the first page.
organizationId integer yes The organization ID. Use ninja_list_organizations to find valid IDs.
pageSize integer no 50 Results per page. Default 50, max 1000.
ninja_get_organization_end_users parameters
Param Type Required Default Description
organizationId integer yes The organization ID. Use ninja_list_organizations to find valid IDs.
ninja_get_organization_locations parameters
Param Type Required Default Description
organizationId integer yes The organization ID. Use ninja_list_organizations to find valid IDs.
ninja_list_organizations parameters
Param Type Required Default Description
after integer no null Last organization ID from previous page for cursor pagination. Omit for the first page.
organizationFilter string no null NinjaOne organization filter expression (advanced, rarely needed). WARNING: This does NOT accept plain text organization names — it uses NinjaOne's internal filter syntax. For most use cases, omit this parameter to list all organizations and search the results.
pageSize integer no 50 Results per page. Default 50, max 1000. Use smaller values for faster responses.
ninja_list_organizations_detailed parameters
Param Type Required Default Description
after integer no null Last organization ID from previous page for cursor pagination. Omit for the first page.
pageSize integer no 50 Results per page. Default 50, max 1000.
ninja_update_organization parameters
Param Type Required Default Description
fieldsJson string yes JSON object with fields to update (e.g. {"name":"New Name","description":"Updated desc","userData":,"nodeApprovalMode":"AUTOMATIC"}). Only include fields you want to change.
organizationId integer yes The organization ID to update. Use ninja_list_organizations to find valid IDs.
ninja_update_organization_location parameters
Param Type Required Default Description
fieldsJson string yes JSON object with fields to update (e.g. {"name":"New Name","address":"123 Main St"}). Only include fields you want to change.
locationId integer yes The location ID to update. Use ninja_get_organization_locations to find valid IDs.
organizationId integer yes The organization ID. Use ninja_list_organizations to find valid IDs.

Devices

Tool Plan Access Description
ninja_get_device Free Read-only [NinjaRMM] Get detailed information for a single device including system info, status, custom fields, and last contact time. Use ninja_list_devices or ninja_search_devices first to find the device ID.
ninja_get_device_activities Free Read-only [NinjaRMM] Get recent activity log entries for a specific device. Returns timestamped activity records including reboots, patches, scripts, and alerts. Use ninja_list_activities for fleet-wide activity.
ninja_get_device_alerts Free Read-only [NinjaRMM] Get active alerts for a specific device. Returns alert UID, message, severity, and timestamp. Use ninja_list_alerts for fleet-wide alerts. Use ninja_reset_alert to acknowledge.
ninja_get_device_dashboard_url Free Read-only [NinjaRMM] Get the NinjaRMM dashboard URL for a device.
ninja_get_device_disks Free Read-only [NinjaRMM] Get disk drive information for a device including model, size, and health status.
ninja_get_device_jobs Free Read-only [NinjaRMM] Get currently running (active) jobs for a device.
ninja_get_device_last_logged_on_user Free Read-only [NinjaRMM] Get the last logged-on user information for a device.
ninja_get_device_network_interfaces Free Read-only [NinjaRMM] Get network interface information for a device including IP addresses, MAC addresses, and adapter names.
ninja_get_device_os_patch_installs Free Read-only [NinjaRMM] Get OS patch installation history for a device.
ninja_get_device_os_patches Free Read-only [NinjaRMM] Get pending OS patches for a specific device. Returns patch names, KB numbers, severity, and install status. Use ninja_scan_os_patches first to ensure the list is current. Use ninja_apply_os_patches to install.
ninja_get_device_policy_overrides Free Read-only [NinjaRMM] Get summary of device policy overrides.
ninja_get_device_processors Free Read-only [NinjaRMM] Get processor information for a device including model, speed, and core count.
ninja_get_device_software Free Read-only [NinjaRMM] Get installed software inventory for a specific device. Returns application names, versions, publishers, and install dates. Use ninja_query_software for fleet-wide software inventory.
ninja_get_device_software_patch_installs Free Read-only [NinjaRMM] Get software patch installation history for a device.
ninja_get_device_software_patches Free Read-only [NinjaRMM] Get pending, failed, and rejected software patches for a device.
ninja_get_device_volumes Free Read-only [NinjaRMM] Get storage volume information for a device including drive letters, capacity, and free space.
ninja_get_device_warranty Free Read-only [NinjaRMM] Get device warranty information including start date, end date, and manufacturer fulfillment date. Warranty data is in the references.warranty object of the response.
ninja_get_device_windows_services Free Read-only [NinjaRMM] Get Windows services installed on a device including service name, display name, state, and start type.
ninja_list_devices Free Read-only [NinjaRMM] List all managed devices with optional filtering and cursor-based pagination. Returns device ID, name, OS, status, and organization. Use ninja_search_devices for finding specific devices by name. Use ninja_list_devices_detailed for full hardware/software detail.
ninja_list_devices_detailed Free Read-only [NinjaRMM] List devices with full hardware, software, and configuration detail. Returns comprehensive device info including CPU, RAM, disk, OS version, and custom fields. Slower than ninja_list_devices; use only when full detail is needed.
ninja_search_devices Free Read-only [NinjaRMM] Search devices by name, hostname, serial number, or other identifying information. Returns matching devices with ID, name, and organization. Preferred over ninja_list_devices when looking for a specific device.
ninja_get_device parameters
Param Type Required Default Description
deviceId integer yes The device ID. Use ninja_list_devices or ninja_search_devices to find valid IDs.
ninja_get_device_activities parameters
Param Type Required Default Description
activityType string no null Filter by activity type (e.g. PATCH_MANAGEMENT, CONDITION, ACTION, SCRIPT).
deviceId integer yes The device ID. Use ninja_list_devices or ninja_search_devices to find valid IDs.
newerThan integer no null Return activities newer than this activity ID (cursor pagination backward).
olderThan integer no null Return activities older than this activity ID (cursor pagination forward). Get from previous response.
pageSize integer no 50 Results per page. Default 50, max 1000.
status string no null Filter by activity status.
ninja_get_device_alerts parameters
Param Type Required Default Description
deviceId integer yes The device ID. Use ninja_list_devices or ninja_search_devices to find valid IDs.
ninja_get_device_dashboard_url parameters
Param Type Required Default Description
deviceId integer yes The device ID. Use ninja_list_devices or ninja_search_devices to find valid IDs.
ninja_get_device_disks parameters
Param Type Required Default Description
deviceId integer yes The device ID. Use ninja_list_devices or ninja_search_devices to find valid IDs.
ninja_get_device_jobs parameters
Param Type Required Default Description
deviceId integer yes The device ID. Use ninja_list_devices or ninja_search_devices to find valid IDs.
ninja_get_device_last_logged_on_user parameters
Param Type Required Default Description
deviceId integer yes The device ID. Use ninja_list_devices or ninja_search_devices to find valid IDs.
ninja_get_device_network_interfaces parameters
Param Type Required Default Description
deviceId integer yes The device ID. Use ninja_list_devices or ninja_search_devices to find valid IDs.
ninja_get_device_os_patch_installs parameters
Param Type Required Default Description
deviceId integer yes The device ID. Use ninja_list_devices or ninja_search_devices to find valid IDs.
ninja_get_device_os_patches parameters
Param Type Required Default Description
deviceId integer yes The device ID. Use ninja_list_devices or ninja_search_devices to find valid IDs.
severity string no null Filter by patch severity. Omit for all severities.
status string no null Filter by patch status (e.g. PENDING, FAILED, REJECTED). Omit for all statuses.
type string no null Filter by patch type. Omit for all types.
ninja_get_device_policy_overrides parameters
Param Type Required Default Description
deviceId integer yes The device ID. Use ninja_list_devices or ninja_search_devices to find valid IDs.
ninja_get_device_processors parameters
Param Type Required Default Description
deviceId integer yes The device ID. Use ninja_list_devices or ninja_search_devices to find valid IDs.
ninja_get_device_software parameters
Param Type Required Default Description
deviceId integer yes The device ID. Use ninja_list_devices or ninja_search_devices to find valid IDs.
ninja_get_device_software_patch_installs parameters
Param Type Required Default Description
deviceId integer yes The device ID. Use ninja_list_devices or ninja_search_devices to find valid IDs.
ninja_get_device_software_patches parameters
Param Type Required Default Description
deviceId integer yes The device ID. Use ninja_list_devices or ninja_search_devices to find valid IDs.
ninja_get_device_volumes parameters
Param Type Required Default Description
deviceId integer yes The device ID. Use ninja_list_devices or ninja_search_devices to find valid IDs.
ninja_get_device_warranty parameters
Param Type Required Default Description
deviceId integer yes The device ID. Use ninja_list_devices or ninja_search_devices to find valid IDs.
ninja_get_device_windows_services parameters
Param Type Required Default Description
deviceId integer yes The device ID. Use ninja_list_devices or ninja_search_devices to find valid IDs.
ninja_list_devices parameters
Param Type Required Default Description
after integer no null Last device ID from previous page for cursor pagination. Omit for the first page.
deviceFilter string no null Device filter expression (e.g. 'class=WINDOWS_SERVER AND online', 'org=5'). See NinjaOne device filter syntax. Omit for all devices.
pageSize integer no 50 Results per page. Default 50, max 1000. Use smaller values for faster responses.
ninja_list_devices_detailed parameters
Param Type Required Default Description
after integer no null Last device ID from previous page for cursor pagination. Omit for the first page.
deviceFilter string no null Device filter expression (e.g. 'class=WINDOWS_SERVER', 'org=5 AND online'). Omit for all devices.
pageSize integer no 50 Results per page. Default 50, max 1000. Use smaller values for faster responses due to large payload size.
ninja_search_devices parameters
Param Type Required Default Description
limit integer no 50 Maximum results to return. Default 50, max 1000. Use smaller values for faster responses.
query string yes Search query string. Matches against device name, hostname, serial number, and other fields.

Custom Fields

Tool Plan Access Description
ninja_get_custom_field_definition Free Read-only [NinjaRMM] Get a specific custom field definition by field name. Returns type, label, options, and permission settings.
ninja_get_device_custom_fields Free Read-only [NinjaRMM] Get custom field values for a device. Returns all custom field names and their current values.
ninja_get_location_custom_fields Free Read-only [NinjaRMM] Get custom field values for an organization location.
ninja_get_organization_custom_fields Free Read-only [NinjaRMM] Get custom field values for an organization.
ninja_list_custom_field_definitions Free Read-only [NinjaRMM] List all custom field definitions with pagination. Returns field names, types, labels, and permission settings.
ninja_list_device_custom_field_definitions Free Read-only [NinjaRMM] List device custom field definitions, optionally filtered by scope.
ninja_query_custom_fields Pro Read-only [NinjaRMM] Fleet-wide custom field values report. Returns custom field values across all devices with pagination.
ninja_query_custom_fields_detailed Pro Read-only [NinjaRMM] Detailed fleet-wide custom field values report with additional device information.
ninja_update_device_custom_fields Pro Write [NinjaRMM] Update custom field values for a device. Side effect: modifies device custom fields. Pass a JSON object mapping field names to values.
ninja_update_location_custom_fields Pro Write [NinjaRMM] Update custom field values for an organization location. Side effect: modifies location custom fields.
ninja_update_organization_custom_fields Pro Write [NinjaRMM] Update custom field values for an organization. Side effect: modifies organization custom fields.
ninja_get_custom_field_definition parameters
Param Type Required Default Description
fieldName string yes The custom field name.
ninja_get_device_custom_fields parameters
Param Type Required Default Description
deviceId integer yes The device ID. Use ninja_list_devices or ninja_search_devices to find valid IDs.
ninja_get_location_custom_fields parameters
Param Type Required Default Description
locationId integer yes The location ID.
organizationId integer yes The organization ID.
withInheritance boolean no null Include inherited custom field values from the organization. Omit for location-level values only.
ninja_get_organization_custom_fields parameters
Param Type Required Default Description
organizationId integer yes The organization ID.
ninja_list_custom_field_definitions parameters
Param Type Required Default Description
cursor string no null Cursor string from previous page's response for pagination. Omit for the first page.
pageSize integer no 50 Results per page. Default 50, max 500.
ninja_list_device_custom_field_definitions parameters
Param Type Required Default Description
scopes string no null Filter by scope (e.g. 'all', 'node', 'location', 'organization'). Omit for all scopes.
ninja_query_custom_fields parameters
Param Type Required Default Description
cursor string no null Cursor string from previous page's response for pagination. Omit for the first page.
deviceFilter string no null Device filter expression (e.g. 'org=5', 'class=WINDOWS_WORKSTATION'). Omit for entire fleet.
fields string no null Comma-separated list of custom field names to include. Omit for all fields.
pageSize integer no 200 Results per page. Default 200, max 1000. Larger pages are more efficient for bulk queries.
updatedAfter string no null ISO 8601 timestamp to filter for values updated after this time (e.g. '2024-01-15T00:00:00Z'). Omit for all values.
ninja_query_custom_fields_detailed parameters
Param Type Required Default Description
cursor string no null Cursor string from previous page's response for pagination. Omit for the first page.
deviceFilter string no null Device filter expression (e.g. 'org=5', 'class=WINDOWS_WORKSTATION'). Omit for entire fleet.
fields string no null Comma-separated list of custom field names to include. Omit for all fields.
pageSize integer no 200 Results per page. Default 200, max 1000. Larger pages are more efficient for bulk queries.
updatedAfter string no null ISO 8601 timestamp to filter for values updated after this time (e.g. '2024-01-15T00:00:00Z'). Omit for all values.
ninja_update_device_custom_fields parameters
Param Type Required Default Description
deviceId integer yes The device ID. Use ninja_list_devices or ninja_search_devices to find valid IDs.
fieldsJson string yes JSON object mapping field names to values (e.g. {"fieldName": "value"}). Only include fields you want to change.
ninja_update_location_custom_fields parameters
Param Type Required Default Description
fieldsJson string yes JSON object mapping field names to values (e.g. {"fieldName": "value"}). Only include fields you want to change.
locationId integer yes The location ID.
organizationId integer yes The organization ID.
ninja_update_organization_custom_fields parameters
Param Type Required Default Description
fieldsJson string yes JSON object mapping field names to values (e.g. {"fieldName": "value"}). Only include fields you want to change.
organizationId integer yes The organization ID.

Alerts

Tool Plan Access Description
ninja_delete_alert Free Destructive [NinjaRMM] Delete/dismiss an alert by its UID. Side effect: permanently removes the alert.
ninja_list_alerts Free Read-only [NinjaRMM] List all active alerts across your NinjaOne environment. Returns alert UID, message, severity, source type, device ID, and timestamp. Use ninja_get_device_alerts for a single device's alerts. Use ninja_reset_alert to acknowledge an alert.
ninja_reset_alert Free Write [NinjaRMM] Acknowledge and reset an active alert by its UID. Side effect: clears the alert from the active alerts list. Use ninja_list_alerts to find alert UIDs.
ninja_delete_alert parameters
Param Type Required Default Description
alertUid string yes The alert UID to delete. Use ninja_list_alerts to find valid UIDs.
ninja_list_alerts parameters
Param Type Required Default Description
deviceFilter string no null Device filter expression (e.g. 'class=WINDOWS_SERVER', 'org=5 AND online'). See NinjaOne device filter syntax.
sourceType string no null Filter by alert source type (e.g. 'CONDITION', 'MONITOR'). Omit for all source types.
ninja_reset_alert parameters
Param Type Required Default Description
alertUid string yes The alert UID to reset. Use ninja_list_alerts to find valid UIDs.

Activities

Tool Plan Access Description
ninja_list_activities Free Read-only [NinjaRMM] Retrieve activity log entries with optional filtering by class, type, status, date range, or device. Returns timestamped activity records including source, message, and severity. Use ninja_get_device_activities for a single device's history.
ninja_list_activities parameters
Param Type Required Default Description
activityClass string no null Activity class filter. Must be 'System' or 'Device'. Omit to return both.
afterDate string no null Return activities after this date. Format: yyyy-MM-dd.
before string no null Return activities before this date. Format: yyyy-MM-dd.
deviceFilter string no null Device filter expression (e.g. 'class=WINDOWS_SERVER AND online', 'org=5'). See NinjaOne device filter syntax.
pageSize integer no 50 Results per page. Default 50, max 1000. Use smaller values for faster responses.
status string no null Activity status filter (e.g. 'COMPLETED', 'FAILED'). Omit for all statuses.
type string no null Activity type filter (e.g. 'ACTION_REBOOT', 'ALERT_TRIGGERED'). Omit for all types.

System

Tool Plan Access Description
ninja_get_group_device_ids Free Read-only [NinjaRMM] Get all device IDs that are members of a specific group or saved search. Returns an array of device IDs. Use ninja_list_groups first to find valid group IDs. Use ninja_get_device to look up details for each device.
ninja_list_groups Free Read-only [NinjaRMM] List all device groups and saved searches. Returns group IDs, names, and descriptions. Use ninja_get_group_device_ids with a group ID to retrieve member devices.
ninja_list_jobs Free Read-only [NinjaRMM] List currently active jobs across all devices. Returns job type, status, device ID, and progress. Use ninja_get_device_jobs for a single device's active jobs.
ninja_list_locations Free Read-only [NinjaRMM] List all locations across all organizations with cursor-based pagination. Returns location IDs, names, addresses, and parent organization IDs. Use ninja_get_organization_locations for a specific organization's locations.
ninja_list_notification_channels Free Read-only [NinjaRMM] List available notification channels configured in NinjaOne. Returns channel names, types, and enabled status.
ninja_list_policies Free Read-only [NinjaRMM] List all policies configured in NinjaOne. Returns policy IDs, names, and types. Use ninja_set_organization_policies to assign policies to organizations.
ninja_list_roles Free Read-only [NinjaRMM] List all device roles defined in NinjaOne. Returns role IDs and names. Device roles determine which policies apply to a device.
ninja_list_software_products Free Read-only [NinjaRMM] List supported third-party software products available for patch management. Returns product names and IDs used for software patch configuration.
ninja_list_tasks Free Read-only [NinjaRMM] List scheduled tasks across the NinjaOne environment. Returns task names, schedules, and target scopes.
ninja_get_group_device_ids parameters
Param Type Required Default Description
groupId integer yes The group ID. Use ninja_list_groups to find valid IDs.
ninja_list_locations parameters
Param Type Required Default Description
after integer no null Last location ID from previous page for cursor pagination. Omit for the first page.
pageSize integer no 50 Results per page. Default 50, max 1000. Use smaller values for faster responses.

Users

Tool Plan Access Description
ninja_create_contact Pro Write [NinjaRMM] Create a new contact. Side effect: creates a contact record.
ninja_delete_contact Pro Destructive [NinjaRMM] Delete a contact. Side effect: permanently removes the contact.
ninja_get_contact Pro Read-only [NinjaRMM] Get detailed information for a specific contact including name, email, phone, and organization. Use ninja_list_contacts first to find valid contact IDs.
ninja_list_contacts Pro Read-only [NinjaRMM] List all contacts in NinjaOne ticketing. Returns contact IDs, names, emails, and associated organizations. Use to find contact IDs for ticket assignment or lookup.
ninja_update_contact Pro Write [NinjaRMM] Update contact information. Side effect: modifies contact properties.
ninja_create_contact parameters
Param Type Required Default Description
email string yes Contact email address.
firstName string yes Contact first name.
jobTitle string no null Contact job title.
lastName string yes Contact last name.
organizationId integer yes Organization ID to associate the contact with.
phone string no null Contact phone number.
ninja_delete_contact parameters
Param Type Required Default Description
contactId integer yes The contact ID to delete.
ninja_get_contact parameters
Param Type Required Default Description
contactId integer yes The contact ID. Use ninja_list_contacts to find valid IDs.
ninja_update_contact parameters
Param Type Required Default Description
contactId integer yes The contact ID to update.
fieldsJson string yes JSON object with fields to update. Only include fields you want to change.

End Users

Tool Plan Access Description
ninja_create_end_user Pro Write [NinjaRMM] Create a new end user. Side effect: creates an end user account. Use ninja_list_end_users to verify creation.
ninja_delete_end_user Pro Destructive [NinjaRMM] Delete an end user. Side effect: permanently removes the end user.
ninja_get_end_user_custom_fields Pro Read-only [NinjaRMM] Get custom field values for an end user.
ninja_list_end_users Pro Read-only [NinjaRMM] List all end users. Returns user ID, name, email, and organization. Use ninja_get_end_user_custom_fields to read custom field values for a specific end user.
ninja_list_technicians Pro Read-only [NinjaRMM] List all technicians. Returns technician names, emails, and roles.
ninja_list_user_roles Pro Read-only [NinjaRMM] List all user roles. Returns role names and IDs used for permission management.
ninja_update_end_user Pro Write [NinjaRMM] Update an end user. Side effect: modifies end user properties.
ninja_update_end_user_custom_fields Pro Write [NinjaRMM] Update custom field values for an end user. Side effect: modifies end user custom fields.
ninja_create_end_user parameters
Param Type Required Default Description
fieldsJson string yes JSON object with end user properties (e.g. {"firstName":"John","lastName":"Doe","email":"john@example.com","organizationId":5}).
ninja_delete_end_user parameters
Param Type Required Default Description
endUserId integer yes The end user ID to delete.
ninja_get_end_user_custom_fields parameters
Param Type Required Default Description
endUserId integer yes The end user ID.
ninja_update_end_user parameters
Param Type Required Default Description
endUserId integer yes The end user ID to update.
fieldsJson string yes JSON object with fields to update. Only include fields you want to change.
ninja_update_end_user_custom_fields parameters
Param Type Required Default Description
endUserId integer yes The end user ID.
fieldsJson string yes JSON object with custom field values to update. Only include fields you want to change.

Device Management

Tool Plan Access Description
ninja_apply_os_patches Pro Write [NinjaRMM] Apply all pending OS patches to a device. Side effect: initiates patch installation which may require a reboot. Use ninja_scan_os_patches first to discover available patches, then ninja_get_device_os_patches to review before applying.
ninja_apply_software_patches Pro Write [NinjaRMM] Apply all pending third-party software patches to a device. Side effect: initiates software updates which may require application restarts. Use ninja_scan_software_patches first to discover available updates.
ninja_approve_devices Pro Write [NinjaRMM] Approve or reject pending devices. Side effect: changes device approval status.
ninja_clear_maintenance_mode Pro Write [NinjaRMM] Remove a device from maintenance mode, re-enabling alert monitoring. Side effect: alerts will resume immediately. Use ninja_get_device to verify current maintenance status.
ninja_configure_windows_service Pro Write [NinjaRMM] Configure a Windows service startup type on a device. Side effect: modifies service configuration.
ninja_control_windows_service Pro Write [NinjaRMM] Control a Windows service on a device (start, stop, pause, restart). Side effect: changes service state.
ninja_reboot_device Free Write [NinjaRMM] Reboot a managed device. Side effect: initiates a device reboot immediately. Use ninja_get_device first to verify the correct device. NORMAL mode waits for user logout; FORCED reboots immediately.
ninja_remove_device_owner Pro Destructive [NinjaRMM] Remove the owner from a device. Side effect: clears device owner assignment.
ninja_reset_device_policy_overrides Pro Destructive [NinjaRMM] Reset all policy overrides for a device back to inherited values. Side effect: removes all custom policy overrides.
ninja_scan_os_patches Free Write [NinjaRMM] Trigger an OS patch scan on a device to discover available Windows/macOS/Linux updates. Side effect: initiates a background scan. Use ninja_get_device_os_patches afterward to see results.
ninja_scan_software_patches Free Write [NinjaRMM] Trigger a third-party software patch scan on a device. Side effect: initiates a background scan for updates to installed applications. Results appear in software patch queries afterward.
ninja_set_device_owner Pro Write [NinjaRMM] Assign an owner to a device. Side effect: sets device owner.
ninja_set_maintenance_mode Pro Write [NinjaRMM] Put a device into maintenance mode for a scheduled window. Side effect: suppresses all alerts for the device during the maintenance period. Use ninja_clear_maintenance_mode to end early.
ninja_update_device Pro Write [NinjaRMM] Update device information. Side effect: modifies device properties.
ninja_update_device_warranty Pro Write [NinjaRMM] Update warranty dates for a device. Side effect: modifies device warranty info. Dates are Unix epoch seconds.
ninja_apply_os_patches parameters
Param Type Required Default Description
deviceId integer yes The device ID. Use ninja_list_devices or ninja_search_devices to find valid IDs.
ninja_apply_software_patches parameters
Param Type Required Default Description
deviceId integer yes The device ID. Use ninja_list_devices or ninja_search_devices to find valid IDs.
ninja_approve_devices parameters
Param Type Required Default Description
deviceIds array yes Array of device IDs to approve or reject.
mode string yes Approval mode. Must be 'APPROVE' or 'REJECT'.
ninja_clear_maintenance_mode parameters
Param Type Required Default Description
deviceId integer yes The device ID. Use ninja_list_devices or ninja_search_devices to find valid IDs.
ninja_configure_windows_service parameters
Param Type Required Default Description
deviceId integer yes The device ID. Use ninja_list_devices or ninja_search_devices to find valid IDs.
serviceId integer yes The service ID. Use ninja_get_device_windows_services to find valid IDs.
startType string yes Service startup type. Must be one of: AUTO_START, AUTO_START_DELAYED, BOOT_START, DEMAND_START, DISABLED, SYSTEM_START.
userName string no null Service logon account username. Optional.
ninja_control_windows_service parameters
Param Type Required Default Description
action string yes Action to perform. Must be 'START', 'STOP', 'PAUSE', or 'RESTART'.
deviceId integer yes The device ID. Use ninja_list_devices or ninja_search_devices to find valid IDs.
serviceId integer yes The service ID. Use ninja_get_device_windows_services to find valid IDs.
ninja_reboot_device parameters
Param Type Required Default Description
deviceId integer yes The device ID to reboot. Use ninja_list_devices or ninja_search_devices to find valid IDs.
mode string no "NORMAL" Reboot mode. Must be 'NORMAL' or 'FORCED'. NORMAL waits for user logout, FORCED reboots immediately.
reason string no null Reason for reboot. Recorded in audit trail. Optional.
ninja_remove_device_owner parameters
Param Type Required Default Description
deviceId integer yes The device ID. Use ninja_list_devices or ninja_search_devices to find valid IDs.
ninja_reset_device_policy_overrides parameters
Param Type Required Default Description
deviceId integer yes The device ID. Use ninja_list_devices or ninja_search_devices to find valid IDs.
ninja_scan_os_patches parameters
Param Type Required Default Description
deviceId integer yes The device ID to scan. Use ninja_list_devices or ninja_search_devices to find valid IDs.
ninja_scan_software_patches parameters
Param Type Required Default Description
deviceId integer yes The device ID to scan. Use ninja_list_devices or ninja_search_devices to find valid IDs.
ninja_set_device_owner parameters
Param Type Required Default Description
deviceId integer yes The device ID. Use ninja_list_devices or ninja_search_devices to find valid IDs.
ownerUid string yes The owner UID to assign to the device.
ninja_set_maintenance_mode parameters
Param Type Required Default Description
deviceId integer yes The device ID. Use ninja_list_devices or ninja_search_devices to find valid IDs.
end string yes Maintenance window end time in ISO 8601 format (e.g. '2025-01-15T06:00:00Z'). Must be after start.
start string yes Maintenance window start time in ISO 8601 format (e.g. '2025-01-15T02:00:00Z').
ninja_update_device parameters
Param Type Required Default Description
deviceId integer yes The device ID. Use ninja_list_devices or ninja_search_devices to find valid IDs.
fieldsJson string yes JSON string with fields to update (e.g. displayName, nodeRoleId, policyId, organizationId, locationId, userData).
ninja_update_device_warranty parameters
Param Type Required Default Description
deviceId integer yes The device ID. Use ninja_list_devices or ninja_search_devices to find valid IDs.
manufacturerFulfillmentDate integer no null Manufacturer fulfillment date as Unix epoch seconds. Optional.
warrantyEndDate integer yes Warranty end date as Unix epoch seconds.
warrantyStartDate integer yes Warranty start date as Unix epoch seconds.

Queries

Tool Plan Access Description
ninja_query_antivirus_status Pro Read-only [NinjaRMM] Bulk query antivirus status across the entire fleet. Returns AV product name, version, definition date, and real-time protection status per device. Use device filter to scope to specific organizations or device classes.
ninja_query_antivirus_threats Pro Read-only [NinjaRMM] Bulk query detected antivirus threats across the fleet. Returns threat name, severity, action taken, and affected device per detection. Use to identify active security incidents.
ninja_query_backup_usage Pro Read-only [NinjaRMM] Fleet-wide device backup usage report.
ninja_query_computer_systems Pro Read-only [NinjaRMM] Fleet-wide computer systems report including manufacturer, model, and serial number.
ninja_query_device_health Pro Read-only [NinjaRMM] Bulk query device health metrics across the fleet. Returns CPU usage, memory usage, disk space, and uptime per device. Use to identify resource-constrained devices.
ninja_query_disks Pro Read-only [NinjaRMM] Bulk query disk health and usage across the fleet. Returns disk capacity, free space, health status, and SMART data per device. Use to identify devices with low disk space or failing drives.
ninja_query_logged_on_users Pro Read-only [NinjaRMM] Fleet-wide last logged-on user report.
ninja_query_network_interfaces Pro Read-only [NinjaRMM] Fleet-wide network interface report including IP and MAC addresses.
ninja_query_operating_systems Pro Read-only [NinjaRMM] Bulk query OS information across the fleet. Returns OS name, version, build number, and architecture per device. Use to audit OS versions and identify devices needing upgrades.
ninja_query_os_patch_installs Pro Read-only [NinjaRMM] Fleet-wide OS patch installation history report.
ninja_query_os_patches Pro Read-only [NinjaRMM] Bulk query pending OS patches across the fleet. Returns patch names, KB numbers, severity, and affected device counts. Use to assess fleet-wide patch compliance. Use ninja_patch_compliance_report for a summarized view.
ninja_query_policy_overrides Pro Read-only [NinjaRMM] Fleet-wide summary of device policy overrides.
ninja_query_processors Pro Read-only [NinjaRMM] Fleet-wide processor report including model, speed, and core count.
ninja_query_raid_controllers Pro Read-only [NinjaRMM] Fleet-wide RAID controller report.
ninja_query_raid_drives Pro Read-only [NinjaRMM] Fleet-wide RAID drive report.
ninja_query_software Pro Read-only [NinjaRMM] Bulk query installed software inventory across the fleet. Returns application names, versions, publishers, and install counts. Use to find specific software deployments or audit license usage.
ninja_query_software_patch_installs Pro Read-only [NinjaRMM] Fleet-wide software patch installation history report.
ninja_query_software_patches Pro Read-only [NinjaRMM] Fleet-wide pending, failed, and rejected software patches report.
ninja_query_volumes Pro Read-only [NinjaRMM] Fleet-wide storage volume report including capacity and free space.
ninja_query_windows_services Pro Read-only [NinjaRMM] Bulk query Windows services status across the fleet. Returns service names, display names, start type, and current state per device. Use to verify critical services are running across all devices.
ninja_query_antivirus_status parameters
Param Type Required Default Description
cursor string no null Cursor string from previous page's response for pagination. Omit for the first page.
deviceFilter string no null Device filter expression (e.g. 'org=5', 'class=WINDOWS_WORKSTATION'). Omit for entire fleet.
pageSize integer no 200 Results per page. Default 200, max 1000. Larger pages are more efficient for bulk queries.
productState string no null Filter by AV product state (e.g. ON, OFF, EXPIRED, SNOOZED). Omit for all states.
ninja_query_antivirus_threats parameters
Param Type Required Default Description
cursor string no null Cursor string from previous page's response for pagination. Omit for the first page.
deviceFilter string no null Device filter expression (e.g. 'org=5', 'class=WINDOWS_WORKSTATION'). Omit for entire fleet.
pageSize integer no 200 Results per page. Default 200, max 1000. Larger pages are more efficient for bulk queries.
ninja_query_backup_usage parameters
Param Type Required Default Description
cursor string no null Cursor string from previous page's response for pagination. Omit for the first page.
deviceFilter string no null Device filter expression (e.g. 'org=5', 'class=WINDOWS_WORKSTATION'). Omit for entire fleet.
pageSize integer no 200 Results per page. Default 200, max 1000. Larger pages are more efficient for bulk queries.
ninja_query_computer_systems parameters
Param Type Required Default Description
cursor string no null Cursor string from previous page's response for pagination. Omit for the first page.
deviceFilter string no null Device filter expression (e.g. 'org=5', 'class=WINDOWS_WORKSTATION'). Omit for entire fleet.
pageSize integer no 200 Results per page. Default 200, max 1000. Larger pages are more efficient for bulk queries.
ninja_query_device_health parameters
Param Type Required Default Description
cursor string no null Cursor string from previous page's response for pagination. Omit for the first page.
deviceFilter string no null Device filter expression (e.g. 'org=5', 'class=WINDOWS_SERVER'). Omit for entire fleet.
health string no null Filter by health status (e.g. HEALTHY, UNHEALTHY). Omit for all.
pageSize integer no 200 Results per page. Default 200, max 1000. Larger pages are more efficient for bulk queries.
ninja_query_disks parameters
Param Type Required Default Description
cursor string no null Cursor string from previous page's response for pagination. Omit for the first page.
deviceFilter string no null Device filter expression (e.g. 'org=5', 'class=WINDOWS_SERVER'). Omit for entire fleet.
pageSize integer no 200 Results per page. Default 200, max 1000. Larger pages are more efficient for bulk queries.
ninja_query_logged_on_users parameters
Param Type Required Default Description
cursor string no null Cursor string from previous page's response for pagination. Omit for the first page.
deviceFilter string no null Device filter expression (e.g. 'org=5', 'class=WINDOWS_WORKSTATION'). Omit for entire fleet.
pageSize integer no 200 Results per page. Default 200, max 1000. Larger pages are more efficient for bulk queries.
ninja_query_network_interfaces parameters
Param Type Required Default Description
cursor string no null Cursor string from previous page's response for pagination. Omit for the first page.
deviceFilter string no null Device filter expression (e.g. 'org=5', 'class=WINDOWS_WORKSTATION'). Omit for entire fleet.
pageSize integer no 200 Results per page. Default 200, max 1000. Larger pages are more efficient for bulk queries.
ninja_query_operating_systems parameters
Param Type Required Default Description
cursor string no null Cursor string from previous page's response for pagination. Omit for the first page.
deviceFilter string no null Device filter expression (e.g. 'org=5', 'class=WINDOWS_SERVER'). Omit for entire fleet.
pageSize integer no 200 Results per page. Default 200, max 1000. Larger pages are more efficient for bulk queries.
ninja_query_os_patch_installs parameters
Param Type Required Default Description
cursor string no null Cursor string from previous page's response for pagination. Omit for the first page.
deviceFilter string no null Device filter expression (e.g. 'org=5', 'class=WINDOWS_WORKSTATION'). Omit for entire fleet.
pageSize integer no 200 Results per page. Default 200, max 1000. Larger pages are more efficient for bulk queries.
ninja_query_os_patches parameters
Param Type Required Default Description
cursor string no null Cursor string from previous page's response for pagination. Omit for the first page.
deviceFilter string no null Device filter expression (e.g. 'org=5', 'class=WINDOWS_SERVER'). Omit for entire fleet.
pageSize integer no 200 Results per page. Default 200, max 1000. Larger pages are more efficient for bulk queries.
patchStatus string no null Filter by patch status (PENDING, FAILED, REJECTED). Omit for all.
severity string no null Filter by patch severity. Omit for all.
type string no null Filter by patch type. Omit for all.
ninja_query_policy_overrides parameters
Param Type Required Default Description
cursor string no null Cursor string from previous page's response for pagination. Omit for the first page.
deviceFilter string no null Device filter expression (e.g. 'org=5', 'class=WINDOWS_WORKSTATION'). Omit for entire fleet.
pageSize integer no 200 Results per page. Default 200, max 1000. Larger pages are more efficient for bulk queries.
ninja_query_processors parameters
Param Type Required Default Description
cursor string no null Cursor string from previous page's response for pagination. Omit for the first page.
deviceFilter string no null Device filter expression (e.g. 'org=5', 'class=WINDOWS_WORKSTATION'). Omit for entire fleet.
pageSize integer no 200 Results per page. Default 200, max 1000. Larger pages are more efficient for bulk queries.
ninja_query_raid_controllers parameters
Param Type Required Default Description
cursor string no null Cursor string from previous page's response for pagination. Omit for the first page.
deviceFilter string no null Device filter expression (e.g. 'org=5', 'class=WINDOWS_SERVER'). Omit for entire fleet.
pageSize integer no 200 Results per page. Default 200, max 1000. Larger pages are more efficient for bulk queries.
ninja_query_raid_drives parameters
Param Type Required Default Description
cursor string no null Cursor string from previous page's response for pagination. Omit for the first page.
deviceFilter string no null Device filter expression (e.g. 'org=5', 'class=WINDOWS_SERVER'). Omit for entire fleet.
pageSize integer no 200 Results per page. Default 200, max 1000. Larger pages are more efficient for bulk queries.
ninja_query_software parameters
Param Type Required Default Description
cursor string no null Cursor string from previous page's response for pagination. Omit for the first page.
deviceFilter string no null Device filter expression (e.g. 'org=5', 'class=WINDOWS_WORKSTATION'). Omit for entire fleet.
pageSize integer no 200 Results per page. Default 200, max 1000. Larger pages are more efficient for bulk queries.
ninja_query_software_patch_installs parameters
Param Type Required Default Description
cursor string no null Cursor string from previous page's response for pagination. Omit for the first page.
deviceFilter string no null Device filter expression (e.g. 'org=5', 'class=WINDOWS_WORKSTATION'). Omit for entire fleet.
pageSize integer no 200 Results per page. Default 200, max 1000. Larger pages are more efficient for bulk queries.
ninja_query_software_patches parameters
Param Type Required Default Description
cursor string no null Cursor string from previous page's response for pagination. Omit for the first page.
deviceFilter string no null Device filter expression (e.g. 'org=5', 'class=WINDOWS_WORKSTATION'). Omit for entire fleet.
pageSize integer no 200 Results per page. Default 200, max 1000. Larger pages are more efficient for bulk queries.
ninja_query_volumes parameters
Param Type Required Default Description
cursor string no null Cursor string from previous page's response for pagination. Omit for the first page.
deviceFilter string no null Device filter expression (e.g. 'org=5', 'class=WINDOWS_WORKSTATION'). Omit for entire fleet.
pageSize integer no 200 Results per page. Default 200, max 1000. Larger pages are more efficient for bulk queries.
ninja_query_windows_services parameters
Param Type Required Default Description
cursor string no null Cursor string from previous page's response for pagination. Omit for the first page.
deviceFilter string no null Device filter expression (e.g. 'org=5', 'class=WINDOWS_SERVER'). Omit for entire fleet.
name string no null Filter by service name (e.g. 'Spooler', 'wuauserv'). Omit for all services.
pageSize integer no 200 Results per page. Default 200, max 1000. Larger pages are more efficient for bulk queries.
state string no null Filter by service state: UNKNOWN, STOPPED, START_PENDING, RUNNING, STOP_PENDING, PAUSE_PENDING, PAUSED, CONTINUE_PENDING. Omit for all.

Advanced Management

Tool Plan Access Description
ninja_create_organization Pro Write [NinjaRMM] Create a new organization (client/customer) in NinjaOne. Optionally clone from an existing organization using templateOrganizationId. Returns the created organization with its assigned ID. Side effect: creates a new billable organization in NinjaOne.
ninja_decommission_device Pro Write [NinjaRMM] Permanently decommission a device, removing it from active management. Side effect: the device will no longer be monitored or appear in active device lists. Use ninja_get_device first to verify the correct device.
ninja_generate_installer Pro Write [NinjaRMM] Generate an agent installer download link for an organization. Returns a URL to download the NinjaOne agent installer. Use ninja_list_organizations to get valid organization IDs.
ninja_create_organization parameters
Param Type Required Default Description
description string no null Organization description. Optional free-text summary.
fieldsJson string no null Additional fields as a JSON object (e.g. {"tags":["vip"],"location":"NYC"}). Optional.
name string yes Organization name. Must be unique across your NinjaOne instance.
templateOrganizationId integer no null Template organization ID to clone settings from. Use ninja_list_organizations to find valid IDs. Optional.
ninja_decommission_device parameters
Param Type Required Default Description
deviceId integer yes The device ID to decommission. Use ninja_list_devices or ninja_search_devices to find valid IDs.
ninja_generate_installer parameters
Param Type Required Default Description
installerType string no "WINDOWS_MSI" Installer type. Options: WINDOWS_MSI, WINDOWS_ARM64_MSI, MAC_DMG, MAC_PKG, LINUX_DEB, LINUX_RPM, LINUX_ARM64_DEB, LINUX_ARMV7A_DEB, LINUX_ARM64_RPM, LINUX_ARMV7A_RPM.
locationId integer no null Optional location ID within the organization.
organizationId integer yes The organization ID to generate an installer for. Use ninja_list_organizations to find valid IDs.

Ticketing

Tool Plan Access Description
ninja_add_ticket_comment Free Write [NinjaRMM] Add a comment or update the description on an existing ticket. Side effect: appends a comment visible to technicians. Use ninja_get_ticket first to see existing comments.
ninja_create_ticket Free Write [NinjaRMM] Create a new ticket in NinjaOne ticketing. Side effect: creates a support ticket visible to technicians. Returns the created ticket with its assigned ID. Use ninja_list_ticket_statuses to see valid status values.
ninja_get_ticket Free Read-only [NinjaRMM] Get full ticket detail including subject, description, comments, status, priority, and history. Use ninja_create_ticket or search for a ticket ID first.
ninja_get_ticket_form Free Read-only [NinjaRMM] Get details of a specific ticket form including fields and layout.
ninja_get_ticket_log_entries Free Read-only [NinjaRMM] Get log entries for a ticket including status changes, comments, and updates. Use type filter to narrow results.
ninja_list_ticket_attributes Free Read-only [NinjaRMM] List ticket attributes including custom fields and their allowed values.
ninja_list_ticket_boards Free Read-only [NinjaRMM] List available ticket boards. Returns board IDs and names. Use ninja_list_tickets_for_board to view tickets on a specific board.
ninja_list_ticket_forms Free Read-only [NinjaRMM] List available ticket forms. Returns form IDs and names. Use ninja_get_ticket_form for field details. Required when creating tickets with ninja_create_ticket.
ninja_list_ticket_statuses Free Read-only [NinjaRMM] List all available ticket statuses configured in NinjaOne. Returns status names and IDs. Use before ninja_create_ticket or ninja_update_ticket to find valid status values.
ninja_list_tickets_for_board Free Read-only [NinjaRMM] List tickets for a specific board (simplified). Returns ticket IDs, subjects, statuses, and priorities. Use ninja_list_ticket_boards first to find board IDs. Supports pagination via lastCursorId from previous response metadata. This is a simplified view — the NinjaOne API also supports server-side filters, sortBy, and includeColumns which are not exposed here; use searchCriteria for basic filtering.
ninja_update_ticket Free Write [NinjaRMM] Update an existing ticket's fields such as status, priority, or assignee. Side effect: modifies the ticket record. Use ninja_get_ticket first to see current values. Use ninja_list_ticket_statuses for valid status values.
ninja_add_ticket_comment parameters
Param Type Required Default Description
comment string yes Comment body text. Supports plain text.
ticketId integer yes The ticket ID to comment on.
type string no "COMMENT" Comment type. Must be 'COMMENT' or 'DESCRIPTION'. COMMENT adds a new note, DESCRIPTION updates the ticket body.
ninja_create_ticket parameters
Param Type Required Default Description
description string yes Ticket description with full detail of the issue or request.
nodeId integer no null Node/device ID to associate the ticket with. Use ninja_list_devices or ninja_search_devices to find valid IDs. Omit for unassociated ticket.
priority string no null Ticket priority. Must be one of: NONE, LOW, MEDIUM, HIGH, CRITICAL. Omit for default priority.
status string no null Ticket status. Use ninja_list_ticket_statuses to see valid values. Omit for default status.
subject string yes Ticket subject/summary. Keep concise and descriptive.
ninja_get_ticket parameters
Param Type Required Default Description
ticketId integer yes The ticket ID to retrieve.
ninja_get_ticket_form parameters
Param Type Required Default Description
formId integer yes The form ID. Use ninja_list_ticket_forms to find valid IDs.
ninja_get_ticket_log_entries parameters
Param Type Required Default Description
ticketId integer yes The ticket ID to get log entries for.
type string no null Filter by log entry type: DESCRIPTION, COMMENT, CONDITION, SAVE, DELETE, PRODUCT, INFO. Omit for all types.
ninja_list_tickets_for_board parameters
Param Type Required Default Description
boardId integer yes The board ID. Use ninja_list_ticket_boards to find valid IDs.
lastCursorId integer no null Last cursor ID from previous page's metadata for pagination.
pageSize integer no null Results per page. Omit for default.
searchCriteria string no null Free-text search across ticket fields. Max 512 characters.
ninja_update_ticket parameters
Param Type Required Default Description
fieldsJson string yes JSON object with fields to update (e.g. {"status":"CLOSED","priority":"HIGH"}). Only include fields you want to change.
ticketId integer yes The ticket ID to update.

Policies

Tool Plan Access Description
ninja_create_policy Pro Write [NinjaRMM] Create a new device policy in NinjaOne. Mode determines creation type: NEW creates a standalone root policy, CHILD creates a policy that inherits from a parent (parentPolicyId and nodeClass required in body), COPY duplicates an existing policy (templatePolicyId required). Returns the created policy with its assigned ID. Use ninja_list_policies to see existing policies.
ninja_set_organization_policies Pro Write [NinjaRMM] Assign policies to an organization. Side effect: changes which policies apply to all devices in the organization. Use ninja_list_policies and ninja_list_organizations first to get valid IDs.
ninja_create_policy parameters
Param Type Required Default Description
mode string no "NEW" Policy creation mode. Must be one of: NEW (standalone root policy), CHILD (inherits from parent — requires parentPolicyId and nodeClass in policyJson body), COPY (duplicates existing — requires templatePolicyId parameter). Defaults to NEW.
policyJson string no null Policy definition as a JSON object. For NEW: {name, description, nodeClass, enabled}. For CHILD: {parentPolicyId, name, description, nodeClass, enabled}. For COPY: {name, description}. nodeClass values include WINDOWS_SERVER, WINDOWS_WORKSTATION, LINUX_WORKSTATION, MAC, etc.
templatePolicyId integer no null Template policy ID to copy from (required when mode is COPY). Use ninja_list_policies to find valid IDs.
ninja_set_organization_policies parameters
Param Type Required Default Description
organizationId integer yes The organization ID. Use ninja_list_organizations to find valid IDs.
policiesJson string yes Policy assignments as a JSON object mapping device roles to policy IDs. See NinjaOne API docs for schema.

Scripting

Tool Plan Access Description
ninja_get_scripting_options Pro Read-only [NinjaRMM] Get available scripts, actions, and stored credentials for a specific device. Returns ACTIONs (built-in, identified by uid UUID) and SCRIPTs (custom, identified by numeric id), plus available credential IDs for the runAs parameter. MUST call before ninja_run_script to determine the correct type, identifier, and runAs value.
ninja_list_automation_scripts Pro Read-only [NinjaRMM] List all automation scripts available in NinjaOne. Returns script IDs, names, categories, and language. Use to find script IDs before running with ninja_run_script.
ninja_run_script Pro Write [NinjaRMM] Execute a script or action on a specific device. Side effect: runs immediately on the target device. Call ninja_get_scripting_options first to see available scripts/actions and stored credentials for a device. The type determines the request format: SCRIPT uses a numeric id, ACTION uses a UUID uid.
ninja_get_scripting_options parameters
Param Type Required Default Description
deviceId integer yes The device ID. Use ninja_list_devices or ninja_search_devices to find valid IDs.
ninja_run_script parameters
Param Type Required Default Description
actionUid string no null For ACTION: the action UUID (e.g. '3fa85f64-5717-4562-b3fc-2c963f66afa6'). Not used for SCRIPT type.
deviceId integer yes The device ID to run the script on. Use ninja_list_devices or ninja_search_devices to find valid IDs.
parameters string no null Script parameters as a string. Omit if the script takes no parameters.
runAs string no "" Who to run the script as. Empty string '' runs as SYSTEM. 'loggedonuser' runs as the active logged-on user. A numeric credential ID string (e.g. '3') runs as that stored credential. Use ninja_get_scripting_options to discover available credentials for a device.
scriptId integer no 0 For SCRIPT: the numeric script ID (e.g. 92). For ACTION: set to 0 or omit.
type string yes Must be 'ACTION' (built-in action) or 'SCRIPT' (custom/uploaded script). Determines which identifier field is used.

Documentation

Tool Plan Access Description
ninja_create_kb_article Pro Write [NinjaRMM] Create a new global knowledge base article. Side effect: publishes a new article visible to all technicians. Returns the created article with its assigned ID.
ninja_create_org_document Pro Write [NinjaRMM] Create a new organization document. Side effect: creates a document associated with an organization. Returns the created document with its assigned ID. Use ninja_list_organizations for valid org IDs.
ninja_list_kb_articles Pro Read-only [NinjaRMM] List all global knowledge base articles. Returns article IDs, titles, and folder information. Use to browse available documentation or find an article ID before reading its content.
ninja_list_org_documents Pro Read-only [NinjaRMM] List organization documents, optionally filtered by organization. Returns document IDs, titles, and template info. Use ninja_list_organizations first to get valid organization IDs.
ninja_create_kb_article parameters
Param Type Required Default Description
content string yes Article body content. HTML formatting is supported.
folderId integer no null Folder ID to place the article in. Use ninja_list_kb_articles to see existing folder structure. Omit for root level.
title string yes Article title. Should be descriptive and searchable.
ninja_create_org_document parameters
Param Type Required Default Description
content string yes Document content. Plain text or HTML depending on template.
organizationId integer no null Organization ID to associate the document with. Use ninja_list_organizations to find valid IDs. Omit for unassociated document.
templateId integer no null Document template ID to use. Omit for default template.
title string yes Document title. Should be descriptive and searchable.
ninja_list_org_documents parameters
Param Type Required Default Description
organizationId integer no null Filter by organization ID. Use ninja_list_organizations to find valid IDs. Omit for documents across all organizations.

Analytics

Tool Plan Access Description
ninja_alert_trend_analysis Pro Read-only [NinjaRMM] Analyze alert trends by type and severity to identify recurring issues. Returns alert counts grouped by source type, severity, and time period. Use to spot patterns before they become outages.
ninja_device_inventory_summary Pro Read-only [NinjaRMM] Get a device inventory summary grouped by organization, device class, and online/offline status. Returns counts and breakdowns for capacity planning and fleet overview.
ninja_fleet_health_dashboard Pro Read-only [NinjaRMM] Get an aggregate fleet health dashboard. Returns device counts by status, active alerts summary, and overall health metrics. Best starting point for fleet-wide health assessment.
ninja_patch_compliance_report Pro Read-only [NinjaRMM] Generate an OS and software patch compliance report across the fleet. Returns pending patch counts, compliance percentages, and devices needing updates. Use after ninja_fleet_health_dashboard to drill into patching issues.
ninja_stale_device_report Pro Read-only [NinjaRMM] Identify devices that have been offline beyond a configurable threshold. Returns stale device details including last seen time and organization. Useful for cleanup and license reclamation.
ninja_alert_trend_analysis parameters
Param Type Required Default Description
deviceFilter string no null Device filter expression to scope the analysis (e.g. 'org=5'). Omit for entire fleet.
sourceType string no null Filter by alert source type (e.g. 'CONDITION', 'MONITOR'). Omit for all source types.
ninja_device_inventory_summary parameters
Param Type Required Default Description
deviceFilter string no null Device filter expression to scope the summary (e.g. 'org=5'). Omit for entire fleet.
ninja_fleet_health_dashboard parameters
Param Type Required Default Description
deviceFilter string no null Device filter expression to scope the dashboard (e.g. 'org=5', 'class=WINDOWS_SERVER'). Omit for entire fleet.
ninja_patch_compliance_report parameters
Param Type Required Default Description
deviceFilter string no null Device filter expression to scope the report (e.g. 'org=5', 'class=WINDOWS_WORKSTATION'). Omit for entire fleet.
ninja_stale_device_report parameters
Param Type Required Default Description
deviceFilter string no null Device filter expression to scope the report (e.g. 'org=5'). Omit for entire fleet.
offlineDaysThreshold integer no 30 Number of days a device must be offline to be considered stale. Default 30. Lower values return more results.