Install the NinjaOne Onboarding Application

WatchGuard provides the NinjaOne Onboarding application to connect to the WatchGuard API and download script parameters to use in NinjaOne. The installation process consists of these steps:

Before You Begin

Before you download and install the NinjaOne Onboarding application, make sure that:

  • You have a valid WatchGuard Endpoint Security license.
  • You have a valid NinjaOne account.
  • You have at least one device with WatchGuard Endpoint Security installed for each operating system (Windows, macOS, and Linux) managed in your NinjaOne account.
  • Your computer runs Microsoft Windows 8 or higher.

Enable API Access in WatchGuard Cloud

WatchGuard public APIs use the Open Authorization (OAuth) 2.0 authorization framework for token-based authentication. To use the Endpoint Security Management API, you must first enable API access in your WatchGuard Cloud account to retrieve the required parameters for your configuration. For more information, go to Enable API Access in WatchGuard Cloud.

To enable API access in WatchGuard Cloud:

  1. Log in to WatchGuard Cloud.
    If you are a Service Provider, from Account Manager, select My Account or a managed account.
  2. Select Administration > Managed Access.
  3. Click Enable API Access.

Screenshot of the Enable API Access page in WatchGuard Cloud

  1. Specify the readwrite and readonly passwords to use as your API access credentials.

Screenshot of the Enable API Access password page in WatchGuard Cloud

Passwords must include an uppercase letter, a lowercase letter, a number, and a special character. The readwrite password and the readonly password must be different.  

You must use the readwrite access ID and password for the API configuration.

  1. Select the I agree to the terms and conditions in the WatchGuard APIs License Agreement check box.
  2. Click Save.

After you enable API access, information appears that you must specify in the NinjaOne Onboarding application. You can view these parameters on the Administration > Managed Access page in WatchGuard Cloud.

The base URL varies by region. This example shows a US-based server.

Screenshot of the Administration > Managed Access page with API information in WatchGuard Cloud

Download the NinjaOne Onboarding Application and Endpoint Security Installation Scripts

To download the NinjaOne Onboarding application and scripts, from the WatchGuard Software Downloads page:

  1. Go to the Software Downloads page.
  2. Click Endpoint Software.
  3. Click the NinjaOne Integration link.
  4. Click NinjaOne Integration (Latest) to download the NinjaOne.ZIP file.
  5. Save the NinjaOne.ZIP file to your computer.
  6. Extract the contents of the NinjaOne.ZIP file.

The NinjaOne folder contains these files:

  • NinjaOne-Onboarding.EXE
  • WG-Install-Windows.ps1
  • WG-Install-Linux.sh
  • WG-Install-Mac.sh

To open the NinjaOne Onboarding application, from the NinjaOne folder, double-click NinjaOne-Onboarding.EXE.
The NinjaOne Onboarding application opens.

The onboarding application automatically updates to the latest version available when it opens.

Screenshot of the NinjaOne Onboarding application

The NinjaOne Onboarding application has these options in the navigation pane:

  • API Connection — Use this page to configure the API connection to WatchGuard Cloud.
  • Client Settings — Use this page to select network settings, copy script parameters, or download a CSV file with the settings and script parameters for all clients. You must successfully establish an API connection to WatchGuard Cloud before you can use this page.
  • WatchGuard Cloud — Click this link to open WatchGuard Cloud in a web browser.

Configure the API Connection to WatchGuard Cloud

The information necessary to establish an API connection to WatchGuard Cloud is visible in the Managed Access page in WatchGuard Cloud after you enable API access. For more information about API access in WatchGuard Cloud, go to Enable API Access.

When you enter the API connection information in the NinjaOne Onboarding application, we recommend you copy and paste the API parameters directly from the Managed Access page in WatchGuard Cloud to avoid errors.

To establish the connection to WatchGuard Cloud, from the NinjaOne Onboarding application:

  1. Select API Connection.

Screenshot of the API Connection page in the NinjaOne Onboarding application

  1. Enter the API information for WatchGuard Cloud: 
    • Authentication API URL — Type the Authentication API URL used to request an authentication token. The URL varies by region.
      • APAC Regionhttps://api.jpn.cloud.watchguard.com/oauth/token
      • EMEA Region https://api.deu.cloud.watchguard.com/oauth/token
      • NA/Americas Regionhttps://api.usa.cloud.watchguard.com/oauth/token
    • API URL — Type the base URL of the Endpoint Security API. The URL varies by region.
      • APAC Regionhttps://api.jpn.cloud.watchguard.com/rest/endpoint-security/management
      • EMEA Regionhttps://api.deu.cloud.watchguard.com/rest/endpoint-security/management
      • NA/Americas Regionhttps://api.usa.cloud.watchguard.com/rest/endpoint-security/management
    • Account ID — Type the WatchGuard Cloud Account ID of the managed account for which you want to make API requests. This must be the Account ID of a Service Provider or Subscriber account that you manage in WatchGuard Cloud. To view your account ID, select Administration > My Account in WatchGuard Cloud.
    • Access ID — Type the access ID for readwrite API access to WatchGuard Cloud.
    • Access Password — Type the password for the readwrite access ID you specified for API access to WatchGuard Cloud.
    • API Key — Type the API key associated with your WatchGuard Cloud account.

Make sure you specify the readwrite access ID and password for API access.

  1. Click Test Connection.


If the test connection is successful, a confirmation message appears.

Screenshot of the Test Connection Successful message dialog box in the NinjaOne Onboarding application

  1. Click OK.
  2. Click Connect.
    If the connection is successful, a confirmation message appears.

Screenshot of the Successfully Connected dialog box in the NinjaOne Onboarding application

  1. To go to Client Settings, click Yes.

Related Topics

About the WatchGuard Endpoint Security Integration with NinjaOne

Use Endpoint Security Installation Scripts in NinjaOne

Manage the NinjaOne Onboarding Application