Admin REST Service

Once admin REST services are enabled and properly configured they can be accessed as shown below.

The admin REST service supports many of the methods in the Administration API - and the REST methods and arguments are the same.

A more detailed description of each of the methods can also be find on the link above, as this REST service simply passes through the calls to the Administration API.

The supported methods are listed below.

http://server:port/restservices/admin/jvmdump
No parameters
Description	Creates a JVM dump
Example URLS	http://localhost:5300/restservices/admin/jvmdump
Output example	"-------------------- JVM Dump for statisticsserver1@localhost:58213@configclient_statisticsserver -------------------- -------------- Full JVM Dump: Runtime Information: -------------------- VN name: Java HotSpot(TM) 64-Bit Server VM, Vendor: Oracle Corporation, Version: 25.131-b11 JVM Started at: Mon, 26-Jun-17 16:41:45 CEST Uptime: 24 seconds, 290 msecs\nOS Name: Windows 10, version: 10.0 CPUs: 8\nArchitecture: amd64 Boot classpath: C:\\PortalProtect\\pp\\alpn\\alpn-boot-8.1.11.v20170118.jar;D:\\java\\jdk1.8.0_131\\jre\\lib\\resources.jar;D:\\java\\jdk1.8.0_131\\jre\\lib\\rt.jar;D:\\java\\jdk1.8.0_131\\jre\\lib\\sunrsasign.jar;D:\\java\\jdk1.8.0_131\\jre\\lib\\jsse.jar;D:\\java\\jdk1.8.0_131\\jre\\lib\\jce.jar;D:\\java\\jdk1.8.0_131\\jre\\lib\\charsets.jar;D:\\java\\jdk1.8.0_131\\jre\\lib\\jfr.jar;D:\\java\\jdk1.8.0_131\\jre\\classes\nClasspath: C:\\PortalProtect\\classes; .... and the dump continues

http://server:port/restservices/admin/shutdown
No optional parameters
Description	Shuts down the server!
Example URLS	http://localhost:5300/restservices/admin/shutdown
Output example	"Shutting down server!"

http://server:port/restservices/admin/reloadconfiguration
No optional parameters
Description	Tells the config server to reload all configuration
Example URLS	http://localhost:5300/restservices/admin/reloadconfiguration
Output example	"Reloading all configuration"

http://server:port/restservices/admin/listServices
No optional parameters
Description	Lists all services known to the config server with connection and status information
Example URLS	http://localhost:5300/restservices/admin/listServices
Output example	[ { "name": "axis", "status": { "running": false, "connecting": false, "notConnected": true, "disconnecting": false, "disconnected": true, "connected": false, "starting": false, "stopping": false, "shuttingDown": false, "shutDown": false, "stopped": true }, "pingTime": -1, "alias": null, "routeNodeName": null, "type": null, "memoryFree": 0, "memoryTotal": 0, "memoryUsed": 0, "memoryMax": 0, "cpuProcess": -1, "cpuSystem": -1, "pingtime": -1 }, { "name": "configserver1", "status": { "running": true, "connecting": false, "notConnected": true, "disconnecting": false, "disconnected": true, "connected": false, "starting": false, "stopping": false, "shuttingDown": false, "shutDown": false, "stopped": false }, "pingTime": 0, "alias": "", "routeNodeName": "configserver1@127.0.0.1", "type": null, "memoryFree": 695644, "memoryTotal": 974336, "memoryUsed": 278692, "memoryMax": 974336, "cpuProcess": 0.0012769606407561649, "cpuSystem": 0.09321413231377008, "pingtime": 0 }, ....... More services listed here ]

http://server:port/restservices/admin/startserver?server=xx http://server:port/restservices/admin/stopserver?server=xx
Required parameter is a server.
Description	starts or stops a server with a given name
Example URLS	http://localhost:5300/restservices/admin/startserver?server=useradmin1
Output example	"Starting server useradmin1"