Skip to Content
This is the latest documentation for BMC Helix Network Management (formerly known as Netreo).

 

How to Enable Netreo API Access

Enable API Access

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

To enable API access in BMC Helix Network Management:

  1. Log in to BMC Helix Network Management as a user with the SuperAdmin access level.
  2. From the BMC Helix Network Management 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 BMC Helix Network Management API that do not include an alternate authorization method (see individual API docs for specifics).
  5. Click Save Preference Changes.

All BMC Helix Network Management APIs will become active. See the API documentation for information on how to access and use the available APIs.

Security Alert

It is highly recommended to require authentication when making API calls to BMC Helix Network Management APIs. Without the authentication requirement, any correctly formatted calls to a BMC Helix Network Management API will be honored.

Find Your API Key

Follow the steps below to find your BMC Helix Network Management API key.

  1. Log in to BMC Helix Network Management 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 BMC Helix Network Management SaaS API Pin

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

Follow the steps below to find your BMC Helix Network Management SaaS API pin.

  1. Log in to BMC Helix Network Management 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 BMC Helix Network Management APIs. It is not applicable to on-premise deployments.

 

 

Tip: For faster searching, add an asterisk to the end of your partial query. Example: cert*

BMC Helix Network Management