REST API

Reference for Cloud API authorization and specification

The following sections describe the key concepts in understanding the REST API.

Base URL:

https://{ApiGatewayId}.execute-api.{Region}.amazonaws.com/pty/v1

Once Protegrity Serverless REST API is installed, you can export the OpenAPI documentation file from API Gateway Export API, located in the AWS API Gateway Control Service.

https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-export-api.html

For testing the REST API, we recommend using tools, such as, Postman.


Authorization

Describes the available authorization methods

HTTP Status Codes

Describes the Status Codes returned by Cloud API

Payload Encoding

Describes the request/response payload encoding

TLS Mutual Authentication

Describes the TLS Mutual Authentication setup for AWS API Gateway

v1 Specification

Describes the v1 REST API specification

Legacy Specification

Describes the Legacy REST API specification


Last modified : November 27, 2025