Documentation Center

status

Returns details of the system and application status.

Description

The System Status function returns detailed information about the system and application. This includes details about the version of the application, operating system and third-party components. It also provides information about the Java Virtual Machine memory consumption.

Parameters

action
status
format
The output format for the results. Either "html" or "xml". Defaults to "html"

Example URL

http://<host>:<port>/<context>/web/admin.xql?action=status&format=<value>

Successful Result

Returns an HTML or XML document expressing system status, application, database, Java and operating system versions.

Failed Result

Accessing this API feature requires the "Manage application" permission, and the function will throw a permission exception if the permission is not available.