NetCloud Manager: API 2.0 Overview
The NetCloud Manager API is an interface for developers to use to integrate their systems and/or scripts with the data available in NetCloud Manager. This includes online/offline status of routers and network interfaces, signal strength and quality of cellular modems, router logs, and much more.
Developers are often looking to integrate the data collected by NetCloud Manager into their internal network monitoring systems, log parsing applications, or network inventory management systems. The NCM API provides a robust interface for integrating these systems.
The NCM API is an RESTful HTTP interface that returns data in JSON format. This article will instruct you how to sign up for the NCM API, manage your keys, and access additional documentation and code examples in the API portal.
To authenticate to the ECM API you will need to include 2 pairs of keys in the headers of your HTTP request:
To create these keys and access the API portal, follow these instructions:
- Step 1: Log in to Enterprise Cloud Manager.
- Step 2: From the Applications tab, click the "Sign Up" button on the ECM API tile(first time only). This will sign you up for the ECM API and the tile will reload.
- Step 3: Click on the "Manage" button on the ECM API tile.
- Step 4: From the NCM API Manage page click "Add" to create a new pair NCM API Keys.
- Step 5: Select the account or subaccount you want the keys to have access to, then select the permission level (read only, full access, or administrator), then click OK.
- Step 6: These are the X-NCM-API-ID and X-NCM-API-KEY. Copy the NCM API keys into a safe place. **NOTE: This is the only time you will be able to see the "Secret" or X-ECM-API-KEY. It will not be viewable again after clicking OK.
- Step 7: Click "Back" to go back to the NCM Applications page.
- Step 8: Click "API Portal" on the ECM API tile to open the API Portal.
- Step 9: On this page are displayed the X-CP-API-ID and X-CP-API-KEY keys. Copy the CP API keys into a safe place.
You have now successfully created both pairs of keys. You will need to include both pairs in your HTTP headers when making an API call. For additional documentation and code examples, click on "Documentation" at the top of the API portal.
Published Date: 07/14/2017
This article not have what you need? Not find what you were looking for? Think this article can be improved? Please let us know at firstname.lastname@example.org.