---
title: Viewing Swagger API Documentation
canonical: https://openvpn.net/cloud-docs/developer/viewing-swagger-api-documentation/
product: CloudConnexa Docs
description: View and test CloudConnexa API endpoints in Swagger UI, including request formats, responses, and available API versions.
---

# 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

1. Go to `https://<company_name>.api.openvpn.com/docs/swagger-ui/`.

### Option 2: From the Administration portal

1. Sign in to the CloudConnexa Administration Portal using your WPC's **Cloud ID** address (for example, `yourcompany.openvpn.com`).
2. Navigate to **API & Logs → API**.
3. 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.

- [Creating API credentials](https://openvpn.net/cloud-docs/developer/creating-api-credentials.md)

---

Prev: [API Endpoint](https://openvpn.net/cloud-docs/developer/api-endpoint.md)
Next: [Migration guide from Beta to API v1.0](https://openvpn.net/cloud-docs/developer/migration-guide-from-beta-to-api-v1-0.md)
Index: https://openvpn.net/cloud-docs/llms.txt