ninjaone-integration-setup.md

NinjaOne Integration Setup

{% hint style="success" %} This Integration supports multiple instances

Check out the instructions to set up multiple instances here. {% endhint %}

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:

1. Go to Administration -> Library -> Automation.
2. Click + Add -> New Script on the right.
3. Add the following script:
   • Name: Rewst (Windows)
   • Language: Powershell
   • OS: Windows
   • Architecture: All

Param(
    [Parameter(Mandatory=$true)]
    [string]$script_content_path,
    [Parameter(Mandatory=$true)]
    [string]$results_postdata_path
)

$rewst_base_url = "https://engine.rewst.io/webhooks/custom/action"
$script_content_url = "$rewst_base_url/$script_content_path"
$post_url = "$rewst_base_url/$results_postdata_path"



# Download Script Content from Rewst

[Net.ServicePointManager]::SecurityProtocol = [Net.SecurityProtocolType]::Tls12
$wc = New-Object System.Net.WebClient
$wc.Encoding = [System.Text.Encoding]::UTF8
$commands = ($wc.DownloadString($script_content_url))

# Execute Script Content

iex $commands

Complete Setup in Rewst

Follow the below steps to configure a new integration in Rewst:

1. Log in to the Rewst platform.
2. Go to Configuration → Integrations menu on the left sidebar.
3. Click or search for "Ninja".
4. Select your Region.
5. Authorize OAuth into Ninja via Microsoft.
   • You should see your customer show up at the bottom.
6. 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​

/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​

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​

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/Script Parameters
Run As	string	No	Credential Role/Identifier

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/Device) Filter
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