NinjaOne RMM Migration Guide

Availability

Core Standard Plus Pro Enterprise Flex PyAirbyte

Connector type (beta)

Data replication Agent(learn more)

Support Level

Marketplace

Connector Version

0.0.51 (last updated 4 days ago)

Data workers used

0.2 per sync (Learn more)

Definition ID

49897212-53be-4898-ba2e-b73e72d645ef

Upgrading to 0.1.0

Version 0.1.0 replaces the static API Key with NinjaOne OAuth 2.0 Client Credentials.

What changed

• The api_key configuration field is removed. The connector now takes a client_id and client_secret and exchanges them for an access token at https://<region>.ninjarmm.com/ws/oauth/token before each sync (and again whenever the token expires).
• A new optional region field selects the NinjaOne instance (app, us2, eu, ca or oc). Previously only app.ninjarmm.com was supported.
• Pagination of the organizations, locations and activities streams now follows the NinjaOne API: after is sent as the last organization/location ID of the previous page, and activities pages backwards with olderThan=<last activity ID>. Earlier versions sent a record offset in these parameters, which the API interprets as an ID or a date.

Why

The NinjaOne Public API only supports OAuth 2.0 and its access tokens are valid for one hour ("expires_in": 3600 in the Client Credentials flow). The token that earlier versions asked you to paste as the API Key therefore stopped working an hour after it was generated, so scheduled syncs could not succeed.

Who is affected

All users of this connector. Existing sources will fail their connection test until they are reconfigured.

Migration steps

1. In NinjaOne, open Administration > Apps > API and click Add.
2. Select API Services (machine-to-machine) as the Application Platform, select at least the Monitoring scope, and enable the Client Credentials grant type.
3. Save the application and copy its Client ID and Client Secret.
4. In Airbyte, open your NinjaOne RMM source, upgrade it to 0.1.0, and enter the Client ID, Client Secret and (if your account is not on app.ninjarmm.com) the Region. Keep your existing Start date.
5. Click Set up source / Test and save. No stream reset is required: schemas, primary keys and cursor fields are unchanged.

Connector upgrade guide

Review the following information to prepare for and execute your upgrade.

Review the changelog

Before updating a connector, review the changelog to understand the changes and their potential impact on your existing connections. Find the changelog for any connector by navigating to the bottom of the documentation for that connector. Major version releases also include a migration guide.

Plan for major updates

Major updates may require you to adjust connection settings or even make changes to your data pipelines. Allocate enough time and resources for this. Use the migration guide to ensure your transition process goes smoothly.

Airbyte provides tooling that guarantees safe connector version bumps and enforces automated version bumps for minor and patch updates. You always need to manually update for major version bumps.

Self-managed plans: pin a specific version if you can't update

If you're unable to upgrade to the new version of a connector, you can pin that connector to a specific version.

1. In the navigation bar:

   • If you're on the Self-Managed Enterprise plan, click Organization settings > Sources/Destinations.

   • If you're on any other plan, click Workspace settings > Sources/Destinations.

2. Edit the entry for the connector you want to pin.

3. Set the Default Version to the version you want to use.

Self-managed plans: update the local connector image

If you self-manage Airbyte, you must manually update the connector image in your local registry before proceeding with the migration. Follow the steps below.

1. In the navigation bar:

   • If you're on the Self-Managed Enterprise plan, click Organization settings > Sources/Destinations.

   • If you're on any other plan, click Workspace settings > Sources/Destinations.

2. Find the connector you want to update in the list of connectors.

   note

   Airbyte lists two versions, the current in-use version and the latest version available.

3. Click Change to update your OSS version to the latest available version.

Update the connector version

Update each instance of the connector separately. If you have multiple instances of a connector, updating one doesn't affect the others.

1. In the navigation bar:

   • If you're on the Self-Managed Enterprise plan, click Organization settings > Sources/Destinations.

   • If you're on any other plan, click Workspace settings > Sources/Destinations.

2. Select the instance of the connector you wish to upgrade.

3. Select Upgrade.

4. Follow the prompt to confirm you are ready to upgrade to the new version.

Clear data from affected streams

After upgrading a connector with a breaking change, you must refresh affected schemas and clear your data.

1. In the nav bar, click Connections.

2. Find the connection affected by the upgrade.

3. Click the Schema tab.

4. Click Refresh source schema (looks like ). When Airbyte finishes, it shows you any detected schema changes.

5. Click OK.

6. Click Save changes

7. Clear the data for the streams affected by this upgrade.

Once the clear is complete, you can begin syncing your data again as usual.