NinjaOne is a cloud-based platform for monitoring and managing endpoints. This guide shows you how to set up your NinjaOne instance and gather the values you need to configure the integration. NinjaOne authenticates with a Client ID and a Client Secret.
Before you begin, ensure that you have:
- Access to the web interface of NinjaOne
- Access to a NinjaOne account with the system administrator role. Only system administrators can create API client apps
| Scope | Purpose |
|---|---|
| Monitoring | Retrieve devices, the software installed on them, and their device health data |
| Management | Restart devices, scan for operating system and third-party software patches, and apply patches |
- Log in to NinjaOne with an account that has the system administrator role
- Select Administration > Apps > API
- Select the Client app IDs tab
- Select + Add client app
- Fill in the field titled Name
- In the dropdown titled Application Platform, select API Services (machine-to-machine)
- In the section titled Scopes, select all of the required scopes. The required scopes can be found in the section above titled Required Permissions
- Leave the field titled Redirect URLs empty
- In the section titled Allowed Grant Types, select Client credentials
- Select Save, then take note of the Client ID and Client Secret values and store them in a safe location
- You have now created a new NinjaOne API client app. Proceed to the next section titled Find Your NinjaOne Region
For more information on NinjaOne API client apps, see the NinjaOne API OAuth Token Configuration docs page
- Log in to NinjaOne
- Look at your browser's address bar. The address uses this format:
https://{region}.ninjarmm.com - Take note of the region:
app,us2,eu,ca, oroc
Other regions
NinjaOne also hosts instances on addresses outside this list, such as jp.ninjarmm.com. If yours is one of them, set the Base URL field when you configure the integration. The integration ignores Region when you set Base URL.
To configure a new NinjaOne integration, provide each of the values as defined below:
| Integration Parameter | Description |
|---|---|
| Client ID | The Client ID of the API client app you created |
| Client Secret | The Client Secret of the same app |
| Region | Your region code, such as us2. See Find Your NinjaOne Region |
| Integration Parameter | Description |
|---|---|
| Base URL | Only set this if your NinjaOne address is not one of the regions listed above. Enter the address from your browser's address bar, up to and including .ninjarmm.com Example https://jp.ninjarmm.com |