OpenVPN API
CloudConnexa API User Guidance (beta)
Overview
The beta version of the CloudConnexa API is now available. Use it to develop a portal or application for the administration of your VPN networks, hosts,
The beta version of the CloudConnexa API is now available. Use it to develop a portal or application for the administration of your WPC Networks, Hosts, Users, and other core services.
Creating OAuth credentials
With the OAuth credentials that you create, you can authenticate to the API endpoint and use the CloudConnexa API.
From the CloudConnexa Administration portal, navigate to Settings > API.
Click Create Credentials.
Specify a name for your credentials.
Accept the default one-month lifetime value or specify a different one.OAuth credentials have an expiration period of two weeks, one month, six months, or one year.
Specify an optional whitelisted IP subnet range.
Click Create.
Important
Copy the credential key and paste it into a secure file. Also, copy the credential secret and paste it into a secure file.
Click the API link to return to the API main menu.
To enable the CloudConnexa API, click the toggle button.
API Connection
The API endpoint address is unique to your account, as shown below.
<yourOpenVPNID>.api.openvpn.com
Viewing JSON calls and responses
To access an overview of the core JSON calls and responses available in the CloudConnexa beta API, sign in to your CloudConnexa Owner / Administrator account and then navigate to the Swagger portal, use one of the following methods:
Use the direct link
https://<yourCloudConnexaID>.api.openvpn.com/docs/swagger-ui/Navigate to Settings, click the drop-down menu, and select API. Click the Swagger link.
Swagger opens in new tab.
Access Groups
An Access Group defines a specific access control configuration by specifying the access relationship between Sources (i.e. Who?) and Destinations (i.e. What?).
Connectors
A Connector is an unattended Device with a Connector application installed, which provides connectivity between CloudConnexa and your private Network or private application server.
DNS Records
A DNS “A” record is an address record in your DNS server that resolves an IPv4 address with a hostname/domain.
Devices
A Device is a computer, smartphone, or IoT-connected Device with an installed OpenVPN client used to connect to your WPC. Each User can have one or more associated Devices.
Hosts
A Host represents a server on your private Network running a Connector to provide connectivity to CloudConnexa.
Networks
A Network is an on-premises or IaaS-hosted range of private IP address subnets that provides access to business-owned resources, secure internet access, Internet Gateway, and more. Each Network requires at least one Connector for Site-to-Site or Point-to-Site WPC connectivity.
OAuth
OAuth is an open-standard authorization protocol that provides secure, designated access to applications using authorization tokens, which prove your identity to authenticate with the CloudConnexa API.
CloudConnexa uses OAuth 2.0.
Regions
A Region is a geographic point-of-presence hosted by CloudConnexa, which consists of a group of high-performance multi-tenant WPC servers. All CloudConnexa regions are interconnected in a Full-Mesh topology to form a high-bandwidth core Network.
Services
Services are defined as IP Services - access to specific address ranges and protocols.
Sessions
This API allows retrieval of WPC client session information, including OS type, version, and device UUID. You can find these connection sessions on the Status page in the Connections table.
Users
Generally, a User such as an employee, contractor, or other third-party person is authorized to access your WPC. It is possible to create many Users simultaneously.
User Groups
A User Group allows for the bulk administration of settings such as role- and department-based access controls, available WPC regions, internet access, types of authentication, and more.
