You can call any of the Pega API services by using standard HTTP methods (for example: GET, POST, or PUT). For detailed information about request and response data requirements, see the Pega API resources page in Dev Studio or Admin Studio. This documentation is also available in JSON format in the Docs API (GET/docs).
The following Pega API services are included with Pega Platform.
- Application APIs :
- Cases API – Get a list of cases for a user, create a case, get case details, and update a specific case.
- Casetypes API – Get a list of case types for the authenticated user.
- Data API – Get the contents and metadata for a specific data page.
For information about Pega APIs that help you manage cases and assignments, see the Pega Digital Experience (DX) API landing page.
- DevOps APIs:
- Applications APIs – Get a list of applications, get application details, get quality and guardrail metric details, start and stop application test coverage, get Pega unit statistics (execution summary and test compliance) for the entire application or for a set of given rules.
- Branches API – Get branch conflicts, merge branches, get and create branch reviews, and get the summary for a branch.
- Merges API – Get the merge status.
- System management APIs:
- Nodes API – Start and cancel quiescence (immediate drain or slow drain)
on any node in the cluster, list the current configuration settings for
a node or the whole cluster, download the
prconfig.xmlfile, and list the nodes that are in the cluster.
- Caches API – Manage various caches in Pega Platform, for example, manage the in-memory VTable cache for a specific rule class and instance name; clean the cache; repopulate the cache; and get cache statistics for the authenticated user.
- Agents API – Fetch the agent list, get agent details, and start, stop, and restart agents.
- Job schedulers API – Fetch the job scheduler list, and start and stop job schedules.
- Pools API – Manage requestor pools, for example, clear a requestor pool or list all requestor pools on the specific node.
- Queue processors API – Get all queue processors, and to start and stop queue processors.
- Reports API – Get the module version, conclusion cache, log usage, MRU, property reference, database, properties, and tables reports.
- Requestors API – Get the requestor list, get requestor details, and stop and interrupt requestors.
- Loggers API – Get log categories, reset log categories, fetch logger details, and set the log level for a category.
Note: For information about the privileges required for system management APIs, see Pega API system management privileges.
- Nodes API – Start and cancel quiescence (immediate drain or slow drain) on any node in the cluster, list the current configuration settings for a node or the whole cluster, download the
- User management APIs:
- Authenticate API – Verify user credentials.
- One-time password (OTP) API – Verify an OTP and generate and send an OTP to a user.
- User API – Terminate and disable user sessions, and enable disabled users.
- Data privacy APIs:
- Client requests API – Create client requests for access, rectify, and erase.
- Data privacy metadata API – Get field names for identifying clients.
- Client usage restrictions API – Update client usage restrictions.
- The Docs API provides the complete documentation for the Pega API.
- Pega API system management privileges
Each API in the System Management API has a specific privilege that you can add to a role to use that API. These privileges are useful when you only want a role to have access to specific APIs.
- Securing the Pega API
To ensure the safety of Pega API credentials that are transferred through HTTP basic authentication, use TLS 1.2, a strong transport layer security, when installing your Pega application. You can also secure the Pega API by using OAuth 2.0.
- Pega API best practices
When developing mobile and client applications that are powered by any Pega API, use the following best practices to ensure the best end-user experience.
- Data API performance and limitations
You use data APIs to retrieve the contents and metadata of specific data pages. You can sort, filter, and group data that you request from Pega Platform to specify how you want your data to be organized in the response. To ensure the high performance of your data APIs, review the following guidelines.
- Pega API example use cases
The following examples show some ways that you can use the Pega API in your application. You use multiple Pega API services as part of a single process or as part of multiple business application processes. For example, client applications can call a Pega API service to get a list of available cases, data, or assignments, and then make subsequent API calls to get further details or to make updates.