Calling Deployment Manager APIs from a REST client

Calling Deployment Manager APIs from a REST client

Description	Invoking Deployment Manager APIs
Version as of	8.5
Application	Pega Platform
Capability/Industry Area	DevOps

Deployment Manager offers a feature set of APIs for querying data and performing actions within the system. See below for more information on invoking these APIs from a REST client.

Use case examples

There are numerous ways to interact with the API set to enhance your experience with Deployment Manager. For example, you can use these APIs to:

• Debug connection issues
• Get a list of all pipelines
• Create / clone a pipeline
• Get a list of all deployments
• Start a deployment
• Progress a task programmatically
• Fix tasks which are in a bad state
• Bulk process tasks

Before you begin

Before getting started, you need the client ID and secret that Deployment Manager generates when setting up the instance. This example uses Postman as a REST client, but any REST client application can be used to achieve the same result.

Process/Steps to achieve objective

Use the API to retrieve a list of available pipelines:

1. Download the latest version of Postman.
2. Start Postman -> Create a new request in scratch pad.
3. Ensure the REST method is set to GET.
4. Enter the request URL as: https://<server>:<port>/prweb/PRRestService/DeploymentManager/v1/pipelines.
5. On the authentication tab, select OAuth 2.0 authorization.
6. Configure new token:
   1. In the Token Name field, enter a name for your token.
   2. In the Grant Type field, select your client credentials.
   3. In the Access Token URL field, enter https://<server>:<port>/prweb/PRRestService/oauth2/v1/token.
   4. In the Client ID field, enter the client ID provided by Deployment Manager when setting up the instance. This is included in the client secret file.
   5. In the Client Secret field, enter the client secret provided by Deployment Manager when setting up the instance. This is included in the client secret file.
   6. Click on Get New Access Token to fetch the token from DevOps server.
   7. Click Use token.
7. See the image below for a sample configuration.
   

   Postman request configuration for the pipelines API, including authentication parameters.
8. Click Send to see the response.
   

   Example response for the Pipelines API in Postman.

Results

You now have the ability to perform actions against a Deployment Manager system through the associated REST APIs. Ensure you review the documentation included in the Deployment Manager distribution on Pega Marketplace for a full overview of supported APIs.

An application that provides a low-code, model-driven experience to configure and run continuous integration and delivery (CI/CD) workflows for your application.

A business solution that automates workflows in your organization. Multiple, unrelated applications can be hosted in the same system. You create an application by running the New Application wizard.

A set of practices that bridge application development and operational behavior to reduce time to market and create a standardized deployment process so that you can deploy predictable, high-quality releases.

A capability that you implement in your application. By defining features that are linked to rules and work items, you can improve the traceability of capabilities to their respective implementations.

(Deprecated) A configuration of panels (areas) in a harness that support a composite portal. Existing panel sets continue to function. As a best practice, upgrade panel sets to screen layouts.

A durable, potentially permanent, saved representation of a concrete class that is stored in the database. An instance corresponds to a row in the relational database, or to a record. An instance consists of properties and values, and some of these property values form a unique key to the instance.

A Pega Platform method, distinct from a Java method. An operation that can be performed by one step of an activity ( Rule-Obj-Activity rule type), or by a Parse Structured rule ( Rule-Parse-Structured rule type).

Parameters that authenticate users or external processes that need to access applications, enabling users to log in with appropriate security permissions. Credentials typically consist of a user name and password. The user name is the key to an operator ID instance. The password can be stored in that instance (in encrypted form), or in a corporate directory service, such as the one provided by Microsoft Active Directory.