Dashboard API

Anonymous Authentication must be enabled for the WebApps site.

 

The AppSettings.json is where you set up the DashboardDB variable. It is where the API will look and get the Server Monitor/Dashboard events.

• Open the file at C:\Program Files (x86)\Upland AccuRoute\WebApps\root\ appsettings.json.

To modify the AppSettings.json, add an entry below “AppSettings” to specify the database connection string that the Server Monitor will write to. This is the same string configured in the Server Administrator > WebApps > Server Dashboard Application > Database tab.

Server Dashboard Application Properties example

AppSettings.json example

Add DashboardDB entry

Ensure there is a comma before the new “DashboardDB” entry you add to the AppSettings section or WebApps will not start up.

• Use double backslashes ( \\ ) in the Server attribute instead of a single backslash ( \ ), for example, ServerName\\sqlExpress.

Add ApiSettings Key

The ApiSettings key makes the API available only to those API requests that have the appropriate key appended to them. It is used to prevent unauthorized requests from using the API.

• Add an ApiSettings section if one is not available and add an entry to the “Keys” collection, for example, “OurKey”.

Note: The key value can be any value, but a globally unique identifier (guid) is recommended. This value is what is used in HTTP calls to the API as the “x-api-key” header. See REST API Call for more information.

• Restart IIS after these changes are complete.

 

Set up the following REST API call to WebApps as described below.

• GET http://servername/[webappssite]/api/dashboard/[machine]/[category]

The Header “x-api-key” must be included in the request with the appkey value you specified in the AppSettings.json file.

If WebApps is set up over https and/or on a different port, those changes must be reflected in the http call, for example, (https://servername:4234/[webappssite]....).

• [webappssite] is the WebApps name, for example, AccuRoute.

Note: [webappsite] defaults to AccuRoute unless specified otherwise during installation.

• [machine] is the machine name for the Dashboard events you want to get. This is case insensitive.

These names are the same ones configured in Server Monitor.

Server Monitor example

Note: You can use a wildcard character, for example, an asterisk ( * ) instead of a machine name to return events for all machines monitored.

• [category] is the category identifier for the events you want to retrieve. You can use an asterisk ( * ) instead of an id to return all events monitored.

Valid Category IDs

Each ID identifies an event a developer can choose to retrieve. Categories map to the event types that the Server Monitor generates. Each category returns data about a specific server activity. For example, a call made with an ID equal to 4 (Connectors), returns all data related to each connector configured on a server, including connector name, status and more.

Category	ID
Statistics	0
PrimaryServices	1
SecondaryServices	2
RemoteServices	3
Connectors	4
Queues	5
DiskSpace	6
ComposerPackages	7
SMTP	8
QueueFailures	9
RemoteFolder	10
OABackup	11
OAAlerts	12
FileScanFolders	13
EventLogMonitor	14
DateDeliverAfter	15
ConnectorManager	16
Telco	17
ActivityLog	18
ClusterFailover	19
PrintQueue	20
TelcoChannels	21

 

GET is used to retrieve a specific resource or all resources. The following examples show different types of GET requests with the use of category ids and/or the asterisk (*).

GET Connectors

A request to get all connector events from the server, for example, vmdvgzion2016 is specified as:

• http://webappserver/accuroute/api/dashboard/vmdvgzion2016/4

GET All Events

A request to get all events from the vmdvgzion2016 server is specified as:

• http://webappserver/accuroute/api/dashboard/vmdvgzion2016/*

GET Connector Events All Servers

A request to get all connector events from all servers is specified as:

• http://webappserver/accuroute/api/dashboard/*/4

GET All Events All Servers

A request to get all events from all servers is specified as:

• http://webappserver/accuroute/api/dashboard/*/*

 

HTTP status codes are used to indicate whether a HTTP request was successful or not.

Successful Response JSON example

The Successful Response JSON example and more is described in the table below.

Successful Response JSON Example Detail	Description
item	A Dashboard database row
machine	Monitored machine and event origin, for example, vmdvgzion2016
category	Event category, for example, 4 = Connectors, see the Valid Category IDs table for more ids.
item_text	Event description and category specific
status_text	Status label, for example, Enabled
status_code	Numeric status type reported, see status codes below. Success = 0 Failure = 1 Warning = 2 Critical = 3 Information = 4
date_last_updated	Event last updated date
date_expires	Event expiration date that can be updated with a new value
	A call that returns no data considered a successful response
	Failures in the 400 or 500 range: Client errors (400 – 499) Server errors (500 – 599)

Successful Call example

JSON Representation

Failed Call example

JSON Representation