Web service APIs

You can integrate N-able N-central with third-party products at the API level using a web service API to:

connect to N-able N-central,
retrieve device asset information, and
perform actions.

Interacting with the N-able N-central web service API is accomplished using SOAP. The N-able N-central WSDL is located at https://<server address>/dms/.

The <server address> must be the FQDN or IP address of your N-able N-central server.

Available web service APIs

In N-able N-central, APIs have been introduced with documentation provided directly on the N-able N-central server itself. To access this information, in the web browser, enter the address https://<server address>/dms/ and click the External API's Javadocs link. On the API page, click the class name in the for details on how to use the API.

To see specific method calls you can use the documentation on their parameters. Click ServerEI2_PortType, browse to the Method Detail section, and search for the desired Method.

The table below list the available APIs.

Class Description

AccessGroupAdd Adds a new AccessGroup to N-able N-central similar to how one is added through the Add AccessGroup feature.

AccessGroupGet Retrieves all of the data about a access group.

AccessGroupList Retrieves a list of the Access Groups associated with a Customer or Site that is displayed in the Access Group view of the N-able N-central interface.

AcknowledgeNotification Allows notifications to be acknowledged.

ActiveIssuesList Works with the information that is displayed on the Active Issues tab.

CustomerAdd Adds a new Customer/Site to N-able N-central similar to how one is added using the Add Customers/Sites feature.

CustomerDelete Deletes existing customer in N-able N-central.

CustomerDeviceReport Retrieves Customer device reports within a specified time range in accordance with the ConnectWise PSA integration.

CustomerDeviceReportGet Retrieves all Customer device reports in accordance with the ConnectWise PSA integration.

CustomerList Creates a list of Customers/Sites and their related information similar to what is displayed in the Customers/Sites page in N-able N-central.

DeviceAssetInfoExport Obtains the data that appears in the Assets tab of a device in N-able N-central.

DeviceAssetInfoExport2 Obtains the data that appears in the Assets tab of a device in N-able N-central in a Key-Value pair format.

DeviceGet Retrieves all of the data about a device or set of devices that are selected from the All Devices view.

DeviceGetStatus Retrieves the status information of a device that is displayed in the Status tab of the device in N-able N-central.

DeviceList Retrieves a list of the devices associated with a Customer or Site that is displayed in the All Devices view of N-able N-central.

DevicePropertyList Used to list custom device properties for a list of devices.

DevicePropertyModify Used to modify custom device properties for a list of devices.

JobStatusList Retrieves the data that appears in the Job Status screen of N-able N-central.

LastExportReset Used to reset the "high water mark" on the DeviceAssetInfoExport API and is generally called before calling the DeviceAssetInfoExport API if the third-party application is configured to include the last result set with the next call.

LicenseKeyPush Copyright N-able.

MSPAHeartbeat Copyright N-able.

MSPAHeartbeatCache In memory object holding mspa heartbeat entries.

MSPAHeartbeatEvent

organizationPropertyList

organizationProperyModify

PsaCreateCustomTicket Represents the Web Service implementation that creates Custom PSA tickets.

PSACredentialsValidate Verifies whether a set of PSA credentials are valid.

PsaGetCustomTicket Represents the Web Service implementation that gets Custom PSA ticket details.

PsaReopenCustomTicket Represents the Web Service implementation that reopens Custom PSA tickets.

PsaResolveCustomTicket Represents the Web Service implementation that resolves Custom PSA tickets.

RemoteControlMSPAStartEndTimeSubmit

SOAdd Adds a new Service Organization to N-able N-central similar to how one is added through Add Service Organization.

TaskPauseMonitor Called to pause the specific task.

TaskResumeMonitor Called to resume the paused task.

UserAdd Adds a new user to N-able N-central similar to using Add User.

UserRoleAdd Adds a new role to N-able N-central similar to using Add User Role.

UserRoleGet Retrieves all of the data about a user role.

UserRoleList Retrieves a list of the user roles associated with a Customer or Site that is displayed in the User Role view of N-able N-central.

VersionInfoGet Retrieves the system version information.

Class	Description
AccessGroupAdd	Adds a new AccessGroup to N-able N-central similar to how one is added through the Add AccessGroup feature.
AccessGroupGet	Retrieves all of the data about a access group.
AccessGroupList	Retrieves a list of the Access Groups associated with a Customer or Site that is displayed in the Access Group view of the N-able N-central interface.
AcknowledgeNotification	Allows notifications to be acknowledged.
ActiveIssuesList	Works with the information that is displayed on the Active Issues tab.
CustomerAdd	Adds a new Customer/Site to N-able N-central similar to how one is added using the Add Customers/Sites feature.
CustomerDelete	Deletes existing customer in N-able N-central.
CustomerDeviceReport	Retrieves Customer device reports within a specified time range in accordance with the ConnectWise PSA integration.
CustomerDeviceReportGet	Retrieves all Customer device reports in accordance with the ConnectWise PSA integration.
CustomerList	Creates a list of Customers/Sites and their related information similar to what is displayed in the Customers/Sites page in N-able N-central.
DeviceAssetInfoExport	Obtains the data that appears in the Assets tab of a device in N-able N-central.
DeviceAssetInfoExport2	Obtains the data that appears in the Assets tab of a device in N-able N-central in a Key-Value pair format.
DeviceGet	Retrieves all of the data about a device or set of devices that are selected from the All Devices view.
DeviceGetStatus	Retrieves the status information of a device that is displayed in the Status tab of the device in N-able N-central.
DeviceList	Retrieves a list of the devices associated with a Customer or Site that is displayed in the All Devices view of N-able N-central.
DevicePropertyList	Used to list custom device properties for a list of devices.
DevicePropertyModify	Used to modify custom device properties for a list of devices.
JobStatusList	Retrieves the data that appears in the Job Status screen of N-able N-central.
LastExportReset	Used to reset the "high water mark" on the DeviceAssetInfoExport API and is generally called before calling the DeviceAssetInfoExport API if the third-party application is configured to include the last result set with the next call.
LicenseKeyPush	Copyright N-able.
MSPAHeartbeat	Copyright N-able.
MSPAHeartbeatCache	In memory object holding mspa heartbeat entries.
MSPAHeartbeatEvent
organizationPropertyList
organizationProperyModify
PsaCreateCustomTicket	Represents the Web Service implementation that creates Custom PSA tickets.
PSACredentialsValidate	Verifies whether a set of PSA credentials are valid.
PsaGetCustomTicket	Represents the Web Service implementation that gets Custom PSA ticket details.
PsaReopenCustomTicket	Represents the Web Service implementation that reopens Custom PSA tickets.
PsaResolveCustomTicket	Represents the Web Service implementation that resolves Custom PSA tickets.
RemoteControlMSPAStartEndTimeSubmit
SOAdd	Adds a new Service Organization to N-able N-central similar to how one is added through Add Service Organization.
TaskPauseMonitor	Called to pause the specific task.
TaskResumeMonitor	Called to resume the paused task.
UserAdd	Adds a new user to N-able N-central similar to using Add User.
UserRoleAdd	Adds a new role to N-able N-central similar to using Add User Role.
UserRoleGet	Retrieves all of the data about a user role.
UserRoleList	Retrieves a list of the user roles associated with a Customer or Site that is displayed in the User Role view of N-able N-central.
VersionInfoGet	Retrieves the system version information.