NinjaRMM

NinjaRMM provides intuitive endpoint management software to managed service providers (MSPs) and IT professionals.

Create New Organization

Creates new organization with optional list of locations and policy mappings. Template organization ID can be specified to copy various settings

Inputs to this Action:

  • Connections: Choose a connection that you have created.
  • Template Organization ID: Jinja-templated text containing the value of the templated organization ID. Example: {{org_id}}
  • Name: Jinja-templated text containing the value of the Organization full name. Example: {{name}}
  • Description: Jinja-templated text containing the value of the Organization Description. Example: {{description}}
  • Device Approval Mode: Jinja-templated text containing the value of the approval mode (Options are AUTOMATIC, MANUAL, REJECT). Example: {{approval_mode}}
  • User Data: Jinja-templated text containing the JSON of the user data. Example: {{user_data}}
  • Tags: Jinja-templated text containing JSON array of tags. Example: ["tag1", {{tags}}]
  • Fields: Jinja-templated text containing the JSON of the fields. Example: {{fields}}
  • Locations: Jinja-templated text containing the JSON array of the locations. Example: {{locations}}
  • Policies: Jinja-templated text containing the JSON array of the policies. Example: {{policies}}
  • Time between consecutive API requests (in millis): Time to wait between consecutive API requests in milliseconds (Default is 300 millisecond)

Output of Action:
JSON containing the following items:

  • has_error: True/False
  • error: message/null
  • result: Create New Organization Data

Update Organization

Change organization name, description and policy mappings

Inputs to this Action:

  • Connections: Choose a connection that you have created.
  • Organization ID: Jinja-templated text containing the value of the organization ID. Example: {{org_id}}
  • Name: Jinja-templated text containing the value of the Organization full name. Example: {{name}}
  • Description: Jinja-templated text containing the value of the Organization Description. Example: {{description}}
  • Device Approval Mode: Jinja-templated text containing the value of the approval mode (Options are AUTOMATIC, MANUAL, REJECT). Example: {{approval_mode}}
  • User Data: Jinja-templated text containing the JSON of the user data. Example: {{user_data}}
  • Tags: Jinja-templated text containing JSON array of tags. Example: ["tag1", {{tags}}]
  • Fields: Jinja-templated text containing the JSON of the fields. Example: {{fields}}
  • Time between consecutive API requests (in millis): Time to wait between consecutive API requests in milliseconds (Default is 300 millisecond)

Output of Action:
JSON containing the following items:

  • has_error: True/False
  • error: message/null
  • result: Update Organization Data

Create Location

Creates new location for organization

Inputs to this Action:

  • Connections: Choose a connection that you have created.
  • Organization ID: Jinja-templated text containing the value of the Organization ID. Example: {{org_id}}
  • Location name: Jinja-templated text containing the value of the location name. Example: {{name}}
  • Location address: Jinja-templated text containing the value of the location address. Example: {{address}}
  • Description: Jinja-templated text containing the value of the description. Example: {{description}}
  • User Data: Jinja-templated text containing the JSON of the user data. Example: {{user_data}}
  • Tags: Jinja-templated text containing JSON array of tags. Example: {{tags}}
  • Fields: Jinja-templated text containing the JSON of the fields. Example: {{fields}}
  • Time between consecutive API requests (in millis): Time to wait between consecutive API requests in milliseconds (Default is 300 millisecond)

Output of Action:
JSON containing the following items:

  • has_error: True/False
  • error: message/null
  • result: Create Location Data

Update Location

Change location name, address, description, custom data

Inputs to this Action:

  • Connections: Choose a connection that you have created.
  • Organization ID: Jinja-templated text containing the value of the Organization ID. Example: {{org_id}}
  • Location ID: Jinja-templated text containing the value of the Location ID. Example: {{location_id}}
  • Location name: Jinja-templated text containing the value of the location name. Example: {{name}}
  • Location address: Jinja-templated text containing the value of the location address. Example: {{address}}
  • Description: Jinja-templated text containing the value of the description. Example: {{description}}
  • User Data: Jinja-templated text containing the JSON of the user data. Example: {{user_data}}
  • Tags: Jinja-templated text containing JSON array of tags. Example: {{tags}}
  • Fields: Jinja-templated text containing the JSON of the fields. Example: {{fields}}
  • Time between consecutive API requests (in millis): Time to wait between consecutive API requests in milliseconds (Default is 300 millisecond)

Output of Action:
JSON containing the following items:

  • has_error: True/False
  • error: message/null
  • result: Update Location Data

List Devices

Returns list of devices (basic node information)

Inputs to this Action:

  • Connections: Choose a connection that you have created.
  • Filter: Jinja-templated text containing the value of device filter. Example: {{filter}}
  • Limit: Jinja-templated text containing the value of device filter (Default is 100000). Example: {{filter}}
  • Time between consecutive API requests (in millis): Time to wait between consecutive API requests in milliseconds (Default is 300 millisecond)

Output of Action:
JSON containing the following items:

  • has_error: True/False
  • error: message/null
  • result: List Devices Data

Device Link

Returns link to device

Inputs to this Action:

  • Connections: Choose a connection that you have created.
  • Device ID: Jinja-templated text containing the value of the Device ID. Example: {{device_id}}
  • Return redirect response: Jinja-templated text containing the value of redirect (Options are true, false). Example: {{redirect}}
  • Time between consecutive API requests (in millis): Time to wait between consecutive API requests in milliseconds (Default is 300 millisecond)

Output of Action:
JSON containing the following items:

  • has_error: True/False
  • error: message/null
  • result: Device Link Data

Update Device Information

Change device friendly name, user data, etc.

Inputs to this Action:

  • Connections: Choose a connection that you have created.
  • Device ID: Jinja-templated text containing the value of the device_id. Example: {{device_id}}
  • Display Name: Jinja-templated text containing the value of display name. Example: {{display_name}}
  • User Data: Jinja-templated text containing the JSON of the user data. Example: {{user_data}}
  • Node Role ID: Jinja-templated text containing the value of Node Role identifier. Example: {{node_role_id}}
  • Policy ID: Jinja-templated text containing the value of policy ID. Example: {{policy_id}}
  • Time between consecutive API requests (in millis): Time to wait between consecutive API requests in milliseconds (Default is 300 millisecond)

Output of Action:
JSON containing the following items:

  • has_error: True/False
  • error: message/null
  • result: Update Device Information Data

Approve/Reject Devices

Approve or reject devices that are waiting for approval

Inputs to this Action:

  • Connections: Choose a connection that you have created.
  • Mode: Jinja-templated text containing the value of the mode (options are APPROVE, REJECT). Example: {{mode}}
  • Devices: Jinja-templated text containing the JSON array of the device IDs. Example: [1, {{device_ids}}]
  • Time between consecutive API requests (in millis): Time to wait between consecutive API requests in milliseconds (Default is 300 millisecond)

Output of Action:
JSON containing the following items:

  • has_error: True/False
  • error: message/null
  • result: Approve/Reject Devices Data

Reboot Device

Sends a command to restart the computer

Inputs to this Action:

  • Connections: Choose a connection that you have created.
  • Device ID: Jinja-templated text containing the value of device ID. Example: {{device_id}}
  • Reboot mode: Jinja-templated text containing the value of type (Options are NORMAL, FORCED). Example: {{device_id}}
  • Reboot reason: Jinja-templated text containing the value of reboot reason. Example: {{reason}}
  • Time between consecutive API requests (in millis): Time to wait between consecutive API requests in milliseconds (Default is 300 millisecond)

Output of Action:
JSON containing the following items:

  • has_error: True/False
  • error: message/null
  • result: Reboot Device Data

Windows Services and Status

Lists Windows Services and their statuses

Inputs to this Action:

  • Connections: Choose a connection that you have created.
  • Device ID: Jinja-templated text containing the value of device ID. Example: {{device_id}}
  • Service Name: Jinja-templated text containing the value of Service identifier. Example: {{service_name}}
  • Service State: Jinja-templated text containing the value of Service State (Options are UNKNOWN, STOPPED, START_PENDING, RUNNING, STOP_PENDING, PAUSE_PENDING, PAUSED, CONTINUE_PENDING). Example: {{service_state}}
  • Time between consecutive API requests (in millis): Time to wait between consecutive API requests in milliseconds (Default is 300 millisecond)

Output of Action:
JSON containing the following items:

  • has_error: True/False
  • error: message/null
  • result: Windows Services and Status Data

Modify Windows Service Configuration

Configures Windows Service startup settings

Inputs to this Action:

  • Connections: Choose a connection that you have created.
  • Device ID: Jinja-templated text containing the value of the device ID. Example: {{device_id}}
  • Service Identifier: Jinja-templated text containing the value of service Identifier. Example: {{service_id}}
  • Start Type: Jinja-templated text containing the value of start type (Options are AUTO_START, AUTO_START_DELAYED, BOOT_START, DEMAND_START, DISABLED, SYSTEM_START). Example: {{start_type}}
  • User Name: Jinja-templated text containing the value of user name. Example: {{user_name}}
  • Time between consecutive API requests (in millis): Time to wait between consecutive API requests in milliseconds (Default is 300 millisecond)

Output of Action:
JSON containing the following items:

  • has_error: True/False
  • error: message/null
  • result: Modify Windows Service Configuration Data

Windows Service Control

Start/Stop/Restart Windows Service on a device

Inputs to this Action:

  • Connections: Choose a connection that you have created.
  • Device ID: Jinja-templated text containing the value of device ID. Example: {{device_id}}
  • Service ID: Jinja-templated text containing the value of Service identifier. Example: {{service_id}}
  • Action: Jinja-templated text containing the value of action (Options are START, PAUSE, STOP, RESTART). Example: {{action}}
  • Time between consecutive API requests (in millis): Time to wait between consecutive API requests in milliseconds (Default is 300 millisecond)

Output of Action:
JSON containing the following items:

  • has_error: True/False
  • error: message/null
  • result: Windows Service Control Data

List Scripting Options

Returns scripting options (built-in actions, custom scripts) available for device

Inputs to this Action:

  • Connections: Choose a connection that you have created.
  • Device ID: Jinja-templated text containing the value of device ID. Example: {{device_id}}
  • Language: Jinja-templated text containing the value of language. Example: {{lang}}
  • Time between consecutive API requests (in millis): Time to wait between consecutive API requests in milliseconds (Default is 300 millisecond)

Output of Action:
JSON containing the following items:

  • has_error: True/False
  • error: message/null
  • result: List Scripting Options Data

Run Script

Run script or built-in action on a device

Inputs to this Action:

  • Connections: Choose a connection that you have created.
  • Device ID: Jinja-templated text containing the value of device ID. Example: {{device_id}}
  • Script ID: Jinja-templated text containing the value of Script identifier. Example: {{script_id}}
  • Type: Jinja-templated text containing the value of type (Options are ACTION, SCRIPT). Example: {{type}}
  • UID: Jinja-templated text containing the value of Built-in action identifier. Example: {{uid}}
  • Parameters: Jinja-templated text containing the value of Action/Script parameters. Example: {{params}}
  • Run As: Jinja-templated text containing the value of Credential role/identifier. Example: {{run_as}}
  • Time between consecutive API requests (in millis): Time to wait between consecutive API requests in milliseconds (Default is 300 millisecond)

Output of Action:
JSON containing the following items:

  • has_error: True/False
  • error: message/null
  • result: Run Script Data

Schedule Maintenance

Schedule maintenance window for device

Inputs to this Action:

  • Connections: Choose a connection that you have created.
  • Device ID: Jinja-templated text containing the value of the (options are APPROVE, REJECT). Example: {{mode}}
  • List of features that will be disabled during maintenance: Jinja-templated text containing the JSON array of the features (Options are ALERTS, PATCHING, AVSCANS, TASKS). Example: ["{{feature1}}", "ALERTS"]
  • Maintenance window start: Jinja-templated text containing the value of maintenance start time, the ISO 8601 date and time (Default is Batch end time). Example: to specify July 16, 2017, use the form YYYY-MM-DDTHH:mm:ss, or 2017-07-16T00:00:00. Can also be timezone specific YYYY-MM-DDTHH:mm:ss-HH:mm, or 2017-07-16T00:00:00-4:00.
  • Maintenance window end: Jinja-templated text containing the value of maintenance end time, the ISO 8601 date and time (Default is Batch end time). Example: to specify July 16, 2017, use the form YYYY-MM-DDTHH:mm:ss, or 2017-07-16T00:00:00. Can also be timezone specific YYYY-MM-DDTHH:mm:ss-HH:mm, or 2017-07-16T00:00:00-4:00.
  • Time between consecutive API requests (in millis): Time to wait between consecutive API requests in milliseconds (Default is 300 millisecond)

Output of Action:
JSON containing the following items:

  • has_error: True/False
  • error: message/null
  • result: Schedule Maintenance Data

Cancel Maintenance

Cancel pending or active maintenance for device

Inputs to this Action:

  • Connections: Choose a connection that you have created.
  • Device ID: Jinja-templated text containing the value of the (options are APPROVE, REJECT). Example: {{mode}}
  • Time between consecutive API requests (in millis): Time to wait between consecutive API requests in milliseconds (Default is 300 millisecond)

Output of Action:
JSON containing the following items:

  • has_error: True/False
  • error: message/null
  • result: Cancel Maintenance Data

List active alerts (triggered conditions)

Returns list of active alerts/triggered conditions

Inputs to this Action:

  • Connections: Choose a connection that you have created.
  • Source Type: Jinja-templated text containing the value of the source type. Example: {{source_type}}
  • Device Filter: Jinja-templated text containing the value of the device filter. Example: {{device_filter}}
  • Language: Jinja-templated text containing the value of the language. Example: {{language}}
  • Timezone: Jinja-templated text containing the value of the timezone. Example: {{timezone}}
  • Time between consecutive API requests (in millis): Time to wait between consecutive API requests in milliseconds (Default is 300 millisecond)

Output of Action:
JSON containing the following items:

  • has_error: True/False
  • error: message/null
  • result: List active alerts (triggered conditions) Data

Resets Alert/Condition By Uid

Reset alert/condition and provide custom data for activity

Inputs to this Action:

  • Connections: Choose a connection that you have created.
  • UID: Jinja-templated text containing the value of the UID. Example: {{uid}}
  • Body: Jinja-templated text containing the value of the body. Example: {{body}}
  • Time between consecutive API requests (in millis): Time to wait between consecutive API requests in milliseconds (Default is 300 millisecond)

Output of Action:
JSON containing the following items:

  • has_error: True/False
  • error: message/null
  • result: Resets Alert/Condition By Uid Data

Delete Alert/Condition

Delete alert/condition

Inputs to this Action:

  • Connections: Choose a connection that you have created.
  • UID: Jinja-templated text containing the value of the UID. Example: {{uid}}
  • Time between consecutive API requests (in millis): Time to wait between consecutive API requests in milliseconds (Default is 300 millisecond)

Output of Action:
JSON containing the following items:

  • has_error: True/False
  • error: message/null
  • result: Delete Alert/Condition Data

Update Api Webhook Configuration

Creates or updates Webhook configuration for current application/client

Inputs to this Action:

  • Connections: Choose a connection that you have created.
  • Url: Jinja-templated text containing the value of the Callback (WebHook) URL for activity notifications. Example: {{url}}
  • Activities: Jinja-templated text containing JSON of the Activity filter. Example: {{activities}}
  • Expand: Jinja-templated text containing the JSON array of the which references to expand in payloads. Example: {{expand}}
  • Headers: Jinja-templated text containing the JSON array of the Custom HTTP Headers (i.e. Authorization). Example: {{headers}}
  • Time between consecutive API requests (in millis): Time to wait between consecutive API requests in milliseconds (Default is 300 millisecond)

Output of Action:
JSON containing the following items:

  • has_error: True/False
  • error: message/null
  • result: Update Api Webhook Configuration Data

Remove Webhook Api Channel

Creates or updates PSA configuration based on client

Inputs to this Action:

  • Connections: Choose a connection that you have created.

Output of Action:
JSON containing the following items:

  • has_error: True/False
  • error: message/null
  • result: Remove Webhook Api Channel Data

Generates Installer

Generates and returns URL for installer for specified organization/location

Inputs to this Action:

  • Connections: Choose a connection that you have created.
  • Organization ID: Jinja-templated text containing the value of the Organization ID. Example: {{org_id}}
  • Location ID: Jinja-templated text containing the value of the location ID. Example: {{location_id}}
  • Installer Type: Jinja-templated text containing the value of the installer type (options are WINDOWS_MSI, MAC_DMG, MAC_PKG, LINUX_DEB, LINUX_RPM). Example: {{installer_type}}
  • Time between consecutive API requests (in millis): Time to wait between consecutive API requests in milliseconds (Default is 300 millisecond)

Output of Action:
JSON containing the following items:

  • has_error: True/False
  • error: message/null
  • result: Generates Installer Data

Did this page help you?