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 for a cluster or node

Updated on April 5, 2022

To help troubleshooting, download the system state data for the current state or a previously saved state into a JSON file. You can download the system state data for a single node or for the whole cluster. For example, you can compare the state of the system over time to determine what might have changed on the system that caused the problem.

Before you begin: To access the Cluster Management landing page and download the system state JSON file, you must have the PegaRULES:SysOpsObserver role.

Cluster specific data is saved once a day. Node-specific data is saved when a node starts up. Once downloaded, you can convert the JSON file to a readable format using a tool such as JSON Editor Online and compare two files using a tool such as JSON Diff.

To use a third-party tool to access the current system state, use a REST API. For more details, see Downloading the system state by using a REST API.

  1. In the navigation pane of Admin Studio, click SystemSystem & nodes.
  2. Click ActionsDownload system state.
  3. Specify whether to download the system state for the entire cluster, or only for one node.
    • Select System to download the system state for the entire cluster.
    • Select Node to download the system state for a particular node.
  4. If you selected Node, expand the node for which you want to download data.
  5. Click the month and date for which you want to download the system state.
  6. Click Download. The system state data JSON file is downloaded to your Downloads folder in the following format: SystemState_<node id or Cluster>_Timestamp.json.
  7. Click Close.

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