Viewing Swagger API Documentation
You can explore and test CloudConnexa API endpoints using the Swagger interface. Swagger provides an interactive view of available endpoints, request formats, and responses.
Access the Swagger UI
To open the Swagger documentation, use one of the following methods:
Option 1: Direct link
Go to
https://<company_name>.api.openvpn.com/docs/swagger-ui/.
Option 2: From the Administration portal
Sign in to your WPC's Administration portal by entering your Cloud ID in a web browser (for example,
company_name.openvpn.com).Navigate to API & Logs → API.
Click Swagger.
The Swagger UI opens in a new browser tab.
Use the Swagger interface
In Swagger, you can:
Browse available API endpoints.
View request parameters and response schemas.
Test API calls directly from the browser.
The currently active API version is shown by default. To view other available versions, use the Select a definition drop-down.
Before testing API requests
To successfully test API calls in Swagger, you need to authenticate using an access token.