NinjaOne Integration Setup
This Integration supports multiple instances
Check out the instructions to set up multiple instances here.
Overview
Integrating Rewst with NinjaRMM provides users with a powerful combination of documentation and remote monitoring and management capabilities. By bringing these two platforms together, Rewst users can streamline their operations and enhance efficiency. With the integration, users can seamlessly access and manage NinjaRMM within Rewst, enabling them to monitor and troubleshoot devices, deploy software, and perform remote tasks more effectively. This integration empowers users to centralize their IT documentation and RMM workflows, ensuring a comprehensive and streamlined approach to IT management within the Rewst platform.
Setup
Complete Setup in Ninja
First, go to Ninja and complete the following:
Go to Administration -> Library -> Automation.
Click + Add -> New Script on the right.
Add the following script:
Name: Rewst (Windows)
Language: Powershell
OS: Windows
Architecture: All
Complete Setup in Rewst
Follow the below steps to configure a new integration in Rewst:
Log in to the Rewst platform.
Go to Configuration β Integrations menu on the left sidebar.
Click or search for "Ninja".
Select your Region.
Authorize OAuth into Ninja via Microsoft.
You should see your customer show up at the bottom.
Click Save.
Actions
Devices
List Custom Fields for Deviceβ
Returns a list of applicable management optionsβ
GET /device/{id}/custom-fields
Parameter | Type | Required | Description |
---|---|---|---|
Device | string | Yes |
Update Field Valuesβ
Update the device's custom field valuesβ
PATCH /device/{id}/custom-fields
Parameter | Type | Required | Description |
---|---|---|---|
Device | string | Yes |
Get Last Logged On User For Deviceβ
Returns username that was last to login to the deviceβ
GET /device/{id}/last-logged-on-user
Parameter | Type | Required | Description |
---|---|---|---|
Device | string | Yes |
List OS Patches by Deviceβ
Returns list of pending/rejected/approved
OS patches for deviceβ
GET /device/{id}/os-patches
Parameter | Type | Required | Description |
---|---|---|---|
Device | string | Yes | |
Status | string | No | Return Activities With Status(es) |
Type | string | No | Update Type Filter |
Severity | string | No |
Get OS Update Installation Report By Deviceβ
Returns patch installation history records (successful and failed) for the deviceβ
GET /device/{id}/os-patch-installs
Parameter | Type | Required | Description |
---|---|---|---|
Device | string | Yes | |
Status | string | No | Return Activities With Status(es) |
Installed Before | string | No | Include Patches Installed Before Specified Date |
Installed After | string | No | Include Patches Installed After Specified Date |
Get Software Update History by Deviceβ
Returns 3rd party software patch installation history records for a device (successful and failed)β
GET /device/{id}/software-patch-installs
Parameter | Type | Required | Description |
---|---|---|---|
Device | string | Yes | |
Type | string | No | Update Type Filter |
Impact | string | No | Update Impact Filter |
Status | string | No | Return Activities With Status(es) |
Product | string | No | |
Installed Before | string | No | Include Patches Installed Before Specified Date |
Installed After | string | No | Include Patches Installed After Specified Date |
List Disk Drives by Deviceβ
Returns device disks' detailsβ
GET /device/{id}/disks
Parameter | Type | Required | Description |
---|---|---|---|
Device | string | Yes |
List Storage Volumes by Deviceβ
Returns device volumes' detailsβ
GET /device/{id}/volumes
Parameter | Type | Required | Description |
---|---|---|---|
Device | string | Yes | |
Include | string | No | Additional Information To Include (Bl - Bit Locker Status) |
List Processors by Deviceβ
Returns list of device Processor detailsβ
GET /device/{id}/processors
Parameter | Type | Required | Description |
---|---|---|---|
Device | string | Yes |
List Installed Software by Deviceβ
Returns list of software installed on a deviceβ
GET /device/{id}/software
Parameter | Type | Required | Description |
---|---|---|---|
Device | string | Yes |
Device Alerts (Triggered Conditions) by Deviceβ
Returns list of active alerts (triggered conditions) for deviceβ
GET /device/{id}/alerts
Parameter | Type | Required | Description |
---|---|---|---|
Device | string | Yes | |
Lang | string | No | Language |
Device Currently Running (Active) Jobs by Deviceβ
Returns currently running jobs for deviceβ
GET /device/{id}/jobs
Parameter | Type | Required | Description |
---|---|---|---|
Device | string | Yes | |
Lang | string | No | Language |
List Windows Services by Deviceβ
Returns list of Windows Services for a device and their statusesβ
GET /device/{id}/windows-services
Parameter | Type | Required | Description |
---|---|---|---|
Device | string | Yes | |
Service Name | string | No | |
State | string | No | Service State |
Get Device Detailsβ
Returns device detailsβ
GET /device/{id}
Parameter | Type | Required | Description |
---|---|---|---|
Device | string | Yes |
Get Device Activitiesβ
Returns activity log for deviceβ
GET /device/{id}/activities
Parameter | Type | Required | Description |
---|---|---|---|
Device | string | Yes | |
Older Than | string | No | Return Activities Recorded That Are Newer Than Specified Activity ID |
Newer Than | string | No | Return Activities Recorded That Are Older Than Specified Activity ID |
Activity Type | string | No | Return Activities Of Type |
Status | string | No | Return Activities With Status(es) |
Series Uid | string | No | Return Activities Related To Alert (Series) |
Lang | string | No | Language |
Pending, Failed And Rejected Software Patches For Deviceβ
Returns list of 3rd party Software patches for a device (for which there were no installation attempts)β
GET /device/{id}/software-patches
Parameter | Type | Required | Description |
---|---|---|---|
Device | string | Yes | |
Status | string | No | Return Activities With Status(es) |
Product | string | No | |
Type | string | No | Update Type Filter |
Impact | string | No | Update Impact Filter |
Groups
List Group Members' Devicesβ
Returns list of device identifiers that match group criteriaβ
GET /group/{id}/device-ids
Parameter | Type | Required | Description |
---|---|---|---|
Group | string | Yes | |
Refresh | string | No |
Management
Reset Alert/Condition
And Provide Custom Data For Activityβ
/Condition
And Provide Custom Data For Activityβ/alert/{uid}/reset
Parameter | Type | Required | Description |
---|---|---|---|
Alert | string | Yes |
Update API Webhook Configurationβ
Creates or updates Webhook configuration for the current application/client
β
PUT /webhook
Parameter | Type | Required | Description |
---|---|---|---|
URL | string | No | Callback (Web Hook) URL For Activity Notifications |
Activities | object | No | Activity Filter |
Expand | string | No | Which References To Expand In Payloads |
Headers | array | No |
Remove Webhook API Channelβ
Creates or updates PSA configuration based on clientβ
DELETE /webhook
Approve/Reject
Devicesβ
/Reject
DevicesβApprove or reject devices that are waiting for approvalβ
/devices/approval/{mode}
Parameter | Type | Required | Description |
---|---|---|---|
Mode | string | Yes | |
Devices | array | No |
Reset Alert/Condition
β
/Condition
βDELETE /alert/{uid}
Parameter | Type | Required | Description |
---|---|---|---|
Alert | string | Yes |
Modify Windows Service Configurationβ
Configures Windows Service startup settingsβ
/device/{id}/windows-service/{serviceId}/configure
Parameter | Type | Required | Description |
---|---|---|---|
Device | string | Yes | |
Service ID | string | Yes | Service Identifier |
Start Type | string | No | Start Type |
Username | string | No |
Reboot Deviceβ
Sends a command to restart the computerβ
/device/{id}/reboot/{mode}
Parameter | Type | Required | Description |
---|---|---|---|
Device | string | Yes | |
Mode | string | Yes | Reboot Mode |
Reason | string | No | Stated Reboot Reason |
List Scripting Options by Deviceβ
Returns scripting options (built-in actions, custom scripts) available for deviceβ
GET /device/{id}/scripting/options
Parameter | Type | Required | Description |
---|---|---|---|
Device | string | Yes | |
Lang | string | No | Language |
Update Device Informationβ
Change device-friendly name, user data, etcβ
PATCH /device/{id}
Parameter | Type | Required | Description |
---|---|---|---|
Device | string | Yes | |
Display Name | string | No | Display Name (User Assigned) |
Custom Attributes | string | No | User Specified |
nodeRoleId | string | No | |
Policy | string | No |
Get Device Linkβ
Returns link to the deviceβ
GET /device/{id}/dashboard-url
Parameter | Type | Required | Description |
---|---|---|---|
Device | string | Yes | |
Redirect | boolean | No | Return Redirect Response |
Control Windows Serviceβ
Start/Stop/Restart
Windows Service on a deviceβ
/device/{id}/windows-service/{serviceId}/control
Parameter | Type | Required | Description |
---|---|---|---|
Device | string | Yes | |
Service ID | string | Yes | Service Identifier |
Action | string | No | Action |
Schedule Maintenanceβ
Schedule maintenance window for deviceβ
PUT /device/{id}/maintenance
Parameter | Type | Required | Description |
---|---|---|---|
Device | string | Yes | |
Disabled Features | array | No | List Of Features That Will Be Disabled During Maintenance |
Maintenance Window Start | number | No | Unix Timestamp, with milliseconds (i.e. 1666373777.891) - Defaults to now. |
Maintenance Window End | number | No | Unix Timestamp, with milliseconds (i.e. 1666373777.891), at least 5 minutes after the start. |
Cancel Maintenanceβ
Cancel pending or active maintenance for the deviceβ
DELETE /device/{id}/maintenance
Parameter | Type | Required | Description |
---|---|---|---|
Device | string | Yes |
Run Script Or Built In Actionβ
Run script or built-in action on a deviceβ
/device/{id}/script/run
Parameter | Type | Required | Description |
---|---|---|---|
ID | integer | No | Script Identifier |
Type | string | No | Type |
Uid | string | No | Built In Action Identifier |
Parameters | string | No | Action |
Run As | string | No | Credential Role |
Create Location For Organizationβ
Creates new location for the organizationβ
/organization/{id}/locations
Parameter | Type | Required | Description |
---|---|---|---|
Organization | string | Yes | |
Name | string | No | Location Name |
Address | string | No | Address |
Description | string | No | Description |
Custom Attributes | string | No | User Specified |
Tags | string | No | Tags |
Fields | string | No | Custom Fields |
Update Organizationβ
Change organization name, description and policy mappingsβ
PATCH /organization/{id}
Parameter | Type | Required | Description |
---|---|---|---|
Organization | string | Yes | |
Name | string | No | Organization Full Name |
Description | string | No | Organization Description |
Custom Attributes | string | No | User Specified |
Node Approval Mode | string | No | Device Approval Mode |
Tags | string | No | Tags |
Fields | string | No | Custom Fields |
Generate Installerβ
Generates and returns URL for an installer for a specified organization/location
β
GET /organization/{id}/location/{location_id}/installer/{installer_type}
Parameter | Type | Required | Description |
---|---|---|---|
Organization | string | Yes | |
Location | integer | Yes | |
Installer Type | string | Yes |
Update Locationβ
Change location name, address, description, custom dataβ
PATCH /organization/{id}/locations/{locationId}
Parameter | Type | Required | Description |
---|---|---|---|
Organization | string | Yes | |
Location ID | integer | Yes | |
Name | string | No | Location Name |
Address | string | No | Address |
Description | string | No | Description |
Custom Attributes | string | No | User Specified |
Tags | string | No | Tags |
Fields | string | No | Custom Fields |
Change Organization Policy Mappingsβ
Update policy assignment for node role(s). Returns list of affected device IDsβ
PUT /organization/{id}/policies
Parameter | Type | Required | Description |
---|---|---|---|
Organization | string | Yes |
Organization
Create New Organizationβ
Creates a new organization with an optional list of locations and policy mappings. Template organization ID can be specified to copy various settingsβ
/organizations
Parameter | Type | Required | Description |
---|---|---|---|
Organization | string | No | |
Name | string | No | Organization Full Name |
Description | string | No | Organization Description |
Custom Attributes | string | No | User Specified |
Node Approval Mode | string | No | Device Approval Mode |
Tags | string | No | Tags |
Fields | string | No | Custom Fields |
Locations | array | No | List Of Locations |
Policies | array | No | Node Role Policy Assignments |
List Organization Locationsβ
Returns list of locations for organizationβ
GET /organization/{id}/locations
Parameter | Type | Required | Description |
---|---|---|---|
Organization | string | Yes |
Get Organization Informationβ
Returns organization details (policy mappings, locations)β
GET /organization/{id}
Parameter | Type | Required | Description |
---|---|---|---|
Organization | string | Yes |
List Users for Organizationβ
Returns list of end-users for organizationβ
GET /organization/{id}/end-users
Parameter | Type | Required | Description |
---|---|---|---|
Organization | string | Yes |
List Organization Documentsβ
Returns organization documentsβ
GET /organization/{id}/documents
Parameter | Type | Required | Description |
---|---|---|---|
Organization | string | Yes |
List Organization Devicesβ
Returns list of devices for organizationβ
GET /organization/{id}/devices
Parameter | Type | Required | Description |
---|---|---|---|
Organization | string | Yes |
Queries
List Uninstalled OS Patchesβ
Returns list of OS patches for which there were no installation attemptsβ
GET /queries/os-patches
Parameter | Type | Required | Description |
---|---|---|---|
Device Filter | string | No | Device Filter |
Timestamp Filter | string | No | Monitoring Timestamp Filter |
Status | string | No | Return Activities With Status(es) |
Type | string | No | Update Type Filter |
Severity | string | No | Update Severity Filter |
List Pending, Failed And Rejected 3rd Party Software Patchesβ
Returns list of 3rd party Software patches for which there were no installation attemptsβ
GET /queries/software-patches
Parameter | Type | Required | Description |
---|---|---|---|
Device Filter | string | No | Device Filter |
Timestamp Filter | string | No | Monitoring Timestamp Filter |
Status | string | No | Update Status Filter |
Product | string | No | |
Type | string | No | Update Type Filter |
Impact | string | No | Update Impact Filter |
List Software Update Historyβ
Returns 3rd party software patch installation history records (successful and failed)β
GET /queries/software-patch-installs
Parameter | Type | Required | Description |
---|---|---|---|
Device Filter | string | No | Device Filter |
Type | string | No | Update Type Filter |
Impact | string | No | Update Impact Filter |
Status | string | No | Update Status Filter |
Product | string | No | |
Installed Before | string | No | Include Patches Installed Before Specified Date |
Installed After | string | No | Include Patches Installed After Specified Date |
Last Logged On User Reportβ
Returns usernames and logon timesβ
GET /queries/logged-on-users
Parameter | Type | Required | Description |
---|---|---|---|
Device Filter | string | No | Device Filter |
List Custom Fields with Detailsβ
Returns Custom Fields report with additional information about each fieldβ
GET /queries/custom-fields-detailed
Parameter | Type | Required | Description |
---|---|---|---|
Device Filter | string | No | Device Filter |
Updated After | string | No | Custom Fields Updated After Specified Date |
Fields | string | No | Custom Fields |
List Health Status by Deviceβ
Returns list of device health summary recordsβ
GET /queries/device-health
Parameter | Type | Required | Description |
---|---|---|---|
Device Filter | string | No | Device Filter |
Health | string | No | Health Status Filter |
List Software Inventoryβ
Returns list software installed on devicesβ
GET /queries/software
Parameter | Type | Required | Description |
---|---|---|---|
Device Filter | string | No | Device Filter |
Installed Before | string | No | Include Patches Installed Before Specified Date |
Installed After | string | No | Include Patches Installed After Specified Date |
List OS Update Installationsβ
Returns patch installation history records (successful and failed)β
GET /queries/os-patch-installs
Parameter | Type | Required | Description |
---|---|---|---|
Device Filter | string | No | Device Filter |
Status | string | No | Return Activities With Status(es) |
Installed Before | string | No | Include Patches Installed Before Specified Date |
Installed After | string | No | Include Patches Installed After Specified Date |
List Antivirus Status by Deviceβ
Returns list of statues of antivirus software installed on devicesβ
GET /queries/antivirus-status
Parameter | Type | Required | Description |
---|---|---|---|
Device Filter | string | No | Device Filter |
Timestamp Filter | string | No | Monitoring Timestamp Filter |
Product State | string | No | Product State Filter |
Product Name | string | No | Product Name Filter |
List Raid Controllersβ
Returns list of RAID controllersβ
GET /queries/raid-controllers
Parameter | Type | Required | Description |
---|---|---|---|
Device Filter | string | No | Device Filter |
Timestamp Filter | string | No | Monitoring Timestamp Filter |
List Raid Drivesβ
Returns list of drives connected to RAID controllersβ
GET /queries/raid-drives
Parameter | Type | Required | Description |
---|---|---|---|
Device Filter | string | No | Device Filter |
Timestamp Filter | string | No | Monitoring Timestamp Filter |
List Windows Servicesβ
Returns list of Windows Services and their statusesβ
GET /queries/windows-services
Parameter | Type | Required | Description |
---|---|---|---|
Device Filter | string | No | Device Filter |
Name | string | No | Service Name |
State | string | No | Service State |
List Custom Fieldsβ
Returns Custom Fields reportβ
GET /queries/custom-fields
Parameter | Type | Required | Description |
---|---|---|---|
Device Filter | string | No | Device Filter |
Updated After | string | No | Custom Fields Updated After Specified Date |
Fields | string | No | Custom Fields |
List Computer Systemsβ
Returns computer systems information for devicesβ
GET /queries/computer-systems
Parameter | Type | Required | Description |
---|---|---|---|
Device Filter | string | No | Device Filter |
Timestamp Filter | string | No | Monitoring Timestamp Filter |
List Disk Drivesβ
Returns list of physical disksβ
GET /queries/disks
Parameter | Type | Required | Description |
---|---|---|---|
Device Filter | string | No | Device Filter |
Timestamp Filter | string | No | Monitoring Timestamp Filter |
List Antivirus Threatsβ
Returns list of antivirus threatsβ
GET /queries/antivirus-threats
Parameter | Type | Required | Description |
---|---|---|---|
Device Filter | string | No | Device Filter |
Timestamp Filter | string | No | Monitoring Timestamp Filter |
List Operating Systems by Deviceβ
Returns operating systems for devicesβ
GET /queries/operating-systems
Parameter | Type | Required | Description |
---|---|---|---|
Device Filter | string | No | Device Filter |
Timestamp Filter | string | No | Monitoring Timestamp Filter |
List Processorsβ
Returns list of processorsβ
GET /queries/processors
Parameter | Type | Required | Description |
---|---|---|---|
Device Filter | string | No | Device Filter |
Timestamp Filter | string | No | Monitoring Timestamp Filter |
List Disk Volumesβ
Returns list of disk volumesβ
GET /queries/volumes
Parameter | Type | Required | Description |
---|---|---|---|
Device Filter | string | No | Device Filter |
Timestamp Filter | string | No | Monitoring Timestamp Filter |
Include | string | No | Additional Information To Include (Bl Bit Locker Status) |
System
List Organizationsβ
Returns list of organizations (Brief mode)β
GET /organizations
Get Attachment by IDβ
Returns attachment (image, document)β
GET /attachment/{id}
Parameter | Type | Required | Description |
---|---|---|---|
ID | string | Yes | Attachment Identifier |
List All Device Custom Fieldsβ
Returns list of all custom fieldsβ
GET /device-custom-fields
List Active Alerts (Triggered Conditions)β
Returns list of active alerts/triggered
conditionsβ
GET /alerts
Parameter | Type | Required | Description |
---|---|---|---|
Source Type | string | No | |
Device Filter | string | No | Device Filter |
Lang | string | No | Language |
List Organizations with Locations and Policiesβ
Returns list of organizations with locations and policy mappingsβ
GET /organizations-detailed
List Device Rolesβ
Returns list of device rolesβ
GET /roles
List Supported 3rd Party Softwareβ
Returns available software products (3rd party patching)β
GET /software-products
List Devices (Detailed)β
Returns list of devices with additional informationβ
GET /devices-detailed
Parameter | Type | Required | Description |
---|---|---|---|
Device Filter | string | No | Device Filter |
List Active Jobsβ
Returns list of running jobsβ
GET /jobs
Parameter | Type | Required | Description |
---|---|---|---|
Job Type | string | No | Job Type Filter |
Device Filter | string | No | Device Filter |
Lang | string | No | Language |
List Locationsβ
Returns flat list of all locations for all organizationsβ
GET /locations
List Scheduled Tasksβ
Returns list of registered scheduled tasksβ
GET /tasks
List Groups (Saved Searches)β
Returns list of groupsβ
GET /groups
Parameter | Type | Required | Description |
---|---|---|---|
Lang | string | No | Language |
List Activitiesβ
Returns activity log in reverse chronological orderβ
GET /activities
Parameter | Type | Required | Description |
---|---|---|---|
Class | string | No | Activity Class (System |
Activities Recorded Before Specified Date | string | No | |
Activities Recorded After Specified Date | string | No | |
Older Than | string | No | Return Activities Recorded That Are Newer Than Specified Activity ID |
Newer Than | string | No | Return Activities Recorded That Are Older Than Specified Activity ID |
Activity Type | string | No | Return Activities Of Type |
Status | string | No | Return Activities With Status(es) |
User | string | No | Return Activities For User(s) |
Series Uid | string | No | Return Activities Related To Alert (Series) |
Device Filter | string | No | Device Filter |
Lang | string | No | Language |
List Devicesβ
Returns list of devices (basic node information)β
GET /devices
Parameter | Type | Required | Description |
---|---|---|---|
Device Filter | string | No | Device Filter |
List Policiesβ
Returns list of policiesβ
GET /policies
List Usersβ
Returns list of usersβ
GET /users
Parameter | Type | Required | Description |
---|---|---|---|
User Type | string | No | User Type Filter |
Search for Devicesβ
Returns list of entities matching the search termβ
GET /devices/search
Parameter | Type | Required | Description |
---|---|---|---|
Search Query | string | No | Search Query (Name, Logged On User Name, IP Address, Etc.) |
Limit | integer | No | Limit Number Of Devices To Return |
Ticketing
List Ticket Log Entriesβ
Get a list of ticket log entriesβ
GET /ticketing/ticket/{ticketId}/log-entry
Parameter | Type | Required | Description |
---|---|---|---|
Ticket ID | integer | Yes | |
Type | string | No |
List Tickets For Boardβ
Get list of tickets by Board identifierβ
/ticketing/trigger/board/{boardId}/run
Parameter | Type | Required | Description |
---|---|---|---|
Board | string | Yes | |
Sort By | array | No | |
Filters | array | No | |
Search Criteria | string | No |
List Boardsβ
Get list of boardsβ
GET /ticketing/trigger/boards
List Contactsβ
Get list of contactsβ
GET /ticketing/contact/contacts
List Ticket Formsβ
Get list of ticket formsβ
GET /ticketing/ticket-form
Modify Ticketβ
Modify a ticket on a boardβ
PUT /ticketing/ticket/{ticketId}
Parameter | Type | Required | Description |
---|---|---|---|
Ticket ID | integer | Yes | |
Ticket | object | No | |
Comment | object | No |
Create Ticketβ
/ticketing/ticket
Parameter | Type | Required | Description |
---|---|---|---|
requestUid | string | No | |
clientId | string | No | |
Ticket Form | string | No | |
Location | string | No | |
Node ID | integer | No | |
Summary | string | No | |
Description | object | No | |
Status | string | No | |
Type | string | No | |
User | string | No | |
requesterUid | string | No | |
CC List | object | No | |
Attribute Values | array | No | |
Severity | string | No | |
Priority | string | No | |
Tags | string | No | Tags |
Parent Ticket ID | integer | No |
Last updated