API access | EPM-L

You can use the Endpoint Privilege Management for Linux (EPM-L) API to automate tasks and pull data into your own scripts and tools. To call the API, you need a personal access token and the site ID of your tenant.

Prerequisites

• You have an account on the BeyondTrust Pathfinder Platform with access to EPM-L.
• You have a terminal with a Bash-compatible shell and curl installed.

Call the EPM-L API

1. Create a personal access token. For instructions, see Create a personal access token.

2. Copy the token and store it in a safe place.

   Treat your token like a password. Anyone who has it can call the API as you.

3. While signed in to the BeyondTrust Platform, open a new browser tab and go to https://app.beyondtrust.io/api/platform/currentSite.

   The browser displays a JSON response with details about your site.

4. Find the siteId value in the response, and then copy it.

5. Open a terminal.

6. Set the API base URL. Replace <siteId> with the value you copied in step 4:

   Bash

   export EPML_URL="https://api.beyondtrust.io/site/<siteId>/epm/linux"

7. Set your personal access token. Replace <personal access token> with the token you created in step 1:

   Bash

   export EPML_PAT="<personal access token>"

8. Send a test request to the API:

   Bash

   curl -s -H "Authorization: Bearer $EPML_PAT" \
     -H "Accept: application/json" \
     "$EPML_URL/epml/clientpkg"

   If the request succeeds, the API returns a JSON response with client package details. If you receive an authorization error, check that your token is correct and has not expired. If you receive a not found error, check the site ID in your URL.