CloudConnexa: How to Create Networks using the CloudConnexa API via Swagger

Description: This guide provides step-by-step instructions for creating a network in CloudConnexa using the public API through Swagger.

Step 1: Create API credentials

1. Sign in to your CloudConnexa Portal.
2. Click API & Logs > API.
3. Click Create Credentials.
4. Enter the details for your new credentials and click Create.
   
5. Once the credentials are created, copy the Public API Client ID and Public API Client Secret, which you'll use as your authorization credentials using Swagger.
   
6. Return to the CloudConnexa API UI and turn on Enable API for this Cloud ID to ensure active API access.
   

Step 2: Authorize in Swagger

1. From the CloudConnexa API UI, click Swagger.
   
2. Click Authorize.
3. Paste your Public API Client ID and Public API Client Secret, and click Authorize.
   
   • The Available authorizations notification displays, and you can click Close.

Step 3: Create a network

1. In Swagger, click to expand POST /api/v1/networks.
2. Click Try it out.
   
3. In the Request body, define your network. Here's an example:
   

   {
    "name": "On Prem Site A",
    "description": "VMware in Site A",
    "internetAccess": "SPLIT_TUNNEL_ON",
    "egress": true,
    "routes": [
      {
        "type": "IP_V4",
        "value": "10.10.100.0/24",
        "description": "LAN of Site A"
      }
    ],
    "connectors": [
      {
        "name": "connector01",
        "description": "Connector with VM name linux001",
        "vpnRegionId": "ap-southeast-1",
        "tunnelingProtocol": "OPENVPN"
      }
    ]
   }

4. Click Execute to submit the request.
   

Step 4: Verify the network in your CloudConnexa portal

1. Sign in to your CloudConnexa Portal.
2. Click Networks > Networks.
3. Select your newly created network and check the following:
   • IP Services > Routes to view the defined route.
   • Connectors to verify the connector settings.

If you need additional help, please submit a support ticket.