REST API support for Environment Variables, Credential Manager, Process Deployment & Monitoring

[Namrata_Katrale]

Hi all,

We're on Blue Prism v7.3.2 and are looking to build out some automation/tooling around our BP environment management. Wanted to check with the community on API support (REST API / other supported interfaces) for the following:

1. Environment Variables – Is there an API to create and update Environment Variables programmatically, rather than doing this manually via the interface?
2. Credential Manager – Similarly, is there an API to create/update Credentials (not just retrieve them at runtime, but manage them via automation)?
3. Process Release/Migration – Looking for a way to promote/release a Process (and objects) from one environment to another (e.g., Dev → Test → Prod) via API, ideally something that could plug into a CI/CD-style pipeline.
4. Process Execution Status – Is there an endpoint to query the real-time status of a running process instance — e.g., Completed, Terminated, Pending, Running?
5. Execution Logs – Is there a way to pull process execution logs (session logs) via API for a given run, rather than exporting manually from Control Room?

If anyone has worked with the BP REST API (or other interfaces) for these use cases on 7.3.2, would really appreciate pointers — endpoint names, auth setup gotchas, or any sample payloads/docs you can share. Also open to hearing if some of these are only possible via Database views / stored procs rather than REST.

Thanks in advance!

[Neel1 · Accepted solution]

Hello @Namrata_Katrale ,

I have tried to address your queries as best as I can. Please let me know if you need information on any specific endpoints, and I will do my best to share additional details. I have successfully tested and executed most of the API endpoints on version 7.3.1.

Please refer to the link below for the API documentation, which includes details on inputs, required permissions, and outputs for each endpoint.

 https://documentation.blueprism.com/bp-7-3/en-us/bp-api/bpe-7-3-0-api-spec.html

1.Yes, APIs are available for creating and updating Environment Variables (EVs).

2.No, there is currently no API available for managing Credentials. However, an idea has already been raised for this capability. Link - https://community.blueprism.com/t5/Product-Ideas/Add-option-to-manipulate-Credentials-via-Blue-Prism-API/idc-p/122466#M6835

3.Based on my understanding, there is no dedicated API available for migration of release.. To achieve migration, you would need to build a custom solution using AutomateC commands or other appropriate mechanisms.

4.Yes, process status can be retrieved through the Session API endpoints. Also You can execute processes be against a specific resource, and the relevant API endpoints are available for this purpose.

5.Yes, APIs are available for retrieving Session Logs. However, I believe there may be limits on the volume of session log data that can be exported through the API. I will verify this.