Discussion
Pegasystems Inc.
US
Last activity: 3 Jun 2024 5:56 EDT
What can I do with the Deployment Manager REST API?
Deployment Manager provides a REST API to help automate common actions and integrate with other systems. These actions include:
- Create pipelines
- View pipelines
- Create merge requests
- View merge requests
- Start deployments
- View deployments
- Abort deployments
- Approve manual requests
In Deployment Manager 4.5 and later API documentation is included in the archive downloaded from the Pega Marketplace. You can view the Documentation/readme-for-swagger.md file for more information on using the API.
We have plans to expose all deployment manager data and actions via APIs in a future release.
Tips for using the service APIs
- When creating pipelines using the POST /pipelines/ endpoint, it's helpful to copy an existing pipeline fetched from the GET /pipelines/{id} endpoint and making any necessary changes to the response JSON. Until pipeline templates are officially supported, this is a good way to get similar functionality.
This is a frequently asked question about Deployment Manager. Find more answers here.
Pegasystems Inc.
FR
Hi,
I'm trying to find how to start deployments with that API. Can you help me by telling me which REST web service i should use for that?
Regards,
Marius
Pegasystems Inc.
IN
Hi Marius,
As the post above points out refer to the swagger documentation for the REST API's exposed by deployment manager. For starting deployments you could use: POST method on /pipelines/{pipelineid}/builds , the parameters needed are documented in the swagger doc corresponding to the version of deployment manager you are using.
Regards,
Anil
Cognizant
US
@konda I am trying to create a pipeline using DM API details provided in the Swagger but couldn't able to create one. I am getting response with 400 code and "errors":[{"errorText":"","errorId":""}]} . Could you please help me with request body that I can use for creating a pipeline tailoring to my application needs. I have tried exact replica of request body given in swagger file but no luck.
Pegasystems Inc.
IN
@TMN Murty Kamisetti As mentioned above, you should try doing a GET request against an existing pipeline and then update it as needed before issuing a POST call to create a new pipeline. Also please check the logs to find additional details on the error you are running into.
When creating pipelines using the POST /pipelines/ endpoint, it's helpful to copy an existing pipeline fetched from the GET /pipelines/{id} endpoint and making any necessary changes to the response JSON.
BPM Company
NL
Is it possible to Skip Aged Updates (or Override, doesn't matter) via API? and how
BPM Company
NL
@vaspoz if someone is interested, I found the solution:
you have to send PUT request for /tasks/{id} with body:
{
"intermediateInput": "SKIPAGEDUPDATES",
"isNotificationRequired": "true",
"pxObjClass": "PegaDevOps-Int-Task",
"taskStatus": "Open-Ready"
}