How to Enable Netreo API Access

Enable API Access

In order to use any of Netreo's built-in APIs, the Netreo API system must first be enabled.

To enable API access in Netreo:

1. Log in to Netreo as a user with the SuperAdmin access level.
2. From the Netreo main menu, select Administration > System > API Access to open the API Administration page.
3. Switch the ENABLE/DISABLE API ACCESS setting to ON.
4. Optionally, to make your API calls more secure, switch the REQUIRE AUTHENTICATION setting to ON. Be aware that if you enable this feature, you will be required to also specify an API key in the API KEY field. This key will then be a required parameter in any calls to an Netreo API that do not include an alternate authorization method (see individual API docs for specifics).
5. Click Save Preference Changes.

All Netreo APIs will become active. See the API documentation for information on how to access and use the available APIs.

Find Your API Key

Follow the steps below to find your Netreo API key.

1. Log in to Netreo as a user with the SuperAdmin access level.
2. From the main menu select Administration > System > API Access to open the API Admin page.
3. Locate the API KEY field.
   • Both ENABLE/DISABLE API ACCESS and REQUIRE AUTHENTICATION must be set to ON for your API key to be available.
4. Select Reveal API Key to view your API key.
   • Refresh the page to hide your API key again.

Find Your Netreo SaaS API Pin

This is only required if you are using the SaaS-based version of Netreo. On-premise deployments of Netreo do not require this key.

Follow the steps below to find your Netreo SaaS API pin.

1. Log in to Netreo as a user with the SuperAdmin access level.
2. From the main menu select Administration > System > API Access to open the API Admin page.
3. Locate the PIN field.

The API pin value is a required parameter when using the SaaS-based Netreo APIs. It is not applicable to on-premise deployments.