Export an OpenAPI Spec

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

Export an OpenAPI Spec

Once the Cloud API on Azure is installed, you can export the OpenAPI documentation file from:

https://{ProtectFuncName}.azurewebsites.net/api/v1/openapi

Authentication and functions key are required to get the URL.

Note

For Cloud API on Azure Government Cloud use the following URL:

https://{ProtectFuncName}.azurewebsites.us/api/v1/openapi

Tip

Go to the Function App instance on the Azure portal, on the left menu choose Functions under Functions section, click on v1-openapi and press Get Function URL.

For testing the REST API, we recommend using a client tool, such as Postman.

Payload Encoding

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

Payload Encoding

The following encoding formats are supported in the REST API.

For every encoding, the resultant protected data is returned in the same encoding. For example, if request is hex-encoded, the response is also hex-encoded.

For more information about the encoding formats, refer to the Protection Methods Reference.

Encoding	Supported by data elements	Notes
utf8	All except binary data elements.	Default encoding if encoding is not specified. v1 Specification Mon, 01 Jan 0001 00:00:00 +0000 Request AWS Lambda service limits maximum size of payload to 6 MB. Client applications of Protegrity Cloud API must ensure their payload size is within this limit. This applies to all types of requests described below. Performs a policy operation such as protect, unprotect, or reprotect. URI `/v1/protect` or `/v1/unprotect` or `/v1/reprotect` Method POST Parameters data: Input data to the policy operation. data_element: Data element to use for the policy operation. Legacy Specification Mon, 01 Jan 0001 00:00:00 +0000 Protegrity has multiple products with REST API capabilities, such as Protection Server (out of support), DSG, and the latest product - IAP REST. Each one has its use case. To help you move to cloud-native implementation, Cloud Product REST API supports legacy payload. Request Response Request Performs a policy operation such as protect, unprotect, or reprotect. Method POST Parameters dataelementname: (protect/unprotect) Data element to use for the policy operation. externaliv: (protect/unprotect) Optional, external initialization vector. SSL Certificates Mon, 01 Jan 0001 00:00:00 +0000 SSL Certificates By default, the Azure function app function support HTTPS. To setup SSL Certificates in the Protect Function App please go to the following Azure documentation link: App Service, Configure SSL Certificate

Encoding

Supported by data elements

Notes

utf8

All except binary data elements.

Default encoding if encoding is not specified.

v1 Specification

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

Request

AWS Lambda service limits maximum size of payload to 6 MB. Client applications of Protegrity Cloud API must ensure their payload size is within this limit. This applies to all types of requests described below.

Performs a policy operation such as protect, unprotect, or reprotect.

URI

/v1/protect or /v1/unprotect or /v1/reprotect
Method

POST
Parameters

data: Input data to the policy operation.

data_element: Data element to use for the policy operation.

Legacy Specification

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

Protegrity has multiple products with REST API capabilities, such as Protection Server (out of support), DSG, and the latest product - IAP REST. Each one has its use case. To help you move to cloud-native implementation, Cloud Product REST API supports legacy payload.

Request

Performs a policy operation such as protect, unprotect, or reprotect.

Method

POST
Parameters

dataelementname: (protect/unprotect) Data element to use for the policy operation.

externaliv: (protect/unprotect) Optional, external initialization vector.

SSL Certificates

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

SSL Certificates

By default, the Azure function app function support HTTPS.

To setup SSL Certificates in the Protect Function App please go to the following Azure documentation link:

App Service, Configure SSL Certificate

REST API on

Export an OpenAPI Spec