This help page is for version 3.7. The latest available help is for version 9.4.
PA File Sight has a simple API for basic operations.
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:
Additional optional parameters can be appended to the URL using the pattern:
All API commands return data as simple text. All successful commands return data as:
Errors are returned as:
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 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 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 Example https://server:81?API=END_MAINTENANCE&KEY=msa8gbk4j78dbglaj&SERVER=MAILSRV
Output :OK:
|
ADD_SERVER |
Add and optionally configure the named server Required Parameters Optional Parameters 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 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 Example https://server:81?API=GOTO_SERVER_REPORT&KEY=msa8gbk4j78dbglaj&SERVER=MAILSRV2
Output |