Trying out the Web SDK in an OpenAPI viewer

You can use an OpenAPI viewer to confirm your own application integration to Trust Protection Platform. You can also try the code samples from this guide. Trust Protection Platform supports the following viewers:

  • OpenAPI Explorer

  • Swagger

  • Redoc

Your system administrator selects whether this feature is enabled and which viewer is set by default in the Venafi Configuration Console. See Access Management for details.

IMPORTANT   By design, the OpenAPI viewer operates only from an installed instance of Trust Protection Platform. The framework does not run on the documentation portal ( Because REST API calls can change data, be sure to run OpenAPI viewer calls only from your test Trust Protection Platform instance.

You do not have to use the default viewer set by your administrator. For information on using the viewer of your choice, see Trying out the Web SDK in an OpenAPI viewer.


Applications that use Venafi REST APIs require an extra configuration. You can get the existing configuration from the API Integrations page. You need a valid Client ID as the client_id, and the corresponding scopes and restrictions. For more information, see Setting up token authentication.

Client ID is the Application ID

OpenAPI Viewer not available for this site

You are on, so the OpenAPI viewer is not available from this page. If you were viewing this page on a correctly-configured Venafi server you would see the OpenAPI viewer below.

Follow these steps to see the OpenAPI viewer on your Venafi server.

To try out the Web SDK in an OpenAPI viewer

Trust Protection Platform includes three OpenAPI viewers, two of which allow you to submit API requests: Swagger and OpenAPI Explorer. The method to get a bearer token and submit request is slightly different for each viewer. Select the one you are using below, and then follow the instructions.