Getting Started with the N-sight API

Tip: Use the Search function to discover all the powerful capabilities of the Developer Portal.

In addition to viewing data collected by N-able in the N-able N-sight user interface, you can also extract and use the data with our Data Extraction API. For example, you can:

  • Directly import API data into a spreadsheet for analysis and manipulation
  • Extract the data to a database to run your own reports
  • Populate your customer's asset database
  • Integrate the monitoring system with a third-party vendor

To use the Data Extraction API, you enter URL queries in the following format:

https://{server}/api/?apikey={yourAPIkey}&service={service_name}&parameter={parameter-value}

When you enter a URL query, you customize the URL with your information and the :

ItemDescription
serverThe server URL for your N-sight account territory. See Determine server for API query.
yourAPIkeyGenerate an API Key
service_nameEach API Call has a unique service name. For example, the service name for Listing Clients is list_clients.
parameters and their valuesEach API Call can have required and optional parameters. For example, Listing Clients has the following parameters: describe and devicetype
📘

Our Data Extraction API is not OData (Open Data Protocol) compatible.


What’s Next