List of N-central REST APIs

API Service API

The API Service API allows you to get links to all of the available API endpoints, return version information about the running API service, and get the start/current time of the server to ensure that the server is in a healthy state.

• Get endpoint list

• Get Server Info

• Get server health

Authentication API

The Authentication API allows you to ensure proper Authentication with the API interface. You can obtain new access tokens and validate their existing API access token.

• Multi token auth​

• Auth Refresh​

• Get Auth links​

• Get token validation

Customers API

The Customers API allows you to get a list of all customers with some relevant data about each customer, or target a specific taskID to do the same. For example, the GET method returns customer information such as customerID, name, parentID, location data, etc.

• Get Customer list

Here is and example of a response for a specific customer:

Devices API

The Devices API allows you to get a list of devices along with useful information, or target a specific deviceID to do the same. For example, the GET method returns device information such as URI, device class, associated customer name and site name, etc.

• Get Device list

• Get Device by ID

Here is and example of a response for a specific device:

Device Tasks API

The Device Tasks API allows you to get a list of tasks associated with a specified task ID. For example, the GET method returns customer information such as taskID’s, task names, and task status for a device.

• Get Tasks by Device

Scheduled Tasks API

The Scheduled Tasks API allows you to:

• Create task

• List task links

• Get Task info (ID)

• Get task status

• Get status details