To download the current system state for a single node or for the whole cluster for use
by a third-party tool, use a REST API. REST APIs are a standard way to access the resource
status and can be used by third-party tools that support calling the API.
Before you begin: To invoke a REST API for downloading the system state,
authenticate as a user with the PegaRULES:SysOpsObserver role.
-
In the address bar of a third-party tool that supports calling this API, enter the
following URL: http:// hostname:port /api/v1/nodes/
{nodeIdentifier} /state
For variables, enter the following details:
-
hostname:port is the host name and the port for the Pega Platform application server to which you want to connect.
-
{nodeIdentifier} is the ID of the node for which you want to
download the system state. If you enter all, you download the
system state for the whole cluster.
-
To check the system state for the specific node or the whole cluster, save or open the
JSON file that was generated.