Pega API

You can use the Pega API to power client and mobile apps by using built-in Pega REST services. It includes case, assignment, and data APIs that let you extend your Pega Platform applications. The APIs are secured by user credentials and TLS/SSL.

You can access the Pega API by clicking Resources > Pega API. In the API, you can perform the following actions:

  • List parameters
  • View the JSON data model for each resource
  • Test an API by clicking Try it out! to view the actual request URL, response body, response code, and response headers

The Pega API provides the following resources.

Application

Assignments

  • Get assignments or get next assignments.
  • Get details of a known assignment or the next assignment that is most urgent.
  • Perform assignment actions.

Authenticate

  • Verify user credentials.

Cases

  • Get cases.
  • Create a case.
  • Get case details.
  • Update a case.

Case types

  • Get case types.

Data

  • Get data page contents.
  • Get data page metadata.

DevOps

Applications

  • Get applications.
  • Get application details.
  • Get application quality metric details.
  • Get application guardrail metric details.

Branches

  • Get branch conflicts.
  • Merge a branch.
  • Get reviews for a branch.
  • Create a branch review.
  • Get a summary for a branch.

Merges

  • Get merge status.

System Management

Nodes

  • Place a node into a quiescent state.
  • Take a node out of a quiescent state.
  • Get the current configuration settings for a specific node or for the whole cluster.
  • Download the prconfig.xml file for a specific node.
  • Get a list of all the nodes (node IDs) in the cluster.

Caches

  • Get a summary for a rule in the VTable cache.
  • Reload rule in the VTable cache.
  • Reassemble a rule in the VTable cache.
  • Clear the ABA, conclusion, declarative page, declarative rules, or rule cache on a specific node or all nodes in the cluster.
  • Get a cache summary for a specific node for the conclusion, declarative page, declarative rules, or rule cache.
  • Clear a conclusion cache type.
  • Get all node pages or page definitions in the declarative page cache.
  • Get details of a node page or page definition in the declarative page cache.
  • Clear a node page from the declarative page cache.
  • Get ruleset list hash associations of the declarative page cache.
  • Get declarative rules for a rule key in the declarative rule cache.
  • Get all unique rulesets in the declarative rule cache.
  • Get declarative ruleset list/class cache details in the declarative rule cache.
  • Delete an instance from the rule cache.
  • Get rule cache details of a rule type.
  • Get a list of cached instances of a rule type in the rule cache.

Pools

  • Clear all requestor pools on a specific node.
  • Get a list of all requestor pools on a specific node.
  • Clear a requestor pool on a specific node.

Users

  • Terminate all existing sessions on all nodes in the cluster for the specified set of users.

Docs

  • Get the complete documentation for the Pega API.