Protegrity REST APIs on

Accessing the Protegrity REST APIs

Mon, 01 Jan 0001 00:00:00 +0000

The following section lists the requirements for accessing the Protegrity REST APIs.

Available endpoints - Protegrity has enabled the following endpoints to access the REST APIs.

Base URL

https://{ESA IP address or Hostname}/pty/<Version>/<API>

Where:
- ESA IP address or Hostname: Specifies the IP address or Hostname of the ESA.
- Version: Specifies the version of the API.
- API: Endpoint of the REST API.
Authentication - You can access the REST APIs using basic authentication, client certificates, or tokens. The authentication depends on the type of REST API that you are using. For more information about accessing the REST APIs using these authentication mechanisms, refer to the section Accessing REST API Resources.

View the Protegrity REST API Specification Document

Mon, 01 Jan 0001 00:00:00 +0000

The steps mentioned in this section contains the usage of Docker containers and services to download and launch the images for Swagger Editor within a Docker container.

For more information about Docker, refer to the Docker documentation.

The following example uses Swagger Editor to view the REST API specification document. In this example, JSON Web Token (JWT) is used to authenticate the REST API.

Install and start the Swagger Editor.

Using the Common REST API Endpoints

Mon, 01 Jan 0001 00:00:00 +0000

The following section specifies the common operations that are applicable to all the Protegrity REST APIs.

The Base URL for each API will change depending on the version of the API being used. The following table specifies the version that you must use when executing the common operations for each API.

REST API	Version in the Base URL <Version>
Policy Management	v2
Encrypted Resilient Package	v1
Authentication and Token Management	v1

Common REST API Endpoints

The following table lists the common operations for the Protegrity REST APIs.

Using the Policy Management REST APIs

Mon, 01 Jan 0001 00:00:00 +0000

The user accessing these APIs must have the Security Officer permission for write access and the Security Viewer permission for read-only access.
For more information about the roles and permissions required, refer to the section Managing Roles.

The Policy Management API uses the v2 version.

If you want to perform common operations using the Policy Management REST API, then refer the section Using the Common REST API Endpoints.

The following table provides section references that explain usage of some of the Policy Management REST APIs. It includes an example workflow to work with the Policy Management functions. If you want to view all the Policy Management APIs, then use the /doc API to retrieve the API specification.

Using the Encrypted Resilient Package REST APIs

Mon, 01 Jan 0001 00:00:00 +0000

The Encrypted Resilient Package API is only used by the Immutable Resilient protectors.

Before you begin:

Ensure that the concept of resilient protectors and necessity of a resilient package is understood.
For more information on how the REST API is used to export the encrypted resilient package in an immutable policy deployment, refer to the section DevOps Approach for Application Protector.
Ensure that the RPS service is running on the ESA.

Using the Authentication and Token Management REST APIs

Mon, 01 Jan 0001 00:00:00 +0000

The Authentication and Token Management API uses the v2 version.

If you want to perform common operations using the Authentication and Token REST API, then refer the section Using the Common REST API Endpoints.

The following table provides section references that explain usage of some of the Authentication and Token REST APIs. It includes sample examples to work with the Authentication and Token functions. If you want to view all the Authentication and Token APIs, then use the /doc API to retrieve the API specification.