Skip to main content
Tools Reference

NinjaRMM Tools

Written By Christopher Scaminaci

Last updated 7 days ago

NinjaRMM Tools

ninja_ · 270 tools · Free 107 · Pro 163 OAuth2; max page size 1000; raw JSON passthrough.

All connector tools · NinjaRMM setup guide

NinjaRMM tool groups

Organizations

ToolPlanAccessSummary
ninja_add_organization_locationProWriteAdd a new location to an organization.
ninja_get_organizationFreeRead-onlyGet detailed information for a single organization including name, description, custom fields, and settings.
ninja_get_organization_devicesFreeRead-onlyList all devices belonging to a specific organization.
ninja_get_organization_end_usersFreeRead-onlyList end users belonging to an organization.
ninja_get_organization_locationsFreeRead-onlyList all locations (offices/sites) for a specific organization.
ninja_list_organizationsFreeRead-onlyList all organizations (clients/customers) in your NinjaOne instance with cursor-based pagination.
ninja_list_organizations_detailedFreeRead-onlyList organizations with full detail including custom fields and policy mappings.
ninja_update_organizationProWriteUpdate organization properties.
ninja_update_organization_locationProWriteUpdate a location within an organization.

[NinjaRMM] Add a new location to an organization. Side effect: creates a new location.

ParamTypeRequiredDefaultDescription
addressstringnonullAddress of the location. Optional.
descriptionstringnonullDescription of the location. Optional.
namestringyesName of the new location.
organizationIdintegeryesThe organization ID to add the location to. Use ninja_list_organizations to find valid IDs.

[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.

ParamTypeRequiredDefaultDescription
organizationIdintegeryesThe organization ID. Use ninja_list_organizations to find valid IDs.

[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.

ParamTypeRequiredDefaultDescription
afterintegernonullLast device ID from previous page for cursor pagination. Omit for the first page.
organizationIdintegeryesThe organization ID. Use ninja_list_organizations to find valid IDs.
pageSizeintegerno50Results per page. Default 50, max 1000.
ParamTypeRequiredDefaultDescription
organizationIdintegeryesThe organization ID. Use ninja_list_organizations to find valid IDs.

[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.

ParamTypeRequiredDefaultDescription
organizationIdintegeryesThe organization ID. Use ninja_list_organizations to find valid IDs.

[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.

ParamTypeRequiredDefaultDescription
afterintegernonullLast organization ID from previous page for cursor pagination. Omit for the first page.
organizationFilterstringnonullNinjaOne 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.
pageSizeintegerno50Results per page. Default 50, max 1000. Use smaller values for faster responses.
ParamTypeRequiredDefaultDescription
afterintegernonullLast organization ID from previous page for cursor pagination. Omit for the first page.
pageSizeintegerno50Results per page. Default 50, max 1000.

[NinjaRMM] Update organization properties. Side effect: modifies organization information.

ParamTypeRequiredDefaultDescription
fieldsJsonstringyesJSON object with fields to update (e.g. {"name":"New Name","description":"Updated desc","userData":,"nodeApprovalMode":"AUTOMATIC"}). Only include fields you want to change.
organizationIdintegeryesThe organization ID to update. Use ninja_list_organizations to find valid IDs.

[NinjaRMM] Update a location within an organization. Side effect: modifies location properties.

ParamTypeRequiredDefaultDescription
fieldsJsonstringyesJSON object with fields to update (e.g. {"name":"New Name","address":"123 Main St"}). Only include fields you want to change.
locationIdintegeryesThe location ID to update. Use ninja_get_organization_locations to find valid IDs.
organizationIdintegeryesThe organization ID. Use ninja_list_organizations to find valid IDs.

Devices

ToolPlanAccessSummary
ninja_get_deviceFreeRead-onlyGet detailed information for a single device including system info, status, custom fields, and last contact time.
ninja_get_device_activitiesFreeRead-onlyGet recent activity log entries for a specific device.
ninja_get_device_alertsFreeRead-onlyGet active alerts for a specific device.
ninja_get_device_dashboard_urlFreeRead-onlyGet the NinjaRMM dashboard URL for a device.
ninja_get_device_disksFreeRead-onlyGet disk drive information for a device including model, size, and health status.
ninja_get_device_jobsFreeRead-onlyGet currently running (active) jobs for a device.
ninja_get_device_last_logged_on_userFreeRead-onlyGet the last logged-on user information for a device.
ninja_get_device_network_interfacesFreeRead-onlyGet network interface information for a device including IP addresses, MAC addresses, and adapter names.
ninja_get_device_os_patch_installsFreeRead-onlyGet OS patch installation history for a device.
ninja_get_device_os_patchesFreeRead-onlyGet pending OS patches for a specific device.
ninja_get_device_policy_overridesFreeRead-onlyGet summary of device policy overrides.
ninja_get_device_processorsFreeRead-onlyGet processor information for a device including model, speed, and core count.
ninja_get_device_softwareFreeRead-onlyGet installed software inventory for a specific device.
ninja_get_device_software_patch_installsFreeRead-onlyGet software patch installation history for a device.
ninja_get_device_software_patchesFreeRead-onlyGet pending, failed, and rejected software patches for a device.
ninja_get_device_volumesFreeRead-onlyGet storage volume information for a device including drive letters, capacity, free space, file system, and BitLocker drive encryption status.
ninja_get_device_warrantyFreeRead-onlyGet device warranty information including start date, end date, and manufacturer fulfillment date.
ninja_get_device_windows_servicesFreeRead-onlyGet Windows services installed on a device including service name, display name, state, and start type.
ninja_list_devicesFreeRead-onlyList all managed devices with optional filtering and cursor-based pagination.
ninja_list_devices_detailedFreeRead-onlyList devices with full hardware, software, and configuration detail.
ninja_search_devicesFreeRead-onlySearch devices by name, hostname, serial number, or other identifying information.

[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.

ParamTypeRequiredDefaultDescription
deviceIdintegeryesThe device ID. Use ninja_list_devices or ninja_search_devices to find valid IDs.
expandstringnonullAdditional related data to embed in the response, returned under 'references'. 'warranty' is the value StackJack has verified (ninja_get_device_warranty is this tool with expand=warranty). The NinjaOne spec does not document this parameter, so other values are unverified. Omit for the device record alone.

[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.

ParamTypeRequiredDefaultDescription
activityTypestringnonullFilter by activity type (e.g. PATCH_MANAGEMENT, CONDITION, ACTION, SCRIPT).
deviceIdintegeryesThe device ID. Use ninja_list_devices or ninja_search_devices to find valid IDs.
langstringnonullBCP-47 language tag (e.g. 'en-US', 'de-DE') for localized message text. Omit for the account default.
newerThanintegernonullReturn activities newer than this activity ID (cursor pagination backward).
olderThanintegernonullReturn activities older than this activity ID (cursor pagination forward). Get from previous response.
pageSizeintegerno50Results per page. Default 50, max 1000.
seriesUidstringnonullReturn only activities belonging to this alert series UID. Omit for all activities.
statusstringnonullFilter by activity status.
tzstringnonullIANA time zone (e.g. 'America/New_York') used to render timestamps. Omit for the account default.

[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.

ParamTypeRequiredDefaultDescription
deviceIdintegeryesThe device ID. Use ninja_list_devices or ninja_search_devices to find valid IDs.
langstringnonullBCP-47 language tag (e.g. 'en-US', 'de-DE') for localized message text. Omit for the account default.
tzstringnonullIANA time zone (e.g. 'America/New_York') used to render timestamps. Omit for the account default.
ParamTypeRequiredDefaultDescription
deviceIdintegeryesThe device ID. Use ninja_list_devices or ninja_search_devices to find valid IDs.
ParamTypeRequiredDefaultDescription
deviceIdintegeryesThe device ID. Use ninja_list_devices or ninja_search_devices to find valid IDs.
ParamTypeRequiredDefaultDescription
deviceIdintegeryesThe device ID. Use ninja_list_devices or ninja_search_devices to find valid IDs.
langstringnonullBCP-47 language tag (e.g. 'en-US', 'de-DE') for localized message text. Omit for the account default.
tzstringnonullIANA time zone (e.g. 'America/New_York') used to render timestamps. Omit for the account default.
ParamTypeRequiredDefaultDescription
deviceIdintegeryesThe device ID. Use ninja_list_devices or ninja_search_devices to find valid IDs.
ParamTypeRequiredDefaultDescription
deviceIdintegeryesThe device ID. Use ninja_list_devices or ninja_search_devices to find valid IDs.
ParamTypeRequiredDefaultDescription
deviceIdintegeryesThe device ID. Use ninja_list_devices or ninja_search_devices to find valid IDs.
installedAfterstringnonullOnly include patches installed after this date. The NinjaOne spec does not document the date format; yyyy-MM-dd is the form used elsewhere in this API. Omit for no lower bound.
installedBeforestringnonullOnly include patches installed before this date. The NinjaOne spec does not document the date format; yyyy-MM-dd is the form used elsewhere in this API. Omit for no upper bound.
statusstringnonullFilter by patch status (e.g. FAILED, INSTALLED). Omit for all.

[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.

ParamTypeRequiredDefaultDescription
deviceIdintegeryesThe device ID. Use ninja_list_devices or ninja_search_devices to find valid IDs.
severitystringnonullFilter by patch severity. Omit for all severities.
statusstringnonullFilter by patch status (e.g. PENDING, FAILED, REJECTED). Omit for all statuses.
typestringnonullFilter by patch type. Omit for all types.
ParamTypeRequiredDefaultDescription
deviceIdintegeryesThe device ID. Use ninja_list_devices or ninja_search_devices to find valid IDs.
ParamTypeRequiredDefaultDescription
deviceIdintegeryesThe device ID. Use ninja_list_devices or ninja_search_devices to find valid IDs.

[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.

ParamTypeRequiredDefaultDescription
deviceIdintegeryesThe device ID. Use ninja_list_devices or ninja_search_devices to find valid IDs.
ParamTypeRequiredDefaultDescription
deviceIdintegeryesThe device ID. Use ninja_list_devices or ninja_search_devices to find valid IDs.
impactstringnonullFilter by patch impact (e.g. OPTIONAL, RECOMMENDED, CRITICAL). Omit for all.
installedAfterstringnonullOnly include patches installed after this date. The NinjaOne spec does not document the date format; yyyy-MM-dd is the form used elsewhere in this API. Omit for no lower bound.
installedBeforestringnonullOnly include patches installed before this date. The NinjaOne spec does not document the date format; yyyy-MM-dd is the form used elsewhere in this API. Omit for no upper bound.
productIdentifierstringnonullFilter to a single software product identifier. Omit for all products.
statusstringnonullFilter by patch status (e.g. FAILED, INSTALLED). Omit for all.
typestringnonullFilter by patch type. Omit for all.
ParamTypeRequiredDefaultDescription
deviceIdintegeryesThe device ID. Use ninja_list_devices or ninja_search_devices to find valid IDs.
impactstringnonullFilter by patch impact (e.g. OPTIONAL, RECOMMENDED, CRITICAL). Omit for all.
productIdentifierstringnonullFilter to a single software product identifier. Omit for all products.
statusstringnonullFilter by patch status (PENDING, FAILED, REJECTED). Omit for all.
typestringnonullFilter by patch type. Omit for all.

[NinjaRMM] Get storage volume information for a device including drive letters, capacity, free space, file system, and BitLocker drive encryption status. Each volume carries a bitLockerStatus object reporting encryption state, conversion status, and protection status — use this to check whether a device's disks are encrypted. Non-Windows volumes omit the BitLocker object.

ParamTypeRequiredDefaultDescription
deviceIdintegeryesThe device ID. Use ninja_list_devices or ninja_search_devices to find valid IDs.

[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.

ParamTypeRequiredDefaultDescription
deviceIdintegeryesThe device ID. Use ninja_list_devices or ninja_search_devices to find valid IDs.
ParamTypeRequiredDefaultDescription
deviceIdintegeryesThe device ID. Use ninja_list_devices or ninja_search_devices to find valid IDs.
namestringnonullFilter to a single Windows service by name. Omit for all services.
statestringnonullFilter by service state (UNKNOWN, STOPPED, START_PENDING, RUNNING, STOP_PENDING, PAUSE_PENDING, PAUSED, CONTINUE_PENDING). Omit for all states.

[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.

ParamTypeRequiredDefaultDescription
afterintegernonullLast device ID from previous page for cursor pagination. Omit for the first page.
deviceFilterstringnonullDevice filter expression (e.g. 'class=WINDOWS_SERVER AND online', 'org=5'). See NinjaOne device filter syntax. Omit for all devices.
pageSizeintegerno50Results per page. Default 50, max 1000. Use smaller values for faster responses.

[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.

ParamTypeRequiredDefaultDescription
afterintegernonullLast device ID from previous page for cursor pagination. Omit for the first page.
deviceFilterstringnonullDevice filter expression (e.g. 'class=WINDOWS_SERVER', 'org=5 AND online'). Omit for all devices.
pageSizeintegerno50Results per page. Default 50, max 1000. Use smaller values for faster responses due to large payload size.

[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.

ParamTypeRequiredDefaultDescription
limitintegerno50Maximum results to return. Default 50, max 1000. Use smaller values for faster responses.
querystringyesSearch query string. Matches against device name, hostname, serial number, and other fields.

Custom Fields

ToolPlanAccessSummary
ninja_get_custom_field_definitionFreeRead-onlyGet a specific custom field definition by field name.
ninja_get_device_custom_fieldsFreeRead-onlyGet custom field values for a device.
ninja_get_location_custom_fieldsFreeRead-onlyGet custom field values for an organization location.
ninja_get_organization_custom_fieldsFreeRead-onlyGet custom field values for an organization.
ninja_list_custom_field_definitionsFreeRead-onlyList all custom field definitions with pagination.
ninja_list_device_custom_field_definitionsFreeRead-onlyList device custom field definitions, optionally filtered by scope.
ninja_query_custom_fieldsProRead-onlyFleet-wide custom field values report.
ninja_query_custom_fields_detailedProRead-onlyDetailed fleet-wide custom field values report with additional device information.
ninja_update_device_custom_fieldsProWriteUpdate custom field values for a device.
ninja_update_location_custom_fieldsProWriteUpdate custom field values for an organization location.
ninja_update_organization_custom_fieldsProWriteUpdate custom field values for an organization.

[NinjaRMM] Get a specific custom field definition by field name. Returns type, label, options, and permission settings.

ParamTypeRequiredDefaultDescription
fieldNamestringyesThe custom field name.

[NinjaRMM] Get custom field values for a device. Returns all custom field names and their current values.

ParamTypeRequiredDefaultDescription
deviceIdintegeryesThe device ID. Use ninja_list_devices or ninja_search_devices to find valid IDs.
ParamTypeRequiredDefaultDescription
locationIdintegeryesThe location ID.
organizationIdintegeryesThe organization ID.
withInheritancebooleannonullInclude inherited custom field values from the organization. Omit for location-level values only.
ParamTypeRequiredDefaultDescription
organizationIdintegeryesThe organization ID.

[NinjaRMM] List all custom field definitions with pagination. Returns field names, types, labels, and permission settings.

ParamTypeRequiredDefaultDescription
cursorstringnonullCursor string from previous page's response for pagination. Omit for the first page.
pageSizeintegerno50Results per page. Default 50, max 500.
ParamTypeRequiredDefaultDescription
scopesstringnonullFilter by scope (e.g. 'all', 'node', 'location', 'organization'). Omit for all scopes.

[NinjaRMM] Fleet-wide custom field values report. Returns custom field values across all devices with pagination.

ParamTypeRequiredDefaultDescription
cursorstringnonullCursor string from previous page's response for pagination. Omit for the first page.
deviceFilterstringnonullDevice filter expression (e.g. 'org=5', 'class=WINDOWS_WORKSTATION'). Omit for entire fleet.
fieldsstringnonullComma-separated list of custom field names to include. Omit for all fields.
pageSizeintegerno200Results per page. Default 200, max 1000. Larger pages are more efficient for bulk queries.
updatedAfterstringnonullISO 8601 timestamp to filter for values updated after this time (e.g. '2024-01-15T00:00:00Z'). Omit for all values.
ParamTypeRequiredDefaultDescription
cursorstringnonullCursor string from previous page's response for pagination. Omit for the first page.
deviceFilterstringnonullDevice filter expression (e.g. 'org=5', 'class=WINDOWS_WORKSTATION'). Omit for entire fleet.
fieldsstringnonullComma-separated list of custom field names to include. Omit for all fields.
pageSizeintegerno200Results per page. Default 200, max 1000. Larger pages are more efficient for bulk queries.
updatedAfterstringnonullISO 8601 timestamp to filter for values updated after this time (e.g. '2024-01-15T00:00:00Z'). Omit for all values.

[NinjaRMM] Update custom field values for a device. Side effect: modifies device custom fields. Pass a JSON object mapping field names to values.

ParamTypeRequiredDefaultDescription
deviceIdintegeryesThe device ID. Use ninja_list_devices or ninja_search_devices to find valid IDs.
fieldsJsonstringyesJSON object mapping field names to values (e.g. {"fieldName": "value"}). Only include fields you want to change.

[NinjaRMM] Update custom field values for an organization location. Side effect: modifies location custom fields.

ParamTypeRequiredDefaultDescription
fieldsJsonstringyesJSON object mapping field names to values (e.g. {"fieldName": "value"}). Only include fields you want to change.
locationIdintegeryesThe location ID.
organizationIdintegeryesThe organization ID.

[NinjaRMM] Update custom field values for an organization. Side effect: modifies organization custom fields.

ParamTypeRequiredDefaultDescription
fieldsJsonstringyesJSON object mapping field names to values (e.g. {"fieldName": "value"}). Only include fields you want to change.
organizationIdintegeryesThe organization ID.

Alerts

ToolPlanAccessSummary
ninja_delete_alertFreeDestructiveDelete/dismiss an alert by its UID.
ninja_list_alertsFreeRead-onlyList all active alerts across your NinjaOne environment.
ninja_reset_alertFreeWriteAcknowledge and reset an active alert by its UID.

[NinjaRMM] Delete/dismiss an alert by its UID. Side effect: permanently removes the alert.

ParamTypeRequiredDefaultDescription
alertUidstringyesThe alert UID to delete. Use ninja_list_alerts to find valid UIDs.

[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.

ParamTypeRequiredDefaultDescription
deviceFilterstringnonullDevice filter expression (e.g. 'class=WINDOWS_SERVER', 'org=5 AND online'). See NinjaOne device filter syntax.
langstringnonullBCP-47 language tag (e.g. 'en-US', 'de-DE') for localized message text. Omit for the account default.
sourceTypestringnonullFilter by alert source type (e.g. 'CONDITION', 'MONITOR'). Omit for all source types.
tzstringnonullIANA time zone (e.g. 'America/New_York') used to render timestamps. Omit for the account default.

[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.

ParamTypeRequiredDefaultDescription
alertUidstringyesThe alert UID to reset. Use ninja_list_alerts to find valid UIDs.

Activities

ToolPlanAccessSummary
ninja_list_activitiesFreeRead-onlyRetrieve activity log entries with optional filtering by class, type, status, date range, or device.

[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.

ParamTypeRequiredDefaultDescription
activityClassstringnonullActivity class filter. Must be 'System' or 'Device'. Omit to return both.
afterDatestringnonullReturn activities after this date. Format: yyyy-MM-dd.
beforestringnonullReturn activities before this date. Format: yyyy-MM-dd.
deviceFilterstringnonullDevice filter expression (e.g. 'class=WINDOWS_SERVER AND online', 'org=5'). See NinjaOne device filter syntax.
langstringnonullBCP-47 language tag (e.g. 'en-US', 'de-DE') for localized message text. Omit for the account default.
newerThanintegernonullReturn activities newer than this activity ID (cursor pagination backward).
olderThanintegernonullReturn activities older than this activity ID (cursor pagination forward). Get from a previous response.
pageSizeintegerno50Results per page. Default 50, max 1000. Use smaller values for faster responses.
seriesUidstringnonullReturn only activities belonging to this alert series UID. Omit for all activities.
statusstringnonullActivity status filter (e.g. 'COMPLETED', 'FAILED'). Omit for all statuses.
typestringnonullActivity type filter (e.g. 'ACTION_REBOOT', 'ALERT_TRIGGERED'). Omit for all types.
tzstringnonullIANA time zone (e.g. 'America/New_York') used to render timestamps. Omit for the account default.
userstringnonullFilter to activities performed by these user(s). Omit for all users.

System

ToolPlanAccessSummary
ninja_get_group_device_idsFreeRead-onlyGet all device IDs that are members of a specific group or saved search.
ninja_list_groupsFreeRead-onlyList all device groups and saved searches.
ninja_list_jobsFreeRead-onlyList currently active jobs across all devices.
ninja_list_locationsFreeRead-onlyList all locations across all organizations with cursor-based pagination.
ninja_list_notification_channelsFreeRead-onlyList available notification channels configured in NinjaOne.
ninja_list_policiesFreeRead-onlyList all policies configured in NinjaOne.
ninja_list_rolesFreeRead-onlyList all device roles defined in NinjaOne.
ninja_list_software_productsFreeRead-onlyList supported third-party software products available for patch management.
ninja_list_tasksFreeRead-onlyList scheduled tasks across the NinjaOne environment.

[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.

ParamTypeRequiredDefaultDescription
groupIdintegeryesThe group ID. Use ninja_list_groups to find valid IDs.
refreshstringnonullNinjaOne 'refresh' parameter. The NinjaOne spec declares it with no description, so its accepted values and effect are unverified. Omit unless you have confirmed the behavior on your instance.

[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.

ParamTypeRequiredDefaultDescription
langstringnonullBCP-47 language tag (e.g. 'en-US', 'de-DE') for localized message text. Omit for the account default.

[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.

ParamTypeRequiredDefaultDescription
deviceFilterstringnonullDevice filter expression (e.g. 'org=5', 'class=WINDOWS_SERVER'). Omit for the entire fleet.
jobTypestringnonullFilter by job type. Omit for all job types.
langstringnonullBCP-47 language tag (e.g. 'en-US', 'de-DE') for localized message text. Omit for the account default.
tzstringnonullIANA time zone (e.g. 'America/New_York') used to render timestamps. Omit for the account default.

[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.

ParamTypeRequiredDefaultDescription
afterintegernonullLast location ID from previous page for cursor pagination. Omit for the first page.
pageSizeintegerno50Results per page. Default 50, max 1000. Use smaller values for faster responses.

[NinjaRMM] List available notification channels configured in NinjaOne. Returns channel names, types, and enabled status.

[NinjaRMM] List all policies configured in NinjaOne. Returns policy IDs, names, and types. Use ninja_set_organization_policies to assign policies to organizations.

[NinjaRMM] List all device roles defined in NinjaOne. Returns role IDs and names. Device roles determine which policies apply to a device.

[NinjaRMM] List supported third-party software products available for patch management. Returns product names and IDs used for software patch configuration.

[NinjaRMM] List scheduled tasks across the NinjaOne environment. Returns task names, schedules, and target scopes.

Users

ToolPlanAccessSummary
ninja_create_contactProWriteCreate a new contact.
ninja_delete_contactProDestructiveDelete a contact.
ninja_get_contactProRead-onlyGet detailed information for a specific contact including name, email, phone, and organization.
ninja_list_contactsProRead-onlyList all contacts in NinjaOne ticketing.
ninja_update_contactProWriteUpdate contact information.

[NinjaRMM] Create a new contact. Side effect: creates a contact record.

ParamTypeRequiredDefaultDescription
emailstringyesContact email address.
firstNamestringyesContact first name.
jobTitlestringnonullContact job title.
lastNamestringyesContact last name.
organizationIdintegeryesOrganization ID to associate the contact with.
phonestringnonullContact phone number.

[NinjaRMM] Delete a contact. Side effect: permanently removes the contact.

ParamTypeRequiredDefaultDescription
contactIdintegeryesThe contact ID to delete.

[NinjaRMM] Get detailed information for a specific contact including name, email, phone, and organization. Use ninja_list_contacts first to find valid contact IDs.

ParamTypeRequiredDefaultDescription
contactIdintegeryesThe contact ID. Use ninja_list_contacts to find valid IDs.

[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.

[NinjaRMM] Update contact information. Side effect: modifies contact properties.

ParamTypeRequiredDefaultDescription
contactIdintegeryesThe contact ID to update.
fieldsJsonstringyesJSON object with fields to update. Only include fields you want to change.

End Users

ToolPlanAccessSummary
ninja_create_end_userProWriteCreate a new end user.
ninja_delete_end_userProDestructiveDelete an end user.
ninja_get_end_user_custom_fieldsProRead-onlyGet custom field values for an end user.
ninja_list_end_usersProRead-onlyList all end users.
ninja_list_techniciansProRead-onlyList all technicians.
ninja_list_user_rolesProRead-onlyList all user roles.
ninja_update_end_userProWriteUpdate an end user.
ninja_update_end_user_custom_fieldsProWriteUpdate custom field values for an end user.

[NinjaRMM] Create a new end user. Side effect: creates an end user account. Use ninja_list_end_users to verify creation.

ParamTypeRequiredDefaultDescription
fieldsJsonstringyesJSON object with end user properties (e.g. {"firstName":"John","lastName":"Doe","email":"john@example.com","organizationId":5}).

[NinjaRMM] Delete an end user. Side effect: permanently removes the end user.

ParamTypeRequiredDefaultDescription
endUserIdintegeryesThe end user ID to delete.
ParamTypeRequiredDefaultDescription
endUserIdintegeryesThe end user ID.

[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.

[NinjaRMM] List all technicians. Returns technician names, emails, and roles.

[NinjaRMM] List all user roles. Returns role names and IDs used for permission management.

[NinjaRMM] Update an end user. Side effect: modifies end user properties.

ParamTypeRequiredDefaultDescription
endUserIdintegeryesThe end user ID to update.
fieldsJsonstringyesJSON object with fields to update. Only include fields you want to change.

[NinjaRMM] Update custom field values for an end user. Side effect: modifies end user custom fields.

ParamTypeRequiredDefaultDescription
endUserIdintegeryesThe end user ID.
fieldsJsonstringyesJSON object with custom field values to update. Only include fields you want to change.

Device Management

ToolPlanAccessSummary
ninja_apply_os_patchesProDestructiveApply all pending OS patches to a device.
ninja_apply_software_patchesProDestructiveApply all pending third-party software patches to a device.
ninja_approve_devicesProWriteApprove or reject pending devices.
ninja_clear_maintenance_modeProWriteRemove a device from maintenance mode, re-enabling alert monitoring.
ninja_configure_windows_serviceProWriteConfigure a Windows service startup type on a device.
ninja_control_windows_serviceProWriteControl a Windows service on a device (start, stop, pause, restart).
ninja_reboot_deviceFreeDestructiveReboot a managed device.
ninja_remove_device_ownerProDestructiveRemove the owner from a device.
ninja_reset_device_policy_overridesProDestructiveReset all policy overrides for a device back to inherited values.
ninja_scan_os_patchesFreeWriteTrigger an OS patch scan on a device to discover available Windows/macOS/Linux updates.
ninja_scan_software_patchesFreeWriteTrigger a third-party software patch scan on a device.
ninja_set_device_ownerProWriteAssign an owner to a device.
ninja_set_maintenance_modeProWritePut a device into maintenance mode for a scheduled window.
ninja_update_deviceProWriteUpdate device information.
ninja_update_device_warrantyProWriteUpdate warranty dates for a device.

[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.

ParamTypeRequiredDefaultDescription
deviceIdintegeryesThe device ID. Use ninja_list_devices or ninja_search_devices to find valid IDs.

[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.

ParamTypeRequiredDefaultDescription
deviceIdintegeryesThe device ID. Use ninja_list_devices or ninja_search_devices to find valid IDs.

[NinjaRMM] Approve or reject pending devices. Side effect: changes device approval status.

ParamTypeRequiredDefaultDescription
deviceIdsarrayyesArray of device IDs to approve or reject.
modestringyesApproval mode. Must be 'APPROVE' or 'REJECT'.

[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.

ParamTypeRequiredDefaultDescription
deviceIdintegeryesThe device ID. Use ninja_list_devices or ninja_search_devices to find valid IDs.

[NinjaRMM] Configure a Windows service startup type on a device. Side effect: modifies service configuration.

ParamTypeRequiredDefaultDescription
deviceIdintegeryesThe device ID. Use ninja_list_devices or ninja_search_devices to find valid IDs.
serviceIdintegeryesThe service ID. Use ninja_get_device_windows_services to find valid IDs.
startTypestringyesService startup type. Must be one of: AUTO_START, AUTO_START_DELAYED, BOOT_START, DEMAND_START, DISABLED, SYSTEM_START.
userNamestringnonullService logon account username. Optional.

[NinjaRMM] Control a Windows service on a device (start, stop, pause, restart). Side effect: changes service state.

ParamTypeRequiredDefaultDescription
actionstringyesAction to perform. Must be 'START', 'STOP', 'PAUSE', or 'RESTART'.
deviceIdintegeryesThe device ID. Use ninja_list_devices or ninja_search_devices to find valid IDs.
serviceIdintegeryesThe service ID. Use ninja_get_device_windows_services to find valid IDs.

[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.

ParamTypeRequiredDefaultDescription
deviceIdintegeryesThe device ID to reboot. Use ninja_list_devices or ninja_search_devices to find valid IDs.
modestringno"NORMAL"Reboot mode. Must be 'NORMAL' or 'FORCED'. NORMAL waits for user logout, FORCED reboots immediately.
reasonstringnonullReason for reboot. Recorded in audit trail. Optional.

[NinjaRMM] Remove the owner from a device. Side effect: clears device owner assignment.

ParamTypeRequiredDefaultDescription
deviceIdintegeryesThe device ID. Use ninja_list_devices or ninja_search_devices to find valid IDs.

[NinjaRMM] Reset all policy overrides for a device back to inherited values. Side effect: removes all custom policy overrides.

ParamTypeRequiredDefaultDescription
deviceIdintegeryesThe device ID. Use ninja_list_devices or ninja_search_devices to find valid IDs.

[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.

ParamTypeRequiredDefaultDescription
deviceIdintegeryesThe device ID to scan. Use ninja_list_devices or ninja_search_devices to find valid IDs.

[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.

ParamTypeRequiredDefaultDescription
deviceIdintegeryesThe device ID to scan. Use ninja_list_devices or ninja_search_devices to find valid IDs.

[NinjaRMM] Assign an owner to a device. Side effect: sets device owner.

ParamTypeRequiredDefaultDescription
deviceIdintegeryesThe device ID. Use ninja_list_devices or ninja_search_devices to find valid IDs.
ownerUidstringyesThe owner UID to assign to the device.

[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.

ParamTypeRequiredDefaultDescription
deviceIdintegeryesThe device ID. Use ninja_list_devices or ninja_search_devices to find valid IDs.
endstringyesMaintenance window end time in ISO 8601 format (e.g. '2025-01-15T06:00:00Z'). Must be after start.
startstringyesMaintenance window start time in ISO 8601 format (e.g. '2025-01-15T02:00:00Z').

[NinjaRMM] Update device information. Side effect: modifies device properties.

ParamTypeRequiredDefaultDescription
deviceIdintegeryesThe device ID. Use ninja_list_devices or ninja_search_devices to find valid IDs.
fieldsJsonstringyesJSON string with fields to update (e.g. displayName, nodeRoleId, policyId, organizationId, locationId, userData).

[NinjaRMM] Update warranty dates for a device. Side effect: modifies device warranty info. Dates are Unix epoch seconds.

ParamTypeRequiredDefaultDescription
deviceIdintegeryesThe device ID. Use ninja_list_devices or ninja_search_devices to find valid IDs.
manufacturerFulfillmentDateintegernonullManufacturer fulfillment date as Unix epoch seconds. Optional.
warrantyEndDateintegeryesWarranty end date as Unix epoch seconds.
warrantyStartDateintegeryesWarranty start date as Unix epoch seconds.

Queries

ToolPlanAccessSummary
ninja_query_antivirus_statusProRead-onlyBulk query antivirus status across the entire fleet.
ninja_query_antivirus_threatsProRead-onlyBulk query detected antivirus threats across the fleet.
ninja_query_backup_usageProRead-onlyFleet-wide device backup usage report.
ninja_query_computer_systemsProRead-onlyFleet-wide computer systems report including manufacturer, model, and serial number.
ninja_query_device_healthProRead-onlyBulk query device health metrics across the fleet.
ninja_query_disksProRead-onlyBulk query disk health and usage across the fleet.
ninja_query_logged_on_usersProRead-onlyFleet-wide last logged-on user report.
ninja_query_network_interfacesProRead-onlyFleet-wide network interface report including IP and MAC addresses.
ninja_query_operating_systemsProRead-onlyBulk query OS information across the fleet.
ninja_query_os_patch_installsProRead-onlyFleet-wide OS patch installation history report.
ninja_query_os_patchesProRead-onlyBulk query pending OS patches across the fleet.
ninja_query_policy_overridesProRead-onlyFleet-wide summary of device policy overrides.
ninja_query_processorsProRead-onlyFleet-wide processor report including model, speed, and core count.
ninja_query_raid_controllersProRead-onlyFleet-wide RAID controller report.
ninja_query_raid_drivesProRead-onlyFleet-wide RAID drive report.
ninja_query_softwareProRead-onlyBulk query installed software inventory across the fleet.
ninja_query_software_patch_installsProRead-onlyFleet-wide software patch installation history report.
ninja_query_software_patchesProRead-onlyFleet-wide pending, failed, and rejected software patches report.
ninja_query_volumesProRead-onlyFleet-wide storage volume report including capacity, free space, file system, and BitLocker drive encryption status.
ninja_query_windows_servicesProRead-onlyBulk query Windows services status across the fleet.

[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.

ParamTypeRequiredDefaultDescription
cursorstringnonullCursor string from previous page's response for pagination. Omit for the first page.
deviceFilterstringnonullDevice filter expression (e.g. 'org=5', 'class=WINDOWS_WORKSTATION'). Omit for entire fleet.
pageSizeintegerno200Results per page. Default 200, max 1000. Larger pages are more efficient for bulk queries.
productNamestringnonullFilter by antivirus product name (e.g. 'Windows Defender', 'CrowdStrike'). Omit for all products.
productStatestringnonullFilter by AV product state (e.g. ON, OFF, EXPIRED, SNOOZED). Omit for all states.
timestampFilterstringnonullMonitoring timestamp filter (NinjaOne 'ts' parameter) — narrows results by when the monitoring snapshot was collected. The NinjaOne spec does not document the accepted format; consult NinjaOne's API documentation before relying on it. Omit for all records.

[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.

ParamTypeRequiredDefaultDescription
cursorstringnonullCursor string from previous page's response for pagination. Omit for the first page.
deviceFilterstringnonullDevice filter expression (e.g. 'org=5', 'class=WINDOWS_WORKSTATION'). Omit for entire fleet.
pageSizeintegerno200Results per page. Default 200, max 1000. Larger pages are more efficient for bulk queries.
timestampFilterstringnonullMonitoring timestamp filter (NinjaOne 'ts' parameter) — narrows results by when the monitoring snapshot was collected. The NinjaOne spec does not document the accepted format; consult NinjaOne's API documentation before relying on it. Omit for all records.
ParamTypeRequiredDefaultDescription
cursorstringnonullCursor string from previous page's response for pagination. Omit for the first page.
deviceFilterstringnonullDevice filter expression (e.g. 'org=5', 'class=WINDOWS_WORKSTATION'). Omit for entire fleet.
pageSizeintegerno200Results per page. Default 200, max 1000. Larger pages are more efficient for bulk queries.
ParamTypeRequiredDefaultDescription
cursorstringnonullCursor string from previous page's response for pagination. Omit for the first page.
deviceFilterstringnonullDevice filter expression (e.g. 'org=5', 'class=WINDOWS_WORKSTATION'). Omit for entire fleet.
pageSizeintegerno200Results per page. Default 200, max 1000. Larger pages are more efficient for bulk queries.
timestampFilterstringnonullMonitoring timestamp filter (NinjaOne 'ts' parameter) — narrows results by when the monitoring snapshot was collected. The NinjaOne spec does not document the accepted format; consult NinjaOne's API documentation before relying on it. Omit for all records.

[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.

ParamTypeRequiredDefaultDescription
cursorstringnonullCursor string from previous page's response for pagination. Omit for the first page.
deviceFilterstringnonullDevice filter expression (e.g. 'org=5', 'class=WINDOWS_SERVER'). Omit for entire fleet.
healthstringnonullFilter by health status (e.g. HEALTHY, UNHEALTHY). Omit for all.
pageSizeintegerno200Results per page. Default 200, max 1000. Larger pages are more efficient for bulk queries.

[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.

ParamTypeRequiredDefaultDescription
cursorstringnonullCursor string from previous page's response for pagination. Omit for the first page.
deviceFilterstringnonullDevice filter expression (e.g. 'org=5', 'class=WINDOWS_SERVER'). Omit for entire fleet.
pageSizeintegerno200Results per page. Default 200, max 1000. Larger pages are more efficient for bulk queries.
timestampFilterstringnonullMonitoring timestamp filter (NinjaOne 'ts' parameter) — narrows results by when the monitoring snapshot was collected. The NinjaOne spec does not document the accepted format; consult NinjaOne's API documentation before relying on it. Omit for all records.
ParamTypeRequiredDefaultDescription
cursorstringnonullCursor string from previous page's response for pagination. Omit for the first page.
deviceFilterstringnonullDevice filter expression (e.g. 'org=5', 'class=WINDOWS_WORKSTATION'). Omit for entire fleet.
pageSizeintegerno200Results per page. Default 200, max 1000. Larger pages are more efficient for bulk queries.
ParamTypeRequiredDefaultDescription
cursorstringnonullCursor string from previous page's response for pagination. Omit for the first page.
deviceFilterstringnonullDevice filter expression (e.g. 'org=5', 'class=WINDOWS_WORKSTATION'). Omit for entire fleet.
pageSizeintegerno200Results per page. Default 200, max 1000. Larger pages are more efficient for bulk queries.

[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.

ParamTypeRequiredDefaultDescription
cursorstringnonullCursor string from previous page's response for pagination. Omit for the first page.
deviceFilterstringnonullDevice filter expression (e.g. 'org=5', 'class=WINDOWS_SERVER'). Omit for entire fleet.
pageSizeintegerno200Results per page. Default 200, max 1000. Larger pages are more efficient for bulk queries.
timestampFilterstringnonullMonitoring timestamp filter (NinjaOne 'ts' parameter) — narrows results by when the monitoring snapshot was collected. The NinjaOne spec does not document the accepted format; consult NinjaOne's API documentation before relying on it. Omit for all records.
ParamTypeRequiredDefaultDescription
cursorstringnonullCursor string from previous page's response for pagination. Omit for the first page.
deviceFilterstringnonullDevice filter expression (e.g. 'org=5', 'class=WINDOWS_WORKSTATION'). Omit for entire fleet.
installedAfterstringnonullOnly include items installed after this date. The NinjaOne spec does not document the date format; yyyy-MM-dd is the form used elsewhere in this API. Omit for no lower bound.
installedBeforestringnonullOnly include items installed before this date. The NinjaOne spec does not document the date format; yyyy-MM-dd is the form used elsewhere in this API. Omit for no upper bound.
pageSizeintegerno200Results per page. Default 200, max 1000. Larger pages are more efficient for bulk queries.
statusstringnonullFilter by patch status (e.g. FAILED, INSTALLED). Omit for all.

[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.

ParamTypeRequiredDefaultDescription
cursorstringnonullCursor string from previous page's response for pagination. Omit for the first page.
deviceFilterstringnonullDevice filter expression (e.g. 'org=5', 'class=WINDOWS_SERVER'). Omit for entire fleet.
pageSizeintegerno200Results per page. Default 200, max 1000. Larger pages are more efficient for bulk queries.
patchStatusstringnonullFilter by patch status (PENDING, FAILED, REJECTED). Omit for all.
severitystringnonullFilter by patch severity. Omit for all.
timestampFilterstringnonullMonitoring timestamp filter (NinjaOne 'ts' parameter) — narrows results by when the monitoring snapshot was collected. The NinjaOne spec does not document the accepted format; consult NinjaOne's API documentation before relying on it. Omit for all records.
typestringnonullFilter by patch type. Omit for all.
ParamTypeRequiredDefaultDescription
cursorstringnonullCursor string from previous page's response for pagination. Omit for the first page.
deviceFilterstringnonullDevice filter expression (e.g. 'org=5', 'class=WINDOWS_WORKSTATION'). Omit for entire fleet.
pageSizeintegerno200Results per page. Default 200, max 1000. Larger pages are more efficient for bulk queries.
ParamTypeRequiredDefaultDescription
cursorstringnonullCursor string from previous page's response for pagination. Omit for the first page.
deviceFilterstringnonullDevice filter expression (e.g. 'org=5', 'class=WINDOWS_WORKSTATION'). Omit for entire fleet.
pageSizeintegerno200Results per page. Default 200, max 1000. Larger pages are more efficient for bulk queries.
timestampFilterstringnonullMonitoring timestamp filter (NinjaOne 'ts' parameter) — narrows results by when the monitoring snapshot was collected. The NinjaOne spec does not document the accepted format; consult NinjaOne's API documentation before relying on it. Omit for all records.
ParamTypeRequiredDefaultDescription
cursorstringnonullCursor string from previous page's response for pagination. Omit for the first page.
deviceFilterstringnonullDevice filter expression (e.g. 'org=5', 'class=WINDOWS_SERVER'). Omit for entire fleet.
pageSizeintegerno200Results per page. Default 200, max 1000. Larger pages are more efficient for bulk queries.
timestampFilterstringnonullMonitoring timestamp filter (NinjaOne 'ts' parameter) — narrows results by when the monitoring snapshot was collected. The NinjaOne spec does not document the accepted format; consult NinjaOne's API documentation before relying on it. Omit for all records.
ParamTypeRequiredDefaultDescription
cursorstringnonullCursor string from previous page's response for pagination. Omit for the first page.
deviceFilterstringnonullDevice filter expression (e.g. 'org=5', 'class=WINDOWS_SERVER'). Omit for entire fleet.
pageSizeintegerno200Results per page. Default 200, max 1000. Larger pages are more efficient for bulk queries.
timestampFilterstringnonullMonitoring timestamp filter (NinjaOne 'ts' parameter) — narrows results by when the monitoring snapshot was collected. The NinjaOne spec does not document the accepted format; consult NinjaOne's API documentation before relying on it. Omit for all records.

[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.

ParamTypeRequiredDefaultDescription
cursorstringnonullCursor string from previous page's response for pagination. Omit for the first page.
deviceFilterstringnonullDevice filter expression (e.g. 'org=5', 'class=WINDOWS_WORKSTATION'). Omit for entire fleet.
installedAfterstringnonullOnly include items installed after this date. The NinjaOne spec does not document the date format; yyyy-MM-dd is the form used elsewhere in this API. Omit for no lower bound.
installedBeforestringnonullOnly include items installed before this date. The NinjaOne spec does not document the date format; yyyy-MM-dd is the form used elsewhere in this API. Omit for no upper bound.
pageSizeintegerno200Results per page. Default 200, max 1000. Larger pages are more efficient for bulk queries.
ParamTypeRequiredDefaultDescription
cursorstringnonullCursor string from previous page's response for pagination. Omit for the first page.
deviceFilterstringnonullDevice filter expression (e.g. 'org=5', 'class=WINDOWS_WORKSTATION'). Omit for entire fleet.
impactstringnonullFilter by patch impact (e.g. OPTIONAL, RECOMMENDED, CRITICAL). Omit for all.
installedAfterstringnonullOnly include items installed after this date. The NinjaOne spec does not document the date format; yyyy-MM-dd is the form used elsewhere in this API. Omit for no lower bound.
installedBeforestringnonullOnly include items installed before this date. The NinjaOne spec does not document the date format; yyyy-MM-dd is the form used elsewhere in this API. Omit for no upper bound.
pageSizeintegerno200Results per page. Default 200, max 1000. Larger pages are more efficient for bulk queries.
productIdentifierstringnonullFilter to a single software product identifier. Omit for all products.
statusstringnonullFilter by patch status (e.g. FAILED, INSTALLED). Omit for all.
typestringnonullFilter by patch type. Omit for all.
ParamTypeRequiredDefaultDescription
cursorstringnonullCursor string from previous page's response for pagination. Omit for the first page.
deviceFilterstringnonullDevice filter expression (e.g. 'org=5', 'class=WINDOWS_WORKSTATION'). Omit for entire fleet.
impactstringnonullFilter by patch impact (e.g. OPTIONAL, RECOMMENDED, CRITICAL). Omit for all.
pageSizeintegerno200Results per page. Default 200, max 1000. Larger pages are more efficient for bulk queries.
productIdentifierstringnonullFilter to a single software product identifier. Omit for all products.
statusstringnonullFilter by patch status (PENDING, FAILED, REJECTED). Omit for all.
timestampFilterstringnonullMonitoring timestamp filter (NinjaOne 'ts' parameter) — narrows results by when the monitoring snapshot was collected. The NinjaOne spec does not document the accepted format; consult NinjaOne's API documentation before relying on it. Omit for all records.
typestringnonullFilter by patch type. Omit for all.

[NinjaRMM] Fleet-wide storage volume report including capacity, free space, file system, and BitLocker drive encryption status. Each volume carries a bitLockerStatus object reporting encryption state, conversion status, and protection status — use this to audit disk encryption compliance across the fleet. Non-Windows volumes omit the BitLocker object.

ParamTypeRequiredDefaultDescription
cursorstringnonullCursor string from previous page's response for pagination. Omit for the first page.
deviceFilterstringnonullDevice filter expression (e.g. 'org=5', 'class=WINDOWS_WORKSTATION'). Omit for entire fleet.
pageSizeintegerno200Results per page. Default 200, max 1000. Larger pages are more efficient for bulk queries.
timestampFilterstringnonullMonitoring timestamp filter (NinjaOne 'ts' parameter) — narrows results by when the monitoring snapshot was collected. The NinjaOne spec does not document the accepted format; consult NinjaOne's API documentation before relying on it. Omit for all records.

[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.

ParamTypeRequiredDefaultDescription
cursorstringnonullCursor string from previous page's response for pagination. Omit for the first page.
deviceFilterstringnonullDevice filter expression (e.g. 'org=5', 'class=WINDOWS_SERVER'). Omit for entire fleet.
namestringnonullFilter by service name (e.g. 'Spooler', 'wuauserv'). Omit for all services.
pageSizeintegerno200Results per page. Default 200, max 1000. Larger pages are more efficient for bulk queries.
statestringnonullFilter by service state: UNKNOWN, STOPPED, START_PENDING, RUNNING, STOP_PENDING, PAUSE_PENDING, PAUSED, CONTINUE_PENDING. Omit for all.

Advanced Management

ToolPlanAccessSummary
ninja_create_organizationProWriteCreate a new organization (client/customer) in NinjaOne.
ninja_decommission_deviceProDestructivePermanently decommission a device, removing it from active management.
ninja_generate_installerProWriteGenerate an agent installer download link for an organization.

[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.

ParamTypeRequiredDefaultDescription
descriptionstringnonullOrganization description. Optional free-text summary.
fieldsJsonstringnonullAdditional fields as a JSON object (e.g. {"tags":["vip"],"location":"NYC"}). Optional.
namestringyesOrganization name. Must be unique across your NinjaOne instance.
templateOrganizationIdintegernonullTemplate organization ID to clone settings from. Use ninja_list_organizations to find valid IDs. Optional.

[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.

ParamTypeRequiredDefaultDescription
deviceIdintegeryesThe device ID to decommission. Use ninja_list_devices or ninja_search_devices to find valid IDs.

[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.

ParamTypeRequiredDefaultDescription
installerTypestringno"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.
locationIdintegernonullOptional location ID within the organization.
organizationIdintegeryesThe organization ID to generate an installer for. Use ninja_list_organizations to find valid IDs.

Ticketing

ToolPlanAccessSummary
ninja_add_ticket_commentFreeWriteAdd a comment or update the description on an existing ticket.
ninja_create_ticketFreeWriteCreate a new ticket in NinjaOne ticketing.
ninja_get_ticketFreeRead-onlyGet full ticket detail including subject, description, comments, status, priority, and history.
ninja_get_ticket_formFreeRead-onlyGet details of a specific ticket form including fields and layout.
ninja_get_ticket_log_entriesFreeRead-onlyGet log entries for a ticket including status changes, comments, and updates.
ninja_list_ticket_attributesFreeRead-onlyList ticket attributes including custom fields and their allowed values.
ninja_list_ticket_boardsFreeRead-onlyList available ticket boards.
ninja_list_ticket_formsFreeRead-onlyList available ticket forms.
ninja_list_ticket_statusesFreeRead-onlyList all available ticket statuses configured in NinjaOne.
ninja_list_tickets_for_boardFreeRead-onlyList tickets for a specific board (simplified).
ninja_update_ticketFreeWriteUpdate an existing ticket's fields such as status, priority, or assignee.

[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.

ParamTypeRequiredDefaultDescription
commentstringyesComment body text. Supports plain text.
ticketIdintegeryesThe ticket ID to comment on.
typestringno"COMMENT"Comment type. Must be 'COMMENT' or 'DESCRIPTION'. COMMENT adds a new note, DESCRIPTION updates the ticket body.

[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.

ParamTypeRequiredDefaultDescription
descriptionstringyesTicket description with full detail of the issue or request.
nodeIdintegernonullNode/device ID to associate the ticket with. Use ninja_list_devices or ninja_search_devices to find valid IDs. Omit for unassociated ticket.
prioritystringnonullTicket priority. Must be one of: NONE, LOW, MEDIUM, HIGH, CRITICAL. Omit for default priority.
statusstringnonullTicket status. Use ninja_list_ticket_statuses to see valid values. Omit for default status.
subjectstringyesTicket subject/summary. Keep concise and descriptive.

[NinjaRMM] Get full ticket detail including subject, description, comments, status, priority, and history. Use ninja_create_ticket or search for a ticket ID first.

ParamTypeRequiredDefaultDescription
ticketIdintegeryesThe ticket ID to retrieve.
ParamTypeRequiredDefaultDescription
formIdintegeryesThe form ID. Use ninja_list_ticket_forms to find valid IDs.

[NinjaRMM] Get log entries for a ticket including status changes, comments, and updates. Use type filter to narrow results.

ParamTypeRequiredDefaultDescription
ticketIdintegeryesThe ticket ID to get log entries for.
typestringnonullFilter by log entry type: DESCRIPTION, COMMENT, CONDITION, SAVE, DELETE, PRODUCT, INFO. Omit for all types.

[NinjaRMM] List available ticket boards. Returns board IDs and names. Use ninja_list_tickets_for_board to view tickets on a specific board.

[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.

[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.

[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.

ParamTypeRequiredDefaultDescription
boardIdintegeryesThe board ID. Use ninja_list_ticket_boards to find valid IDs.
lastCursorIdintegernonullLast cursor ID from previous page's metadata for pagination.
pageSizeintegernonullResults per page. Omit for default.
searchCriteriastringnonullFree-text search across ticket fields. Max 512 characters.

[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.

ParamTypeRequiredDefaultDescription
fieldsJsonstringyesJSON object with fields to update (e.g. {"status":"CLOSED","priority":"HIGH"}). Only include fields you want to change.
ticketIdintegeryesThe ticket ID to update.

Policies

ToolPlanAccessSummary
ninja_create_policyProWriteCreate a new device policy in NinjaOne.
ninja_set_organization_policiesProWriteAssign policies to an organization.

[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.

ParamTypeRequiredDefaultDescription
modestringno"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.
policyJsonstringnonullPolicy 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.
templatePolicyIdintegernonullTemplate policy ID to copy from (required when mode is COPY). Use ninja_list_policies to find valid IDs.

[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.

ParamTypeRequiredDefaultDescription
organizationIdintegeryesThe organization ID. Use ninja_list_organizations to find valid IDs.
policiesJsonstringyesPolicy assignments as a JSON object mapping device roles to policy IDs. See NinjaOne API docs for schema.

Scripting

ToolPlanAccessSummary
ninja_get_scripting_optionsProRead-onlyGet available scripts, actions, and stored credentials for a specific device.
ninja_list_automation_scriptsProRead-onlyList all automation scripts available in NinjaOne.
ninja_run_scriptProDestructiveExecute a script or action on a specific device.

[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.

ParamTypeRequiredDefaultDescription
deviceIdintegeryesThe device ID. Use ninja_list_devices or ninja_search_devices to find valid IDs.
langstringnonullBCP-47 language tag (e.g. 'en-US', 'de-DE') for localized message text. Omit for the account default.

[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.

[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.

ParamTypeRequiredDefaultDescription
actionUidstringnonullFor ACTION: the action UUID (e.g. '3fa85f64-5717-4562-b3fc-2c963f66afa6'). Not used for SCRIPT type.
deviceIdintegeryesThe device ID to run the script on. Use ninja_list_devices or ninja_search_devices to find valid IDs.
parametersstringnonullScript parameters as a string. Omit if the script takes no parameters.
runAsstringno""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.
scriptIdintegerno0For SCRIPT: the numeric script ID (e.g. 92). For ACTION: set to 0 or omit.
typestringyesMust be 'ACTION' (built-in action) or 'SCRIPT' (custom/uploaded script). Determines which identifier field is used.

Documentation

ToolPlanAccessSummary
ninja_create_kb_articleProWriteCreate a new global knowledge base article.
ninja_create_org_documentProWriteCreate a new organization document.
ninja_list_kb_articlesProRead-onlyList all global knowledge base articles.
ninja_list_org_documentsProRead-onlyList organization documents, optionally filtered by organization.

[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.

ParamTypeRequiredDefaultDescription
contentstringyesArticle body content. HTML formatting is supported.
folderIdintegernonullFolder ID to place the article in. Use ninja_list_kb_articles to see existing folder structure. Omit for root level.
titlestringyesArticle title. Should be descriptive and searchable.

[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.

ParamTypeRequiredDefaultDescription
contentstringyesDocument content. Plain text or HTML depending on template.
organizationIdintegernonullOrganization ID to associate the document with. Use ninja_list_organizations to find valid IDs. Omit for unassociated document.
templateIdintegernonullDocument template ID to use. Omit for default template.
titlestringyesDocument title. Should be descriptive and searchable.

[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.

[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.

ParamTypeRequiredDefaultDescription
organizationIdintegernonullFilter by organization ID. Use ninja_list_organizations to find valid IDs. Omit for documents across all organizations.

Analytics

ToolPlanAccessSummary
ninja_alert_trend_analysisProRead-onlyAnalyze alert trends by type and severity to identify recurring issues.
ninja_device_inventory_summaryProRead-onlyGet a device inventory summary grouped by organization, device class, and online/offline status.
ninja_fleet_health_dashboardProRead-onlyGet an aggregate fleet health dashboard.
ninja_patch_compliance_reportProRead-onlyGenerate an OS and software patch compliance report across the fleet.
ninja_stale_device_reportProRead-onlyIdentify devices that have been offline beyond a configurable threshold.

[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.

ParamTypeRequiredDefaultDescription
deviceFilterstringnonullDevice filter expression to scope the analysis (e.g. 'org=5'). Omit for entire fleet.
sourceTypestringnonullFilter by alert source type (e.g. 'CONDITION', 'MONITOR'). Omit for all source types.

[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.

ParamTypeRequiredDefaultDescription
deviceFilterstringnonullDevice filter expression to scope the summary (e.g. 'org=5'). Omit for entire fleet.

[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.

ParamTypeRequiredDefaultDescription
deviceFilterstringnonullDevice filter expression to scope the dashboard (e.g. 'org=5', 'class=WINDOWS_SERVER'). Omit for entire fleet.

[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.

ParamTypeRequiredDefaultDescription
deviceFilterstringnonullDevice filter expression to scope the report (e.g. 'org=5', 'class=WINDOWS_WORKSTATION'). Omit for entire fleet.

[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.

ParamTypeRequiredDefaultDescription
deviceFilterstringnonullDevice filter expression to scope the report (e.g. 'org=5'). Omit for entire fleet.
offlineDaysThresholdintegerno30Number of days a device must be offline to be considered stale. Default 30. Lower values return more results.

System Lookups

ToolPlanAccessSummary
ninja_get_all_user_and_contactsFreeRead-onlyList of users by user type.
ninja_get_contactsFreeRead-onlyContact list.
ninja_get_enabled_notification_channelsFreeRead-onlyList enabled notification channels.
ninja_get_end_userFreeRead-onlyEnd user details.
ninja_get_scoped_custom_fields_detailed_reportFreeRead-onlyScoped custom fields detailed report.
ninja_get_scoped_custom_fields_reportFreeRead-onlyScoped custom fields report.
ninja_get_technicianFreeRead-onlyTechnician details.
ninja_get_usersFreeRead-onlyList users.
ParamTypeRequiredDefaultDescription
anchorNaturalIdintegernonullLast User Identifier from previous page Omit to leave unset.
clientIdintegernonullOrganization identifier Omit to leave unset.
pageSizeintegernonullLimit number of records per page Omit to leave unset.
searchCriteriastringnonullSearch by first name, last name or email address Omit to leave unset.
userTypestringnonullUser Type One of: TECHNICIAN, END_USER, CONTACT. Omit to leave unset.
ParamTypeRequiredDefaultDescription
idintegeryesid path identifier.
ParamTypeRequiredDefaultDescription
cursorstringnonullCursor name Omit to leave unset.
fieldsstringnonullComma-separated list of fields Omit to leave unset.
pageSizeintegernonullLimit number of records per page Omit to leave unset.
scopesstringnonullComma-separated list of scopes Omit to leave unset.
showSecureValuesbooleannonullFlag to indicate if secure values should be returned as plain text without encryption Omit to leave unset.
updatedAfterstringnonullCustom fields updated after specified date Omit to leave unset.
ParamTypeRequiredDefaultDescription
cursorstringnonullCursor name Omit to leave unset.
fieldsstringnonullComma-separated list of fields Omit to leave unset.
pageSizeintegernonullLimit number of records per page Omit to leave unset.
scopesstringnonullComma-separated list of scopes Omit to leave unset.
showSecureValuesbooleannonullFlag to indicate if secure values should be returned as plain text without encryption Omit to leave unset.
updatedAfterstringnonullCustom fields updated after specified date Omit to leave unset.
ParamTypeRequiredDefaultDescription
idintegeryesid path identifier.
ParamTypeRequiredDefaultDescription
includeRolesbooleannonullIncludes user role information Omit to leave unset.
userTypestringnonullUser type filter One of: TECHNICIAN, END_USER. Omit to leave unset.

Node Roles

ToolPlanAccessSummary
ninja_create_node_rolesProWriteCreate node roles.
ninja_delete_node_rolesProDestructiveDelete node roles.
ninja_get_node_rolesFreeRead-onlyGet all node roles.
ninja_update_node_rolesProWriteUpdate node roles.
ParamTypeRequiredDefaultDescription
bodyJsonstringyesRequest body as a JSON object string, matching the NinjaOne API schema for this operation.

[NinjaRMM] Delete node roles. This is a destructive operation and cannot be undone from StackJack.

ParamTypeRequiredDefaultDescription
bodyJsonstringyesRequest body as a JSON object string, matching the NinjaOne API schema for this operation.
ParamTypeRequiredDefaultDescription
isAssignablebooleannonullisAssignable Omit to leave unset.
ParamTypeRequiredDefaultDescription
bodyJsonstringyesRequest body as a JSON object string, matching the NinjaOne API schema for this operation.

Management

ToolPlanAccessSummary
ninja_add_user_role_membersProDestructiveAdd user role members.
ninja_create_custom_fields_policy_conditionProWriteCreate custom fields policy condition.
ninja_create_staged_deviceProWriteCreate staged device.
ninja_create_technicianProDestructiveCreate a technician.
ninja_create_windows_event_policy_conditionProWriteCreate windows event condition.
ninja_delete_policy_conditionProDestructiveDelete policy condition.
ninja_delete_technicianProDestructiveDelete a technician.
ninja_get_custom_fields_policy_conditionFreeRead-onlyGet custom fields policy condition.
ninja_get_custom_fields_policy_conditionsFreeRead-onlyGet custom fields policy conditions.
ninja_get_location_installerFreeRead-onlyGenerate installer.
ninja_get_windows_event_policy_conditionFreeRead-onlyGet windows event condition.
ninja_get_windows_event_policy_conditionsFreeRead-onlyGet windows event conditions.
ninja_remove_user_role_membersProDestructiveRemove users from user role.
ninja_update_technicianProDestructiveUpdate a technician.

[NinjaRMM] Add user role members. Widens the access granted to the listed users — privilege-widening, so it requires destructive-consent approval.

ParamTypeRequiredDefaultDescription
bodyJsonstringyesRequest body as a JSON object string, matching the NinjaOne API schema for this operation.
roleIdintegeryesroleId path identifier.
ParamTypeRequiredDefaultDescription
bodyJsonstringyesRequest body as a JSON object string, matching the NinjaOne API schema for this operation.
policyIdintegeryespolicy_id path identifier.
ParamTypeRequiredDefaultDescription
bodyJsonstringyesRequest body as a JSON object string, matching the NinjaOne API schema for this operation.

[NinjaRMM] Create a technician. Provisions an RMM console user with fleet-wide reach — privilege-widening, so it requires destructive-consent approval.

ParamTypeRequiredDefaultDescription
bodyJsonstringyesRequest body as a JSON object string, matching the NinjaOne API schema for this operation.
ParamTypeRequiredDefaultDescription
bodyJsonstringyesRequest body as a JSON object string, matching the NinjaOne API schema for this operation.
policyIdintegeryespolicy_id path identifier.

[NinjaRMM] Delete policy condition. This is a destructive operation and cannot be undone from StackJack.

ParamTypeRequiredDefaultDescription
conditionIdstringyescondition_id path identifier.
policyIdintegeryespolicy_id path identifier.

[NinjaRMM] Delete a technician. This is a destructive operation and cannot be undone from StackJack.

ParamTypeRequiredDefaultDescription
idintegeryesid path identifier.
ParamTypeRequiredDefaultDescription
conditionIdstringyescondition_id path identifier.
policyIdintegeryespolicy_id path identifier.
ParamTypeRequiredDefaultDescription
policyIdintegeryespolicy_id path identifier.
ParamTypeRequiredDefaultDescription
idintegeryesid path identifier.
installerTypestringyesinstaller_type path identifier.
locationIdintegeryeslocation_id path identifier.
ParamTypeRequiredDefaultDescription
conditionIdstringyescondition_id path identifier.
policyIdintegeryespolicy_id path identifier.
ParamTypeRequiredDefaultDescription
policyIdintegeryespolicy_id path identifier.

[NinjaRMM] Remove users from user role. This is a destructive operation and cannot be undone from StackJack.

ParamTypeRequiredDefaultDescription
bodyJsonstringyesRequest body as a JSON object string, matching the NinjaOne API schema for this operation.
roleIdintegeryesroleId path identifier.

[NinjaRMM] Update a technician. Can elevate an RMM console user's role — privilege-widening, so it requires destructive-consent approval.

ParamTypeRequiredDefaultDescription
bodyJsonstringyesRequest body as a JSON object string, matching the NinjaOne API schema for this operation.
idintegeryesid path identifier.

Webhooks

ToolPlanAccessSummary
ninja_configure_webhookProDestructiveUpdate API Webhook configuration.
ninja_disable_webhookProDestructiveRemove Webhook API channel.

[NinjaRMM] Update API Webhook configuration. This is a destructive operation and cannot be undone from StackJack.

ParamTypeRequiredDefaultDescription
bodyJsonstringyesRequest body as a JSON object string, matching the NinjaOne API schema for this operation.

[NinjaRMM] Remove Webhook API channel. This is a destructive operation and cannot be undone from StackJack.

Knowledge Base

ToolPlanAccessSummary
ninja_archive_knowledge_base_articlesProDestructiveArchive knowledge base articles.
ninja_archive_knowledge_base_foldersProDestructiveArchive knowledge base folders.
ninja_delete_knowledge_base_articlesProDestructiveDelete knowledge base articles.
ninja_delete_knowledge_base_foldersProDestructiveDelete knowledge base folders.
ninja_get_client_knowledge_base_articlesFreeRead-onlyLists organization knowledge base articles.
ninja_get_knowledge_base_article_signed_urlsFreeRead-onlyGet knowledge base article signed urls.
ninja_get_knowledge_base_folder_contentFreeRead-onlyReturns knowledge base folder.
ninja_get_knowledge_base_folder_path_contentFreeRead-onlyReturns knowledge base folder.
ninja_get_related_item_attachments_signed_urlsFreeRead-onlyGet related item attachments signed urls.
ninja_move_knowledge_base_foldersProDestructiveMove knowledge base items.
ninja_restore_knowledge_base_articlesProWriteRestore archive knowledge base articles.
ninja_restore_knowledge_base_foldersProWriteRestore archived knowledge base folders.
ninja_update_knowledge_base_articlesProWriteUpdate knowledge base articles.
ninja_upload_knowledge_base_articlesProWriteUpload knowledge base articles.
ninja_upload_temp_attachmentsProWriteUpload temporary attachments.

[NinjaRMM] Archive knowledge base articles. This is a destructive operation and cannot be undone from StackJack.

ParamTypeRequiredDefaultDescription
bodyJsonstringyesRequest body as a JSON object string, matching the NinjaOne API schema for this operation.

[NinjaRMM] Archive knowledge base folders. This is a destructive operation and cannot be undone from StackJack.

ParamTypeRequiredDefaultDescription
bodyJsonstringyesRequest body as a JSON object string, matching the NinjaOne API schema for this operation.

[NinjaRMM] Delete knowledge base articles. This is a destructive operation and cannot be undone from StackJack.

ParamTypeRequiredDefaultDescription
bodyJsonstringyesRequest body as a JSON object string, matching the NinjaOne API schema for this operation.

[NinjaRMM] Delete knowledge base folders. This is a destructive operation and cannot be undone from StackJack.

ParamTypeRequiredDefaultDescription
bodyJsonstringyesRequest body as a JSON object string, matching the NinjaOne API schema for this operation.
ParamTypeRequiredDefaultDescription
articleNamestringnonullarticleName Omit to leave unset.
includeArchivedbooleannonullincludeArchived Omit to leave unset.
organizationIdsstringnonullorganizationIds Omit to leave unset.
ParamTypeRequiredDefaultDescription
articleIdintegeryesarticleId path identifier.
ParamTypeRequiredDefaultDescription
folderIdintegeryesfolderId path identifier.
includeArchivedbooleannonullincludeArchived Omit to leave unset.
ParamTypeRequiredDefaultDescription
folderIdintegernonullfolderId Omit to leave unset.
folderPathstringnonullfolderPath Omit to leave unset.
organizationIdintegernonullorganizationId Omit to leave unset.

[NinjaRMM] Move knowledge base items. This is a destructive operation and cannot be undone from StackJack.

ParamTypeRequiredDefaultDescription
bodyJsonstringyesRequest body as a JSON object string, matching the NinjaOne API schema for this operation.
ParamTypeRequiredDefaultDescription
bodyJsonstringyesRequest body as a JSON object string, matching the NinjaOne API schema for this operation.
ParamTypeRequiredDefaultDescription
bodyJsonstringyesRequest body as a JSON object string, matching the NinjaOne API schema for this operation.
ParamTypeRequiredDefaultDescription
bodyJsonstringyesRequest body as a JSON object string, matching the NinjaOne API schema for this operation.
ParamTypeRequiredDefaultDescription
fileContentBase64stringyesFile content, base64-encoded.
fileNamestringyesFile name including extension, e.g. 'inventory.csv'.
folderIdintegernonullfolderId. Optional.
folderPathstringnonullfolderPath. Optional.
organizationIdintegernonullorganizationId. Optional.
ParamTypeRequiredDefaultDescription
entityTypestringnonullentityType One of: TICKET, NODE, DOCUMENT, RELATED_ITEM, CHECKLIST, AUTOMATION, LOCATION, ORGANIZATION, TRIGGER, TECHNICIAN, FILE_TRANSFER_AUTOMATION, END_USER, EMAIL_TEMPLATE, POLICY. Omit to leave unset.
fileContentBase64stringyesFile content, base64-encoded.
fileNamestringyesFile name including extension, e.g. 'inventory.csv'.

Checklist Templates

ToolPlanAccessSummary
ninja_archive_checklist_templateProDestructiveArchive a checklist template.
ninja_create_checklist_templatesProWriteCreate checklist templates.
ninja_delete_checklist_templateProDestructiveDelete a checklist template.
ninja_delete_checklist_templatesProDestructiveDelete checklist templates.
ninja_get_checklist_templatesFreeRead-onlyList checklist templates.
ninja_restore_checklist_templateProWriteRestore a checklist template.
ninja_update_checklist_templatesProDestructiveUpdate checklist templates.

[NinjaRMM] Archive a checklist template. This is a destructive operation and cannot be undone from StackJack.

ParamTypeRequiredDefaultDescription
bodyJsonstringyesRequest body as a JSON object string, matching the NinjaOne API schema for this operation.
ParamTypeRequiredDefaultDescription
bodyJsonstringyesRequest body as a JSON object string, matching the NinjaOne API schema for this operation.

[NinjaRMM] Delete a checklist template. This is a destructive operation and cannot be undone from StackJack.

ParamTypeRequiredDefaultDescription
checklistTemplateIdintegeryeschecklistTemplateId path identifier.

[NinjaRMM] Delete checklist templates. This is a destructive operation and cannot be undone from StackJack.

ParamTypeRequiredDefaultDescription
bodyJsonstringyesRequest body as a JSON object string, matching the NinjaOne API schema for this operation.
ParamTypeRequiredDefaultDescription
checklistTemplateIdsstringnonullchecklistTemplateIds Omit to leave unset.
checklistTemplateNamestringnonullchecklistTemplateName Omit to leave unset.
includeArchivedbooleannonullincludeArchived Omit to leave unset.
requiredbooleannonullrequired Omit to leave unset.
ParamTypeRequiredDefaultDescription
bodyJsonstringyesRequest body as a JSON object string, matching the NinjaOne API schema for this operation.

[NinjaRMM] Update checklist templates. This is a destructive operation and cannot be undone from StackJack.

ParamTypeRequiredDefaultDescription
bodyJsonstringyesRequest body as a JSON object string, matching the NinjaOne API schema for this operation.

Organization Checklists

ToolPlanAccessSummary
ninja_archive_organization_checklistsProDestructiveArchive organization checklists.
ninja_create_organization_checklistsProWriteCreate organization checklists.
ninja_create_organization_checklists_from_templatesProWriteCreate organization checklists from templates.
ninja_delete_client_checklistProDestructiveDelete an organization checklist.
ninja_delete_client_checklistsProDestructiveDelete organization checklists.
ninja_get_client_checklistFreeRead-onlyGet client checklist.
ninja_get_client_checklist_signed_urlsFreeRead-onlyGet organization checklist signed urls.
ninja_get_client_checklistsFreeRead-onlyList client checklists.
ninja_promote_organization_checklistsProWritePromote organization checklists.
ninja_promote_organization_checklists_with_nameProWritePromote organization checklists.
ninja_restore_organization_checklistsProWriteRestore organization checklists.
ninja_update_organization_checklistsProDestructiveUpdate organization checklists.

[NinjaRMM] Archive organization checklists. This is a destructive operation and cannot be undone from StackJack.

ParamTypeRequiredDefaultDescription
bodyJsonstringyesRequest body as a JSON object string, matching the NinjaOne API schema for this operation.
ParamTypeRequiredDefaultDescription
bodyJsonstringyesRequest body as a JSON object string, matching the NinjaOne API schema for this operation.
ParamTypeRequiredDefaultDescription
bodyJsonstringyesRequest body as a JSON object string, matching the NinjaOne API schema for this operation.
organizationIdintegeryesorganizationId path identifier.

[NinjaRMM] Delete an organization checklist. This is a destructive operation and cannot be undone from StackJack.

ParamTypeRequiredDefaultDescription
checklistIdintegeryeschecklistId path identifier.

[NinjaRMM] Delete organization checklists. This is a destructive operation and cannot be undone from StackJack.

ParamTypeRequiredDefaultDescription
bodyJsonstringyesRequest body as a JSON object string, matching the NinjaOne API schema for this operation.
ParamTypeRequiredDefaultDescription
checklistIdintegeryeschecklistId path identifier.
ParamTypeRequiredDefaultDescription
checklistIdintegeryeschecklistId path identifier.
ParamTypeRequiredDefaultDescription
assignedToUserIdintegernonullassignedToUserId Omit to leave unset.
checklistIdsstringnonullchecklistIds Omit to leave unset.
checklistNamestringnonullchecklistName Omit to leave unset.
completedbooleannonullcompleted Omit to leave unset.
includeArchivedbooleannonullincludeArchived Omit to leave unset.
organizationIdsstringnonullorganizationIds Omit to leave unset.
requiredbooleannonullrequired Omit to leave unset.
ParamTypeRequiredDefaultDescription
bodyJsonstringyesRequest body as a JSON object string, matching the NinjaOne API schema for this operation.
ParamTypeRequiredDefaultDescription
bodyJsonstringyesRequest body as a JSON object string, matching the NinjaOne API schema for this operation.
ParamTypeRequiredDefaultDescription
bodyJsonstringyesRequest body as a JSON object string, matching the NinjaOne API schema for this operation.

[NinjaRMM] Update organization checklists. This is a destructive operation and cannot be undone from StackJack.

ParamTypeRequiredDefaultDescription
bodyJsonstringyesRequest body as a JSON object string, matching the NinjaOne API schema for this operation.

Organization Documents

ToolPlanAccessSummary
ninja_archive_client_documentProDestructiveArchive an organization document.
ninja_archive_multi_page_client_documentsProDestructiveArchives organization documents.
ninja_create_organization_documentProWriteCreate organization document.
ninja_delete_client_documentProDestructiveDelete an archived organization document.
ninja_get_client_document_signed_urlsFreeRead-onlyGet organization document signed urls.
ninja_restore_client_documentProWriteRestore an organization document.
ninja_restore_multi_page_client_documentsProWriteRestore multiple multi page organization documents.
ninja_update_organization_documentProWriteUpdate organization document.
ninja_update_organization_documentsProWriteUpdate organization documents.

[NinjaRMM] Archive an organization document. This is a destructive operation and cannot be undone from StackJack.

ParamTypeRequiredDefaultDescription
clientDocumentIdintegeryesclientDocumentId path identifier.

[NinjaRMM] Archives organization documents. This is a destructive operation and cannot be undone from StackJack.

ParamTypeRequiredDefaultDescription
bodyJsonstringyesRequest body as a JSON object string, matching the NinjaOne API schema for this operation.
ParamTypeRequiredDefaultDescription
bodyJsonstringyesRequest body as a JSON object string, matching the NinjaOne API schema for this operation.
documentTemplateIdintegeryesdocumentTemplateId path identifier.
organizationIdintegeryesorganizationId path identifier.

[NinjaRMM] Delete an archived organization document. This is a destructive operation and cannot be undone from StackJack.

ParamTypeRequiredDefaultDescription
clientDocumentIdintegeryesclientDocumentId path identifier.
ParamTypeRequiredDefaultDescription
clientDocumentIdintegeryesclientDocumentId path identifier.
ParamTypeRequiredDefaultDescription
clientDocumentIdintegeryesclientDocumentId path identifier.
ParamTypeRequiredDefaultDescription
bodyJsonstringyesRequest body as a JSON object string, matching the NinjaOne API schema for this operation.
ParamTypeRequiredDefaultDescription
bodyJsonstringyesRequest body as a JSON object string, matching the NinjaOne API schema for this operation.
clientDocumentIdintegeryesclientDocumentId path identifier.
organizationIdintegeryesorganizationId path identifier.
ParamTypeRequiredDefaultDescription
bodyJsonstringyesRequest body as a JSON object string, matching the NinjaOne API schema for this operation.

Document Templates

ToolPlanAccessSummary
ninja_archive_document_templateProDestructiveArchive a document template.
ninja_archive_document_templatesProDestructiveArchive multiple document templates.
ninja_create_document_templateProWriteCreate document template.
ninja_delete_document_templateProDestructiveDelete a document template.
ninja_get_document_templateFreeRead-onlyGet document template.
ninja_get_document_templates_with_attributesFreeRead-onlyList document templates with fields.
ninja_restore_document_templateProWriteRestore a document template.
ninja_restore_document_templatesProWriteRestore a document template.
ninja_update_document_templateProDestructiveUpdate document template.

[NinjaRMM] Archive a document template. This is a destructive operation and cannot be undone from StackJack.

ParamTypeRequiredDefaultDescription
documentTemplateIdintegeryesdocumentTemplateId path identifier.

[NinjaRMM] Archive multiple document templates. This is a destructive operation and cannot be undone from StackJack.

ParamTypeRequiredDefaultDescription
bodyJsonstringyesRequest body as a JSON object string, matching the NinjaOne API schema for this operation.
ParamTypeRequiredDefaultDescription
bodyJsonstringyesRequest body as a JSON object string, matching the NinjaOne API schema for this operation.

[NinjaRMM] Delete a document template. This is a destructive operation and cannot be undone from StackJack.

ParamTypeRequiredDefaultDescription
documentTemplateIdintegeryesdocumentTemplateId path identifier.
ParamTypeRequiredDefaultDescription
documentTemplateIdintegeryesdocumentTemplateId path identifier.
includeTechnicianRolesbooleannonullIncludes allowed technician roles. Omit to leave unset.
ParamTypeRequiredDefaultDescription
includeTechnicianRolesbooleannonullIncludes allowed technician roles. Omit to leave unset.
templateNamestringnonulltemplateName Omit to leave unset.
ParamTypeRequiredDefaultDescription
documentTemplateIdintegeryesdocumentTemplateId path identifier.
ParamTypeRequiredDefaultDescription
bodyJsonstringyesRequest body as a JSON object string, matching the NinjaOne API schema for this operation.

[NinjaRMM] Update document template. This is a destructive operation and cannot be undone from StackJack.

ParamTypeRequiredDefaultDescription
bodyJsonstringyesRequest body as a JSON object string, matching the NinjaOne API schema for this operation.
documentTemplateIdintegeryesdocumentTemplateId path identifier.

Asset Tags

ToolPlanAccessSummary
ninja_batch_update_tagsProDestructiveBatch tag assets.
ninja_create_tagProWriteCreate an Asset Tag.
ninja_delete_tagProDestructiveDelete an Asset Tag.
ninja_delete_tagsProDestructiveDelete several Asset Tags.
ninja_get_tagsFreeRead-onlyGet Asset Tags.
ninja_merge_tagsProDestructiveMerge existing tags.
ninja_set_tags_for_assetProDestructiveSet tags for an asset.
ninja_update_tagProDestructiveUpdate an Asset Tag.

[NinjaRMM] Batch tag assets. This is a destructive operation and cannot be undone from StackJack.

ParamTypeRequiredDefaultDescription
assetTypestringyesassetType path identifier.
bodyJsonstringyesRequest body as a JSON object string, matching the NinjaOne API schema for this operation.
ParamTypeRequiredDefaultDescription
bodyJsonstringyesRequest body as a JSON object string, matching the NinjaOne API schema for this operation.

[NinjaRMM] Delete an Asset Tag. This is a destructive operation and cannot be undone from StackJack.

ParamTypeRequiredDefaultDescription
tagIdintegeryestagId path identifier.

[NinjaRMM] Delete several Asset Tags. This is a destructive operation and cannot be undone from StackJack.

ParamTypeRequiredDefaultDescription
bodyJsonstringyesRequest body as a JSON object string, matching the NinjaOne API schema for this operation.

[NinjaRMM] Merge existing tags. This is a destructive operation and cannot be undone from StackJack.

ParamTypeRequiredDefaultDescription
bodyJsonstringyesRequest body as a JSON object string, matching the NinjaOne API schema for this operation.

[NinjaRMM] Set tags for an asset. This is a destructive operation and cannot be undone from StackJack.

ParamTypeRequiredDefaultDescription
assetIdintegeryesassetId path identifier.
assetTypestringyesassetType path identifier.
bodyJsonstringyesRequest body as a JSON object string, matching the NinjaOne API schema for this operation.

[NinjaRMM] Update an Asset Tag. This is a destructive operation and cannot be undone from StackJack.

ParamTypeRequiredDefaultDescription
bodyJsonstringyesRequest body as a JSON object string, matching the NinjaOne API schema for this operation.
tagIdintegeryestagId path identifier.

Custom Field Administration

ToolPlanAccessSummary
ninja_bulk_create_node_attributesProWriteBulk create custom fields.
ninja_bulk_delete_node_attributesProDestructiveBulk delete custom fields.
ninja_bulk_update_node_attributesProDestructiveBulk update custom fields.
ninja_create_node_attributeProWriteCreate a new custom field.
ninja_delete_node_attribute_by_field_nameProDestructiveDelete custom field by field name.
ninja_get_node_attribute_signed_urlsFreeRead-onlyGet custom field signed urls.
ninja_update_node_attribute_by_field_nameProDestructiveUpdate custom field by field name.
ParamTypeRequiredDefaultDescription
bodyJsonstringyesRequest body as a JSON object string, matching the NinjaOne API schema for this operation.

[NinjaRMM] Bulk delete custom fields. This is a destructive operation and cannot be undone from StackJack.

ParamTypeRequiredDefaultDescription
fieldNamesstringnonullComma-separated list of field names to delete Omit to leave unset.

[NinjaRMM] Bulk update custom fields. This is a destructive operation and cannot be undone from StackJack.

ParamTypeRequiredDefaultDescription
bodyJsonstringyesRequest body as a JSON object string, matching the NinjaOne API schema for this operation.
ParamTypeRequiredDefaultDescription
bodyJsonstringyesRequest body as a JSON object string, matching the NinjaOne API schema for this operation.

[NinjaRMM] Delete custom field by field name. This is a destructive operation and cannot be undone from StackJack.

ParamTypeRequiredDefaultDescription
fieldNamestringyesfieldName path identifier.
ParamTypeRequiredDefaultDescription
entityIdintegeryesentityId path identifier.
entityTypestringyesentityType path identifier.

[NinjaRMM] Update custom field by field name. This is a destructive operation and cannot be undone from StackJack.

ParamTypeRequiredDefaultDescription
bodyJsonstringyesRequest body as a JSON object string, matching the NinjaOne API schema for this operation.
fieldNamestringyesfieldName path identifier.
ToolPlanAccessSummary
ninja_create_related_item_attachmentProWriteCreate Attachment Relation.
ninja_create_related_item_relationProWriteCreate entity relation.
ninja_create_related_item_relationsProWriteCreate entity relations.
ninja_create_secure_related_item_for_entityProWriteCreate Secure Relation.
ninja_delete_related_itemProDestructiveDelete related item.
ninja_delete_related_itemsProDestructiveDelete related items.
ninja_get_all_related_itemsFreeRead-onlyList all related items.
ninja_get_related_items_for_host_entityFreeRead-onlyList host entity related items by scope.
ninja_get_related_items_with_entityFreeRead-onlyList related entity related items.
ninja_get_related_items_with_entity_typeFreeRead-onlyList related entity type related items.
ninja_get_related_items_with_host_entity_typeFreeRead-onlyList host entity type related items.

Software Licenses

ToolPlanAccessSummary
ninja_create_software_licenseProWriteCreate a Software License.
ninja_delete_software_licenseProDestructiveDelete a Software License.
ninja_get_software_licenseFreeRead-onlyGet Software License.
ninja_update_software_licenseProDestructiveUpdate a Software License.
ninja_upsert_software_licenseProDestructiveCreate or Update a Software License.
ParamTypeRequiredDefaultDescription
bodyJsonstringyesRequest body as a JSON object string, matching the NinjaOne API schema for this operation.

[NinjaRMM] Delete a Software License. This is a destructive operation and cannot be undone from StackJack.

ParamTypeRequiredDefaultDescription
licenseIdintegeryeslicenseId path identifier.
ParamTypeRequiredDefaultDescription
licenseIdintegeryeslicenseId path identifier.

[NinjaRMM] Update a Software License. This is a destructive operation and cannot be undone from StackJack.

ParamTypeRequiredDefaultDescription
bodyJsonstringyesRequest body as a JSON object string, matching the NinjaOne API schema for this operation.
licenseIdintegeryeslicenseId path identifier.

[NinjaRMM] Create or Update a Software License. This is a destructive operation and cannot be undone from StackJack.

ParamTypeRequiredDefaultDescription
bodyJsonstringyesRequest body as a JSON object string, matching the NinjaOne API schema for this operation.

Unmanaged Devices

ToolPlanAccessSummary
ninja_create_unmanaged_device_public_apiProWriteCreate an Unmanaged Device.
ninja_decommission_unmanaged_device_public_apiProDestructiveDecommission an Unmanaged Device.
ninja_decommission_unmanaged_device_public_api_listProDestructiveDecommission an Unmanaged Device List.
ninja_delete_unmanaged_device_public_apiProDestructiveDelete an Unmanaged Device.
ninja_update_unmanaged_device_public_apiProDestructiveUpdate an Unmanaged Device.
ParamTypeRequiredDefaultDescription
bodyJsonstringyesRequest body as a JSON object string, matching the NinjaOne API schema for this operation.

[NinjaRMM] Decommission an Unmanaged Device. This is a destructive operation and cannot be undone from StackJack.

ParamTypeRequiredDefaultDescription
nodeIdintegeryesnodeId path identifier.

[NinjaRMM] Decommission an Unmanaged Device List. This is a bulk destructive operation and cannot be undone from StackJack.

ParamTypeRequiredDefaultDescription
bodyJsonstringyesRequest body as a JSON object string, matching the NinjaOne API schema for this operation.

[NinjaRMM] Delete an Unmanaged Device. This is a destructive operation and cannot be undone from StackJack.

ParamTypeRequiredDefaultDescription
nodeIdintegeryesnodeId path identifier.

[NinjaRMM] Update an Unmanaged Device. This is a destructive operation and cannot be undone from StackJack.

ParamTypeRequiredDefaultDescription
bodyJsonstringyesRequest body as a JSON object string, matching the NinjaOne API schema for this operation.
nodeIdintegeryesnodeId path identifier.

Backup

ToolPlanAccessSummary
ninja_get_backup_jobsFreeRead-onlyBackup jobs.
ninja_get_integrity_check_jobsFreeRead-onlyIntegrity check jobs.
ninja_get_location_usageFreeRead-onlyOrganization location backup usage.
ninja_get_organization_location_usageFreeRead-onlyOrganization locations backup usage.
ninja_set_bandwidth_throttle_for_deviceProWriteSets the bandwidth throttle for a device.
ninja_submit_integrity_check_jobProWriteCreate an integrity check job.
ParamTypeRequiredDefaultDescription
cursorstringnonullCursor name Omit to leave unset.
ddfstringnonullDeleted device filter Omit to leave unset.
dfstringnonullDevice filter Omit to leave unset.
includestringnonullWhich devices include (active|deleted|all) default value active Omit to leave unset.
pageSizeintegernonullLimit number of records per page Omit to leave unset.
ptfstringnonullBackup job planType filter Omit to leave unset.
sfstringnonullBackup job status filter Omit to leave unset.
stfstringnonullBackup job startTime filter Omit to leave unset.
ParamTypeRequiredDefaultDescription
cursorstringnonullCursor name. Omit to leave unset.
ddfstringnonullDeleted device filter. Omit to leave unset.
dfstringnonullDevice filter. Omit to leave unset.
includestringnonullWhich devices include (active|deleted|all) default value active. Omit to leave unset.
pageSizeintegernonullLimit number of records per page. Omit to leave unset.
ptfstringnonullBackup job planType filter. Omit to leave unset.
sfstringnonullBackup job status filter. Omit to leave unset.
stfstringnonullBackup job startTime filter. Omit to leave unset.
ParamTypeRequiredDefaultDescription
idintegeryesid path identifier.
locationIdintegeryeslocationId path identifier.
ParamTypeRequiredDefaultDescription
idstringyesid path identifier.
ParamTypeRequiredDefaultDescription
bodyJsonstringyesRequest body as a JSON object string, matching the NinjaOne API schema for this operation.
ParamTypeRequiredDefaultDescription
bodyJsonstringyesRequest body as a JSON object string, matching the NinjaOne API schema for this operation.

Custom Tabs

ToolPlanAccessSummary
ninja_create_custom_tab_public_apiProWriteCreate a new Custom Tab.
ninja_delete_custom_tab_public_apiProDestructiveDelete a Custom Tab.
ninja_get_custom_tab_public_apiFreeRead-onlyRetrieve a Custom Tab.
ninja_get_tab_hierarchy_for_end_userFreeRead-onlyRetrieve the requested tab along with any extensions for end-user tabs.
ninja_get_tab_hierarchy_for_organizationFreeRead-onlyRetrieve the requested tab along with any extensions for organization and location tabs.
ninja_get_tab_hierarchy_for_roleFreeRead-onlyRetrieve the requested tab along with any extensions based on the supplied roleId.
ninja_get_tab_summary_for_end_userFreeRead-onlyRetrieve all of the custom tabs available to end user views.
ninja_get_tab_summary_for_organizationFreeRead-onlyRetrieve all of the custom tabs available to organizations and locations.
ninja_get_tab_summary_for_roleFreeRead-onlyRetrieve all of the custom tabs that would appear for the given role.
ninja_rename_custom_tab_public_apiProWriteRename a Custom Tab.
ninja_update_custom_tab_public_apiProWriteUpdate a Custom Tab.
ninja_update_custom_tabs_displayProWriteSet the tab visibility of the specified tab.
ninja_update_end_user_custom_tabs_orderProWriteUpdate the order of custom tabs for end-user tabs.
ninja_update_organization_custom_tabs_orderProWriteUpdate the order of custom tabs for organizations and locations.
ninja_update_role_custom_tabs_orderProWriteUpdate the order of custom tabs for a specific role.
ParamTypeRequiredDefaultDescription
bodyJsonstringyesRequest body as a JSON object string, matching the NinjaOne API schema for this operation.

[NinjaRMM] Delete a Custom Tab. This is a destructive operation and cannot be undone from StackJack.

ParamTypeRequiredDefaultDescription
tabIdintegeryestabId path identifier.
ParamTypeRequiredDefaultDescription
tabIdintegeryestabId path identifier.
ParamTypeRequiredDefaultDescription
tabIdintegeryestabId path identifier.
ParamTypeRequiredDefaultDescription
tabIdintegeryestabId path identifier.
ParamTypeRequiredDefaultDescription
roleIdintegeryesroleId path identifier.
tabIdintegeryestabId path identifier.
ParamTypeRequiredDefaultDescription
roleIdintegeryesroleId path identifier.
ParamTypeRequiredDefaultDescription
bodyJsonstringyesRequest body as a JSON object string, matching the NinjaOne API schema for this operation.
ParamTypeRequiredDefaultDescription
bodyJsonstringyesRequest body as a JSON object string, matching the NinjaOne API schema for this operation.
tabIdintegeryestabId path identifier.
ParamTypeRequiredDefaultDescription
bodyJsonstringyesRequest body as a JSON object string, matching the NinjaOne API schema for this operation.
roleIdintegeryesroleId path identifier.
ParamTypeRequiredDefaultDescription
bodyJsonstringyesRequest body as a JSON object string, matching the NinjaOne API schema for this operation.
ParamTypeRequiredDefaultDescription
bodyJsonstringyesRequest body as a JSON object string, matching the NinjaOne API schema for this operation.
ParamTypeRequiredDefaultDescription
bodyJsonstringyesRequest body as a JSON object string, matching the NinjaOne API schema for this operation.
roleIdintegeryesroleId path identifier.

Vulnerability Management

ToolPlanAccessSummary
ninja_fetch_all_scan_groupsFreeRead-onlyFetch all Scan Groups.
ninja_fetch_scan_group_by_idFreeRead-onlyFetch Scan Group.
ninja_upload_vulnerability_scan_group_csvProWriteUpload CSV.
ParamTypeRequiredDefaultDescription
scanGroupIdintegeryesscan-group-id path identifier.
ParamTypeRequiredDefaultDescription
fileContentBase64stringyesFile content, base64-encoded.
fileNamestringyesFile name including extension, e.g. 'inventory.csv'.
scanGroupIdintegeryesscan-group-id path identifier.