TL;DR
- REST API access requires N-central version 2023.9 or later and is accessed through the /api-explorer endpoint using the Swagger interface
- Authentication is a two-step process: first authorize with a JSON web token, then execute the authenticate API call to obtain an access token
- API calls are color-coded in Swagger — blue GET calls extract information while green POST calls set or modify data on the N-central server
Summary
This technical demonstration walks through the process of accessing and authenticating against the REST APIs in N-able N-central version 2023.9 or later. The tutorial covers navigating the Swagger API Explorer interface, understanding the difference between GET and POST API calls, and completing the two-step authentication process using JSON web tokens and access tokens. The demonstration concludes with a practical example of retrieving customer data from the N-central server using the organizational units API endpoint, including how to sort results by specific fields. This foundational knowledge enables MSPs and IT administrators to programmatically interact with their N-central instance for automation and integration purposes.
Chapters
0:00 - Introduction
0:07 - Accessing API Explorer
0:48 - Authentication Process
1:43 - Retrieving Customer Data
Key Quotes
0:07 "To access the REST APIs, you need to be running NCentral 2023.9 or later."
0:38 "Get calls are blue, which allow you to extract information from your NCentral server, and post calls are green, which allow you to set information in your NCentral server as well."
2:09 "Now it is case sensitive. So you need to make sure you enter the exact field that is retrieved by the API call."
