This help page is for version 3.8. The latest available help is for version 8.1.

External API

PA Server Monitor has a simple API for basic operations.

Security

To protect the system from un-authorized requests, there are two security precautions that are required:

Requests are made via HTTPS. The format of the requests is:

HTTPS://{server}:{port}?API={command}&KEY={API Key}

Additional optional parameters can be appended to the URL using the pattern:

&{param_name}={value}

Return Values

All API commands return data as simple text. All successful commands return data as:

:START:
{returned data
can be multiple lines}
:END:

Errors are returned as:

:ERROR:{error text}

API Commands

Below are the supported commands. The command name should be insert where {command} is shown in the example above.

GET_SERVER_LIST

Returns a list of servers and the group that the server is in.

Optional Parameters
XML = {0|1} - defaults to 0

Example

https://server:81?API=GET_SERVER_LIST&KEY=msa8gbk4j78dbglaj

Output (server|group^group)

:START:
DNVISTA|Servers/Devices
192.168.2.5|Servers/Devices
POWERADMIN.COM|Servers/Devices^Boston
OPSMON02|Servers/Devices^Servers^Office
ARCHIVE|Servers/Devices
:END:

XML Example

https://server:81?API=GET_SERVER_LIST&KEY=msa8gbk4j78dbglaj&XML=1

XML Output

<?xml version="1.0" ?>
<servers>
  <server name="DNVISTA" group="Servers/Devices^Boston^Servers" />
  <server name="192.168.2.5" group="Servers/Devices^Kansas City" />
  <server name="POWERADMIN.COM" group="Servers/Devices^External" />
  <server name="OPSMON02" group="Servers/Devices^Boston^Servers" />
  <server name="ARCHIVE" group="Servers/Devices^Boston^Servers" />
</servers>

START_MAINTENANCE

Put the server into immediate maintenance mode.

Required Parameters
SERVER - name of the server that should be put into maintenance mode

MINUTES - time in minutes that the server should remain in maintenance mode before it automatically reverts to normal monitoring

Example

https://server:81?API=START_MAINTENANCE&KEY=msa8gbk4j78dbglaj &SERVER=MAILSRV&MINUTES=15

Output

:OK:

END_MAINTENANCE

Put the server back into normal monitoring mode.

Required Parameters
SERVER - name of the server that should be put into normal monitoring mode

Example

https://server:81?API=END_MAINTENANCE&KEY=msa8gbk4j78dbglaj&SERVER=MAILSRV

Output

:OK:

ADD_SERVER

Add and optionally configure the named server

Required Parameters
SERVER - name of the server that should be added. If the server already exists, it will be operated on (WIN, WMI and GROUP will not have an effect in that case).

Optional Parameters
WIN={0|1} - defaults to 0. Set to 1 if this is a Windows server.

WMI={0|1} - defaults to 0. Set to 1 if WMI polling should happen to collect System Details information for the server status report

CONFIG_PATH - defaults to none. Full path to a .cxml config file that specifies a configuration that should be applied to the new server. .cxml files are created by exporting a computer's configuration. The file must be on the same computer as PA Server Monitor is running on.

GROUP - defaults to none (which implies the top level group). The full path to the group that the server should be placed in, for example: Servers/Devices^Seattle^Exchange Servers (where the ^ delimits group names).

Example

https://server:81?API=ADD_SERVER&KEY=msa8gbk4j78dbglaj&SERVER=MAILSRV2&WIN=1 &WMI=1&CONFIG_PATH=C:\Configs\Mail+Config.cxml

Output

:OK:

DELETE_SERVER

Delete the named server, along with all of its monitors

Required Parameters
SERVER - name of the server that should be deleted

Example

https://server:81?API=DELETE_SERVER&KEY=msa8gbk4j78dbglaj&SERVER=MAILSRV2

Output

:OK:

GOTO_SERVER_REPORT

Pass a server name and get forwarded to that server's status report

Required Parameters
SERVER - name of the server

Example

https://server:81?API=GOTO_SERVER_REPORT&KEY=msa8gbk4j78dbglaj&SERVER=MAILSRV2

Output
Browser gets redirected to the given server's status report page

PA Server Monitor