Skip to main content

         This documentation site is for previous versions. Visit our new documentation site for current releases.      

This content has been archived and is no longer being updated.

Links may not function; however, this content may be relevant to outdated versions of the product.

Downloading the system state by using a REST API

Updated on April 5, 2022

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.
  1. 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.

  2. To check the system state for the specific node or the whole cluster, save or open the JSON file that was generated.
  • Previous topic Downloading the system state for a cluster or node
  • Next topic Verbose logging of garbage collection operations

Have a question? Get answers now.

Visit the Support Center to ask questions, engage in discussions, share ideas, and help others.

Did you find this content helpful?

Want to help us improve this content?

We'd prefer it if you saw us at our best. is not optimized for Internet Explorer. For the optimal experience, please use:

Close Deprecation Notice
Contact us