N-central Help

Web service APIs

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

  • connect to SolarWinds N-central
  • retrieve device asset information
  • perform actions

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

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

Available web service APIs

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

The table below list the available APIs.

Class Description
AccessGroupAdd Adds a new AccessGroup to SolarWinds 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 SolarWinds 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 SolarWinds N-central similar to how one is added using the Add Customers/Sites feature.
CustomerDelete Deletes existing customer in SolarWinds 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 SolarWinds N-central.
DeviceAssetInfoExport Obtains the data that appears in the Assets tab of a device in SolarWinds N-central.
DeviceAssetInfoExport2 Obtains the data that appears in the Assets tab of a device in SolarWinds 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 SolarWinds N-central.
DeviceList Retrieves a list of the devices associated with a Customer or Site that is displayed in the All Devices view of SolarWinds 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 SolarWinds 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 SolarWinds MSP.
MSPAHeartbeat Copyright SolarWinds MSP.
MSPAHeartbeatCache In memory object holding mspa heartbeat entries.
MSPAHeartbeatEvent  
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 SolarWinds 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 SolarWinds N-central similar to using Add User.
UserRoleAdd Adds a new role to SolarWinds 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 SolarWinds N-central.
VersionInfoGet Retrieves the system version information.