Policy Editor API | EPM-WM Cloud

What is the Policy Editor API?

The Policy Editor API provides actions to read, create, and delete Windows application definitions without using the EPM Cloud or Pathfinder user interface.

Only Windows app types are supported, and include .bat, .cpl, .exe, .msc, .msi, .ps1, .reg, .rpsc, .rpss, .unex, .wsh

ℹ️

The Policy Editor API will be available for macOS endpoints in a future release.

How is it useful?

The Policy Editor API streamlines and simplifies the process of editing policies in environments implementing extensive, comprehensive policies requiring frequent editing.

How do I access the API?

The Policy Editor API is packaged with the EPM Management API. You can access the Swagger docs through your EPM site.

Replace example with the name of your EPM instance in the following URL:

https://<example>-services.pm.beyondtrustcloud.com/management-api/swagger

In Swagger, be sure to select v3 from the Select a definition menu.

Requirements

• An API account in EPM to authenticate to the API.
• EPM Classic or Pathfinder implementations.

Create an API account

To use the Policy Editor API, you must first create an API account.

To create the account:

1. Click the Configuration menu, and then click API Settings.

2. Click Create an API Account.

3. Enter a name and description.

   The Client ID and Client Secret are automatically generated. The secret is only visible when initially generated for security reasons.

   You can use the copy icons to copy the values to the API tool you are using. You can access these after the account is created as well.

4. Set the permissions for the account. Permissions required for Policy Editor API:

   • Management: Select Full Access.
   • Policy Editor: Select Full Access.
     Selecting Full Access grants all HTTP permissions.
   

5. Click Save API Account.

Auditing

See policy revisions on the Auditing page. Filter on Changed By and select API.